@farthershore/client 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.
- package/CHANGELOG.md +7 -2
- package/LICENSE +21 -0
- package/README.md +1 -1
- package/dist/index.js +212 -2
- package/dist/types/api.generated.d.ts +62 -0
- package/dist/types/generated/schemas.d.ts +55 -4
- package/dist/types/operations/audit-notifications.d.ts +4 -0
- package/dist/types/operations/auth.d.ts +175 -0
- package/dist/types/operations/businesses.d.ts +90 -0
- package/dist/types/operations/consumers.d.ts +108 -0
- package/dist/types/operations/index.d.ts +392 -0
- package/dist/types/operations/organizations.d.ts +7 -0
- package/dist/types/types.d.ts +8 -0
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,16 @@
|
|
|
1
1
|
# Changelog — @farthershore/client
|
|
2
2
|
|
|
3
|
+
## [0.7.0] - 2026-11-20
|
|
4
|
+
|
|
5
|
+
- Add `organizations.sellerDetails.read`: the seller details (legal name, support email, postal address and optional support URL) every business in the organization shows its customers, read from the organization's Stripe account, and where they stand (`not_connected`, `incomplete` or `complete`).
|
|
6
|
+
- Add `personalData.export` to download your own personal data as JSON, and `account.erasure.read` to follow your account deletion through to completion. Deleting the account itself stays a dashboard action.
|
|
7
|
+
- Add `consumers.data.export` to export one customer's data for a business as JSON, and `consumers.data.erasure.read` to read the status of that customer's data erasure.
|
|
8
|
+
- Add `platform.legal.read` to read whether the platform's current legal documents have been accepted.
|
|
9
|
+
|
|
3
10
|
## [0.6.0] - 2026-11-18
|
|
4
11
|
|
|
5
12
|
- Use `/agent/v1/whoami` for credential validation; the retired `/management/whoami` endpoint is no longer supported.
|
|
6
13
|
|
|
7
|
-
## [Unreleased]
|
|
8
|
-
|
|
9
14
|
- **Breaking:** Removed `businesses.rollback`; the retired publish workflow cannot produce a valid rollback target. Recover a Business contract through a reviewed repository fix and a new release.
|
|
10
15
|
|
|
11
16
|
- Stop frontend build waits on supersession and keep the awaited build identity fixed, including when it is missing from a status response.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Farther Shore
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ namespaced, typed operation surface (`fs.runtimeTokens.revoke(…)`) over an
|
|
|
5
5
|
authenticated `fetch` transport with exact retry and outcome semantics,
|
|
6
6
|
pluggable credential sources, and typed errors.
|
|
7
7
|
|
|
8
|
-
> **Status: `0.
|
|
8
|
+
> **Status: `0.7.0`.** Pre-1.0: minor releases may include breaking changes.
|
|
9
9
|
> Every response is typed. Responses are generated
|
|
10
10
|
> from the platform's zod schemas (through the API's OpenAPI components), so a
|
|
11
11
|
> field exists in a type exactly when the server sends it.
|
package/dist/index.js
CHANGED
|
@@ -159,9 +159,10 @@ var PLATFORM_PERMISSION_CATALOG = {
|
|
|
159
159
|
defaultRoles: OWNER_ADMIN,
|
|
160
160
|
delegation: "maker_token"
|
|
161
161
|
}),
|
|
162
|
+
// Business presentation and the organization's seller details.
|
|
162
163
|
"brand:update": permission("brand:update", {
|
|
163
164
|
effect: "write",
|
|
164
|
-
allowedTargetKinds:
|
|
165
|
+
allowedTargetKinds: BUSINESS_OR_ORGANIZATION,
|
|
165
166
|
defaultRoles: OWNER_ADMIN,
|
|
166
167
|
delegation: "maker_token"
|
|
167
168
|
}),
|
|
@@ -183,6 +184,43 @@ var PLATFORM_PERMISSION_CATALOG = {
|
|
|
183
184
|
defaultRoles: OWNER_ADMIN,
|
|
184
185
|
delegation: "maker_token"
|
|
185
186
|
}),
|
|
187
|
+
"account_erasure:request": permission("account_erasure:request", {
|
|
188
|
+
selfService: true,
|
|
189
|
+
effect: "write",
|
|
190
|
+
allowedTargetKinds: SELF,
|
|
191
|
+
defaultRoles: BUILDER_ROLES_AND_SUBSCRIBER,
|
|
192
|
+
humanOnly: true,
|
|
193
|
+
delegation: "browser_only"
|
|
194
|
+
}),
|
|
195
|
+
"account_erasure:read": permission("account_erasure:read", {
|
|
196
|
+
selfService: true,
|
|
197
|
+
effect: "read",
|
|
198
|
+
allowedTargetKinds: SELF,
|
|
199
|
+
defaultRoles: BUILDER_ROLES_AND_SUBSCRIBER,
|
|
200
|
+
delegation: "maker_token"
|
|
201
|
+
}),
|
|
202
|
+
"personal_data:export": permission("personal_data:export", {
|
|
203
|
+
selfService: true,
|
|
204
|
+
effect: "read",
|
|
205
|
+
allowedTargetKinds: SELF,
|
|
206
|
+
defaultRoles: BUILDER_ROLES_AND_SUBSCRIBER,
|
|
207
|
+
delegation: "maker_token"
|
|
208
|
+
}),
|
|
209
|
+
"platform_legal:read": permission("platform_legal:read", {
|
|
210
|
+
selfService: true,
|
|
211
|
+
effect: "read",
|
|
212
|
+
allowedTargetKinds: SELF,
|
|
213
|
+
defaultRoles: BUILDER_ROLES_AND_SUBSCRIBER,
|
|
214
|
+
delegation: "maker_token"
|
|
215
|
+
}),
|
|
216
|
+
"platform_legal:accept": permission("platform_legal:accept", {
|
|
217
|
+
selfService: true,
|
|
218
|
+
effect: "write",
|
|
219
|
+
allowedTargetKinds: SELF,
|
|
220
|
+
defaultRoles: BUILDER_ROLES_AND_SUBSCRIBER,
|
|
221
|
+
humanOnly: true,
|
|
222
|
+
delegation: "browser_only"
|
|
223
|
+
}),
|
|
186
224
|
"business:create": permission("business:create", {
|
|
187
225
|
effect: "write",
|
|
188
226
|
allowedTargetKinds: ORGANIZATION,
|
|
@@ -766,6 +804,9 @@ function validatePlatformPermissionCatalog() {
|
|
|
766
804
|
throw new Error(`Platform permission must be exact: ${permission2}`);
|
|
767
805
|
}
|
|
768
806
|
const metadata = PLATFORM_PERMISSION_CATALOG[permission2];
|
|
807
|
+
if (metadata.selfService && (metadata.allowedTargetKinds.length !== 1 || metadata.allowedTargetKinds[0] !== "self")) {
|
|
808
|
+
throw new Error(`Self-service permission must target only the caller: ${permission2}`);
|
|
809
|
+
}
|
|
769
810
|
if (metadata.allowedTargetKinds.length === 0) {
|
|
770
811
|
throw new Error(`Platform permission has no target kind: ${permission2}`);
|
|
771
812
|
}
|
|
@@ -790,6 +831,19 @@ var REPO_AUTHORED = (declaration) => ({
|
|
|
790
831
|
});
|
|
791
832
|
var PLATFORM_OPERATION_DEFINITIONS = [
|
|
792
833
|
// ── contract — managed as code; repo canonical; MCP read-only ──────────────
|
|
834
|
+
{
|
|
835
|
+
key: "account_erasure.request",
|
|
836
|
+
class: "operate",
|
|
837
|
+
domain: "account",
|
|
838
|
+
unavailable: {
|
|
839
|
+
reason: "human_decision",
|
|
840
|
+
detail: "Only a person can delete their account, in the dashboard settings."
|
|
841
|
+
}
|
|
842
|
+
},
|
|
843
|
+
{ key: "account_erasure.read", class: "operate", domain: "account" },
|
|
844
|
+
{ key: "personal_data.export", class: "operate", domain: "account" },
|
|
845
|
+
{ key: "platform_legal.read", class: "operate", domain: "legal" },
|
|
846
|
+
{ key: "platform_legal.accept", class: "operate", domain: "legal" },
|
|
793
847
|
{
|
|
794
848
|
key: "plan.create",
|
|
795
849
|
class: "contract",
|
|
@@ -1081,6 +1135,17 @@ var PLATFORM_OPERATION_DEFINITIONS = [
|
|
|
1081
1135
|
class: "operate",
|
|
1082
1136
|
domain: PROMO_CODES_DOMAIN
|
|
1083
1137
|
},
|
|
1138
|
+
{
|
|
1139
|
+
key: "consumer.data.erase",
|
|
1140
|
+
class: "operate",
|
|
1141
|
+
domain: "consumers",
|
|
1142
|
+
unavailable: {
|
|
1143
|
+
reason: "human_decision",
|
|
1144
|
+
detail: "Only a person can erase customer data, in the dashboard."
|
|
1145
|
+
}
|
|
1146
|
+
},
|
|
1147
|
+
{ key: "consumer.data.erasure.read", class: "operate", domain: "consumers" },
|
|
1148
|
+
{ key: "consumer.data.export", class: "operate", domain: "consumers" },
|
|
1084
1149
|
{ key: "consumer.read", class: "operate", domain: "consumers" },
|
|
1085
1150
|
{ key: "consumer.block", class: "operate", domain: "consumers" },
|
|
1086
1151
|
{
|
|
@@ -1345,6 +1410,13 @@ var PLATFORM_OPERATION_DEFINITIONS = [
|
|
|
1345
1410
|
class: "operate",
|
|
1346
1411
|
domain: "organizations"
|
|
1347
1412
|
},
|
|
1413
|
+
// One seller per organization: every business in the organization sells as
|
|
1414
|
+
// the organization, with the details of its one payment account.
|
|
1415
|
+
{
|
|
1416
|
+
key: "organization.seller_details.read",
|
|
1417
|
+
class: "operate",
|
|
1418
|
+
domain: "organizations"
|
|
1419
|
+
},
|
|
1348
1420
|
{
|
|
1349
1421
|
key: "organization.billing.manage",
|
|
1350
1422
|
class: "operate",
|
|
@@ -1583,6 +1655,26 @@ var MAKER_TOKEN_CREATE_ORG_PERMISSION = "maker_token:create_org";
|
|
|
1583
1655
|
var BUSINESS_READ_PERMISSION = "business:read";
|
|
1584
1656
|
var LOCAL_REPOSITORY_WRITE_PERMISSION = "local_repository:write";
|
|
1585
1657
|
var AGENT_OPERATION_AUTHORIZATIONS = {
|
|
1658
|
+
"account_erasure.request": {
|
|
1659
|
+
permission: "account_erasure:request",
|
|
1660
|
+
targetKind: "self"
|
|
1661
|
+
},
|
|
1662
|
+
"account_erasure.read": {
|
|
1663
|
+
permission: "account_erasure:read",
|
|
1664
|
+
targetKind: "self"
|
|
1665
|
+
},
|
|
1666
|
+
"personal_data.export": {
|
|
1667
|
+
permission: "personal_data:export",
|
|
1668
|
+
targetKind: "self"
|
|
1669
|
+
},
|
|
1670
|
+
"platform_legal.read": {
|
|
1671
|
+
permission: "platform_legal:read",
|
|
1672
|
+
targetKind: "self"
|
|
1673
|
+
},
|
|
1674
|
+
"platform_legal.accept": {
|
|
1675
|
+
permission: "platform_legal:accept",
|
|
1676
|
+
targetKind: "self"
|
|
1677
|
+
},
|
|
1586
1678
|
"auth.context.issue": {
|
|
1587
1679
|
permission: "auth_context:issue",
|
|
1588
1680
|
targetKind: "business"
|
|
@@ -1835,6 +1927,18 @@ var AGENT_OPERATION_AUTHORIZATIONS = {
|
|
|
1835
1927
|
permission: "consumer:migrate_latest",
|
|
1836
1928
|
targetKind: "business"
|
|
1837
1929
|
},
|
|
1930
|
+
"consumer.data.erase": {
|
|
1931
|
+
permission: "consumer:remove",
|
|
1932
|
+
targetKind: "business"
|
|
1933
|
+
},
|
|
1934
|
+
"consumer.data.erasure.read": {
|
|
1935
|
+
permission: "consumer:read",
|
|
1936
|
+
targetKind: "business"
|
|
1937
|
+
},
|
|
1938
|
+
"consumer.data.export": {
|
|
1939
|
+
permission: "consumer:read",
|
|
1940
|
+
targetKind: "business"
|
|
1941
|
+
},
|
|
1838
1942
|
"consumer.read": { permission: "consumer:read", targetKind: "business" },
|
|
1839
1943
|
"consumer.remove": { permission: "consumer:remove", targetKind: "business" },
|
|
1840
1944
|
"consumer.roles.assign": {
|
|
@@ -1968,6 +2072,10 @@ var AGENT_OPERATION_AUTHORIZATIONS = {
|
|
|
1968
2072
|
permission: "organization:read",
|
|
1969
2073
|
targetKind: "organization"
|
|
1970
2074
|
},
|
|
2075
|
+
"organization.seller_details.read": {
|
|
2076
|
+
permission: "organization:read",
|
|
2077
|
+
targetKind: "organization"
|
|
2078
|
+
},
|
|
1971
2079
|
"organization.ownership.transfer": {
|
|
1972
2080
|
permission: "organization:ownership_transfer",
|
|
1973
2081
|
targetKind: "organization"
|
|
@@ -2290,12 +2398,65 @@ function operationAuthorizationFor(key) {
|
|
|
2290
2398
|
return AGENT_OPERATION_AUTHORIZATIONS[key];
|
|
2291
2399
|
}
|
|
2292
2400
|
function isHumanOnlyOperation(key) {
|
|
2401
|
+
if (PLATFORM_OPERATION_DEFINITIONS.find((operation2) => operation2.key === key)?.unavailable?.reason === "human_decision")
|
|
2402
|
+
return true;
|
|
2293
2403
|
const permission2 = operationAuthorizationFor(key)?.permission;
|
|
2294
2404
|
return permission2 !== void 0 && permission2 !== LOCAL_REPOSITORY_WRITE_PERMISSION && PLATFORM_PERMISSION_CATALOG[permission2].humanOnly === true;
|
|
2295
2405
|
}
|
|
2296
2406
|
|
|
2297
2407
|
// ../contracts/dist/operation-spec.js
|
|
2298
2408
|
var SPECS = {
|
|
2409
|
+
"account_erasure.request": {
|
|
2410
|
+
summary: "Delete your account",
|
|
2411
|
+
description: "Request account erasure in the dashboard after typing your account email. Transfer or delete shared organizations and published businesses, and settle money first.",
|
|
2412
|
+
destructive: true,
|
|
2413
|
+
oneTimeSecret: false,
|
|
2414
|
+
preview: false,
|
|
2415
|
+
reconcile: { op: "account_erasure.read" }
|
|
2416
|
+
},
|
|
2417
|
+
"account_erasure.read": {
|
|
2418
|
+
summary: "Read your account deletion status",
|
|
2419
|
+
description: "Read progress or refusal for your own account deletion request.",
|
|
2420
|
+
destructive: false,
|
|
2421
|
+
oneTimeSecret: false,
|
|
2422
|
+
preview: false
|
|
2423
|
+
},
|
|
2424
|
+
"consumer.data.erase": {
|
|
2425
|
+
summary: "Erase customer data",
|
|
2426
|
+
description: "Erase one customer relationship after settlement and dashboard confirmation. Retain financial, usage, legal and audit evidence.",
|
|
2427
|
+
destructive: true,
|
|
2428
|
+
oneTimeSecret: false,
|
|
2429
|
+
preview: false,
|
|
2430
|
+
reconcile: { op: "consumer.data.erasure.read" }
|
|
2431
|
+
},
|
|
2432
|
+
"consumer.data.erasure.read": {
|
|
2433
|
+
summary: "Read customer erasure status",
|
|
2434
|
+
description: "Read the progress or refusal of customer data erasure for one business.",
|
|
2435
|
+
destructive: false,
|
|
2436
|
+
oneTimeSecret: false,
|
|
2437
|
+
preview: false
|
|
2438
|
+
},
|
|
2439
|
+
"consumer.data.export": {
|
|
2440
|
+
summary: "Export a customer's data",
|
|
2441
|
+
description: "Export one customer's data for one business as JSON.",
|
|
2442
|
+
destructive: false,
|
|
2443
|
+
oneTimeSecret: false,
|
|
2444
|
+
preview: false
|
|
2445
|
+
},
|
|
2446
|
+
"personal_data.export": {
|
|
2447
|
+
summary: "Export your personal data",
|
|
2448
|
+
description: "Download your own account data as JSON. Organization credentials cannot export personal data.",
|
|
2449
|
+
destructive: false,
|
|
2450
|
+
oneTimeSecret: false,
|
|
2451
|
+
preview: false
|
|
2452
|
+
},
|
|
2453
|
+
"platform_legal.read": {
|
|
2454
|
+
summary: "Read required legal document acceptance",
|
|
2455
|
+
description: "Read which current platform legal documents the signed-in person has accepted and the dashboard link for outstanding documents. Acceptance is a human decision in the dashboard.",
|
|
2456
|
+
destructive: false,
|
|
2457
|
+
oneTimeSecret: false,
|
|
2458
|
+
preview: false
|
|
2459
|
+
},
|
|
2299
2460
|
"business.list": {
|
|
2300
2461
|
summary: "List businesses in the current org",
|
|
2301
2462
|
description: "List every business in the authenticated FartherShore workspace (id, name, status). Read-only; use this to discover business ids for the other tools.",
|
|
@@ -3159,6 +3320,13 @@ var SPECS = {
|
|
|
3159
3320
|
preview: false,
|
|
3160
3321
|
pagination: "cursor"
|
|
3161
3322
|
},
|
|
3323
|
+
"organization.seller_details.read": {
|
|
3324
|
+
summary: "Read the organization's seller details",
|
|
3325
|
+
description: "Read the public seller details every business in the organization shows customers on its site, at checkout, on receipts and in emails. They come from the organization's payment account (legal name, support email, postal address, support URL); a business cannot go live until the account has them.",
|
|
3326
|
+
destructive: false,
|
|
3327
|
+
oneTimeSecret: false,
|
|
3328
|
+
preview: false
|
|
3329
|
+
},
|
|
3162
3330
|
"org_maker_token.permission_catalog.read": {
|
|
3163
3331
|
summary: "List the exact permissions a human may delegate to an org MakerToken",
|
|
3164
3332
|
description: "List the exact permissions a human may delegate to an org MakerToken",
|
|
@@ -3568,6 +3736,9 @@ function operationSpecFor(key) {
|
|
|
3568
3736
|
return Object.hasOwn(OPERATION_SPECS, key) ? OPERATION_SPECS[key] : void 0;
|
|
3569
3737
|
}
|
|
3570
3738
|
var ROOT_NAMESPACES = {
|
|
3739
|
+
account_erasure: ["account", "erasure"],
|
|
3740
|
+
personal_data: ["personalData"],
|
|
3741
|
+
platform_legal: ["platform", "legal"],
|
|
3571
3742
|
analytics: ["analytics"],
|
|
3572
3743
|
apply_timeline: ["changeSets", "timeline"],
|
|
3573
3744
|
auth: ["auth"],
|
|
@@ -3662,6 +3833,15 @@ var STREAMING_EXEMPT_CONTENT_TYPE_SET = new Set(STREAMING_EXEMPT_CONTENT_TYPES);
|
|
|
3662
3833
|
|
|
3663
3834
|
// ../contracts/dist/error-codes.js
|
|
3664
3835
|
var ERROR_CODES = {
|
|
3836
|
+
CUSTOMER_ERASURE_UNSETTLED_MONEY: "CUSTOMER_ERASURE_UNSETTLED_MONEY",
|
|
3837
|
+
CUSTOMER_ERASURE_ORGANIZATION_AUTHORITY: "CUSTOMER_ERASURE_ORGANIZATION_AUTHORITY",
|
|
3838
|
+
CUSTOMER_ERASURE_CONFIRMATION_MISMATCH: "CUSTOMER_ERASURE_CONFIRMATION_MISMATCH",
|
|
3839
|
+
ACCOUNT_ERASURE_SHARED_ORGANIZATION: "ACCOUNT_ERASURE_SHARED_ORGANIZATION",
|
|
3840
|
+
ACCOUNT_ERASURE_PUBLISHED_BUSINESS: "ACCOUNT_ERASURE_PUBLISHED_BUSINESS",
|
|
3841
|
+
ACCOUNT_ERASURE_UNSETTLED_MONEY: "ACCOUNT_ERASURE_UNSETTLED_MONEY",
|
|
3842
|
+
ACCOUNT_ERASURE_CONFIRMATION_MISMATCH: "ACCOUNT_ERASURE_CONFIRMATION_MISMATCH",
|
|
3843
|
+
SELLER_LAUNCH_REQUIREMENTS_MISSING: "SELLER_LAUNCH_REQUIREMENTS_MISSING",
|
|
3844
|
+
LEGAL_ACCEPTANCE_REQUIRED: "LEGAL_ACCEPTANCE_REQUIRED",
|
|
3665
3845
|
MAINTENANCE_JOB_RETIRED: "MAINTENANCE_JOB_RETIRED",
|
|
3666
3846
|
INVALID_USAGE_UNIT_LABEL: "INVALID_USAGE_UNIT_LABEL",
|
|
3667
3847
|
HUMAN_ONLY_ACTION: "HUMAN_ONLY_ACTION",
|
|
@@ -4317,6 +4497,22 @@ var auditNotificationOperations = {
|
|
|
4317
4497
|
|
|
4318
4498
|
// src/operations/auth.ts
|
|
4319
4499
|
var authOperations = {
|
|
4500
|
+
"account.erasure.read": operation({
|
|
4501
|
+
op: "account_erasure.read",
|
|
4502
|
+
run: (ctx) => send(ctx, "GET", "/agent/v1/account-erasure")
|
|
4503
|
+
}),
|
|
4504
|
+
"personalData.export": operation({
|
|
4505
|
+
op: "personal_data.export",
|
|
4506
|
+
run: (ctx) => send(ctx, "GET", "/agent/v1/personal-data/export")
|
|
4507
|
+
}),
|
|
4508
|
+
"platform.legal.read": operation({
|
|
4509
|
+
op: "platform_legal.read",
|
|
4510
|
+
run: (ctx) => send(
|
|
4511
|
+
ctx,
|
|
4512
|
+
"GET",
|
|
4513
|
+
"/agent/v1/platform-legal"
|
|
4514
|
+
)
|
|
4515
|
+
}),
|
|
4320
4516
|
"auth.context.read": operation({
|
|
4321
4517
|
op: "auth.context.read",
|
|
4322
4518
|
async run(ctx) {
|
|
@@ -4693,6 +4889,16 @@ var setRbac = (op, enabled) => operation({
|
|
|
4693
4889
|
})
|
|
4694
4890
|
});
|
|
4695
4891
|
var consumerOperations = {
|
|
4892
|
+
"consumers.data.export": operation({
|
|
4893
|
+
op: "consumer.data.export",
|
|
4894
|
+
run: (ctx, { businessId, subscriberId }) => send(ctx, "GET", `${consumer(businessId, subscriberId)}/data-export`)
|
|
4895
|
+
}),
|
|
4896
|
+
// Status of a customer's erasure request for this business, or null when
|
|
4897
|
+
// none exists. Starting an erasure is done by a person in the dashboard.
|
|
4898
|
+
"consumers.data.erasure.read": operation({
|
|
4899
|
+
op: "consumer.data.erasure.read",
|
|
4900
|
+
run: (ctx, { businessId, subscriberId }) => send(ctx, "GET", `${consumer(businessId, subscriberId)}/data-erasure`)
|
|
4901
|
+
}),
|
|
4696
4902
|
"consumers.read": operation({
|
|
4697
4903
|
op: "consumer.read",
|
|
4698
4904
|
run: (ctx, { businessId, env }) => send(
|
|
@@ -4907,6 +5113,10 @@ var organizationOperations = {
|
|
|
4907
5113
|
})
|
|
4908
5114
|
)
|
|
4909
5115
|
}),
|
|
5116
|
+
"organizations.sellerDetails.read": operation({
|
|
5117
|
+
op: "organization.seller_details.read",
|
|
5118
|
+
run: (ctx, { organizationId }) => send(ctx, "GET", `${org(organizationId)}/seller-details`)
|
|
5119
|
+
}),
|
|
4910
5120
|
"organizations.role.list": operation({
|
|
4911
5121
|
op: "organization.role.list",
|
|
4912
5122
|
run: (ctx, { organizationId, query }) => send(
|
|
@@ -6088,7 +6298,7 @@ function diagnosticsOf(parsed) {
|
|
|
6088
6298
|
}
|
|
6089
6299
|
|
|
6090
6300
|
// src/version.ts
|
|
6091
|
-
var CLIENT_VERSION = "0.
|
|
6301
|
+
var CLIENT_VERSION = "0.7.0";
|
|
6092
6302
|
var CLIENT_PRODUCT = `@farthershore/client/${CLIENT_VERSION}`;
|
|
6093
6303
|
|
|
6094
6304
|
// src/transport.ts
|
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
import type { Method } from "./surface-types.js";
|
|
2
2
|
/** The namespaced Farther Shore API (`createFartherShore`). */
|
|
3
3
|
export interface FartherShoreApi {
|
|
4
|
+
readonly account: {
|
|
5
|
+
readonly erasure: {
|
|
6
|
+
/**
|
|
7
|
+
* Read your account deletion status
|
|
8
|
+
*
|
|
9
|
+
* Read progress or refusal for your own account deletion request.
|
|
10
|
+
*
|
|
11
|
+
* Operation `account_erasure.read` · read · requires `account_erasure:read`.
|
|
12
|
+
*/
|
|
13
|
+
readonly read: Method<"account.erasure.read">;
|
|
14
|
+
};
|
|
15
|
+
};
|
|
4
16
|
readonly agents: {
|
|
5
17
|
/**
|
|
6
18
|
* Turn the Operator off (stops runs + billing)
|
|
@@ -542,6 +554,26 @@ export interface FartherShoreApi {
|
|
|
542
554
|
* Operation `consumer.block` · write · requires `consumer:block` · destructive · reconcile an unknown outcome with `consumer.read`.
|
|
543
555
|
*/
|
|
544
556
|
readonly block: Method<"consumers.block">;
|
|
557
|
+
readonly data: {
|
|
558
|
+
readonly erasure: {
|
|
559
|
+
/**
|
|
560
|
+
* Read customer erasure status
|
|
561
|
+
*
|
|
562
|
+
* Read the progress or refusal of customer data erasure for one business.
|
|
563
|
+
*
|
|
564
|
+
* Operation `consumer.data.erasure.read` · read · requires `consumer:read`.
|
|
565
|
+
*/
|
|
566
|
+
readonly read: Method<"consumers.data.erasure.read">;
|
|
567
|
+
};
|
|
568
|
+
/**
|
|
569
|
+
* Export a customer's data
|
|
570
|
+
*
|
|
571
|
+
* Export one customer's data for one business as JSON.
|
|
572
|
+
*
|
|
573
|
+
* Operation `consumer.data.export` · read · requires `consumer:read`.
|
|
574
|
+
*/
|
|
575
|
+
readonly export: Method<"consumers.data.export">;
|
|
576
|
+
};
|
|
545
577
|
/**
|
|
546
578
|
* Move one consumer to the active head of their plan lineage
|
|
547
579
|
*
|
|
@@ -878,6 +910,26 @@ export interface FartherShoreApi {
|
|
|
878
910
|
*/
|
|
879
911
|
readonly update: Method<"organizations.role.update">;
|
|
880
912
|
};
|
|
913
|
+
readonly sellerDetails: {
|
|
914
|
+
/**
|
|
915
|
+
* Read the organization's seller details
|
|
916
|
+
*
|
|
917
|
+
* Read the public seller details every business in the organization shows customers on its site, at checkout, on receipts and in emails. They come from the organization's payment account (legal name, support email, postal address, support URL); a business cannot go live until the account has them.
|
|
918
|
+
*
|
|
919
|
+
* Operation `organization.seller_details.read` · read · requires `organization:read`.
|
|
920
|
+
*/
|
|
921
|
+
readonly read: Method<"organizations.sellerDetails.read">;
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
readonly personalData: {
|
|
925
|
+
/**
|
|
926
|
+
* Export your personal data
|
|
927
|
+
*
|
|
928
|
+
* Download your own account data as JSON. Organization credentials cannot export personal data.
|
|
929
|
+
*
|
|
930
|
+
* Operation `personal_data.export` · read · requires `personal_data:export`.
|
|
931
|
+
*/
|
|
932
|
+
readonly export: Method<"personalData.export">;
|
|
881
933
|
};
|
|
882
934
|
readonly personas: {
|
|
883
935
|
/**
|
|
@@ -966,6 +1018,16 @@ export interface FartherShoreApi {
|
|
|
966
1018
|
*/
|
|
967
1019
|
readonly read: Method<"platform.dependents.read">;
|
|
968
1020
|
};
|
|
1021
|
+
readonly legal: {
|
|
1022
|
+
/**
|
|
1023
|
+
* Read required legal document acceptance
|
|
1024
|
+
*
|
|
1025
|
+
* Read which current platform legal documents the signed-in person has accepted and the dashboard link for outstanding documents. Acceptance is a human decision in the dashboard.
|
|
1026
|
+
*
|
|
1027
|
+
* Operation `platform_legal.read` · read · requires `platform_legal:read`.
|
|
1028
|
+
*/
|
|
1029
|
+
readonly read: Method<"platform.legal.read">;
|
|
1030
|
+
};
|
|
969
1031
|
readonly resourceCounts: {
|
|
970
1032
|
/**
|
|
971
1033
|
* Report a subscription resource count
|
|
@@ -980,6 +980,17 @@ export interface components {
|
|
|
980
980
|
user: {
|
|
981
981
|
id: string;
|
|
982
982
|
};
|
|
983
|
+
legalAcceptance: {
|
|
984
|
+
accepted: ("terms" | "privacy" | "acceptableUse")[];
|
|
985
|
+
outstanding: ("terms" | "privacy" | "acceptableUse")[];
|
|
986
|
+
requiredVersions: {
|
|
987
|
+
terms: string;
|
|
988
|
+
privacy: string;
|
|
989
|
+
acceptableUse: string;
|
|
990
|
+
};
|
|
991
|
+
/** Format: uri */
|
|
992
|
+
dashboardUrl: string;
|
|
993
|
+
};
|
|
983
994
|
personalOrganization: components["schemas"]["BuilderContextOrganization"];
|
|
984
995
|
activeOrganization: {
|
|
985
996
|
id: string;
|
|
@@ -992,7 +1003,7 @@ export interface components {
|
|
|
992
1003
|
organization: components["schemas"]["BuilderContextOrganization"];
|
|
993
1004
|
role: string;
|
|
994
1005
|
}[];
|
|
995
|
-
effectivePermissions: ("agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "plan:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
1006
|
+
effectivePermissions: ("account_erasure:read" | "account_erasure:request" | "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "personal_data:export" | "plan:read" | "platform_legal:accept" | "platform_legal:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
996
1007
|
shouldPersistActiveOrganization: boolean;
|
|
997
1008
|
platformTier: string | null;
|
|
998
1009
|
platformSubscription: {
|
|
@@ -1163,6 +1174,12 @@ export interface components {
|
|
|
1163
1174
|
id: string;
|
|
1164
1175
|
organizationId: string | null;
|
|
1165
1176
|
name: string;
|
|
1177
|
+
sellerLaunchRefusal?: {
|
|
1178
|
+
/** @constant */
|
|
1179
|
+
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
1180
|
+
settingsUrl: string;
|
|
1181
|
+
message: string;
|
|
1182
|
+
};
|
|
1166
1183
|
displayName: string | null;
|
|
1167
1184
|
description: string | null;
|
|
1168
1185
|
/** @enum {string} */
|
|
@@ -1277,6 +1294,12 @@ export interface components {
|
|
|
1277
1294
|
id: string;
|
|
1278
1295
|
organizationId: string | null;
|
|
1279
1296
|
name: string;
|
|
1297
|
+
sellerLaunchRefusal?: {
|
|
1298
|
+
/** @constant */
|
|
1299
|
+
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
1300
|
+
settingsUrl: string;
|
|
1301
|
+
message: string;
|
|
1302
|
+
};
|
|
1280
1303
|
displayName: string | null;
|
|
1281
1304
|
description: string | null;
|
|
1282
1305
|
/** @enum {string} */
|
|
@@ -2180,7 +2203,7 @@ export interface components {
|
|
|
2180
2203
|
updatedAt: string;
|
|
2181
2204
|
};
|
|
2182
2205
|
/** @enum {string} */
|
|
2183
|
-
MakerDelegablePermission: "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "knowledge:read" | "organization:read" | "organization_bulletin:read" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "plan:read" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback";
|
|
2206
|
+
MakerDelegablePermission: "account_erasure:read" | "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "knowledge:read" | "organization:read" | "organization_bulletin:read" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "personal_data:export" | "plan:read" | "platform_legal:read" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback";
|
|
2184
2207
|
MakerTokenBusinessScopeSummary: {
|
|
2185
2208
|
/** @constant */
|
|
2186
2209
|
mode: "ALL";
|
|
@@ -2308,7 +2331,7 @@ export interface components {
|
|
|
2308
2331
|
credentialType: "maker_token";
|
|
2309
2332
|
tokenId: string;
|
|
2310
2333
|
organizationId: string;
|
|
2311
|
-
grantedPermissions: ("agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "plan:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
2334
|
+
grantedPermissions: ("account_erasure:read" | "account_erasure:request" | "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "personal_data:export" | "plan:read" | "platform_legal:accept" | "platform_legal:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
2312
2335
|
/** @enum {string} */
|
|
2313
2336
|
businessScopeMode: "ALL" | "SELECTED";
|
|
2314
2337
|
selectedBusinessIds: string[];
|
|
@@ -2322,6 +2345,7 @@ export interface components {
|
|
|
2322
2345
|
usage?: boolean;
|
|
2323
2346
|
access?: boolean;
|
|
2324
2347
|
product?: boolean;
|
|
2348
|
+
marketing?: boolean;
|
|
2325
2349
|
deployments?: boolean;
|
|
2326
2350
|
team?: boolean;
|
|
2327
2351
|
security?: boolean;
|
|
@@ -2601,6 +2625,11 @@ export interface components {
|
|
|
2601
2625
|
canDelete: boolean;
|
|
2602
2626
|
};
|
|
2603
2627
|
};
|
|
2628
|
+
OrganizationSellerDetails: {
|
|
2629
|
+
sellerIdentity: components["schemas"]["SellerIdentity"] | null;
|
|
2630
|
+
/** @enum {string} */
|
|
2631
|
+
status: "not_connected" | "incomplete" | "complete";
|
|
2632
|
+
};
|
|
2604
2633
|
OrganizationSentInvitation: {
|
|
2605
2634
|
id: string;
|
|
2606
2635
|
email: string;
|
|
@@ -2662,7 +2691,7 @@ export interface components {
|
|
|
2662
2691
|
unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
|
|
2663
2692
|
};
|
|
2664
2693
|
/** @enum {string} */
|
|
2665
|
-
PlatformPermission: "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "plan:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback";
|
|
2694
|
+
PlatformPermission: "account_erasure:read" | "account_erasure:request" | "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "personal_data:export" | "plan:read" | "platform_legal:accept" | "platform_legal:read" | "product_subscription:create" | "promo_code:archive" | "promo_code:create" | "promo_code:reactivate" | "promo_code:read" | "promo_code:update" | "rbac:read" | "resource_count:report" | "runtime_token:mint" | "runtime_token:read" | "runtime_token:revoke" | "runtime_token:rotate" | "stripe_connection:close" | "stripe_connection:create" | "stripe_connection:read" | "tax_settings:read" | "tax_settings:update" | "usage:read" | "webhook:create" | "webhook:delete" | "webhook:delivery_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback";
|
|
2666
2695
|
PortalBalance: {
|
|
2667
2696
|
/** @constant */
|
|
2668
2697
|
disclosure: "transparent";
|
|
@@ -3053,6 +3082,12 @@ export interface components {
|
|
|
3053
3082
|
id: string;
|
|
3054
3083
|
organizationId: string | null;
|
|
3055
3084
|
name: string;
|
|
3085
|
+
sellerLaunchRefusal?: {
|
|
3086
|
+
/** @constant */
|
|
3087
|
+
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
3088
|
+
settingsUrl: string;
|
|
3089
|
+
message: string;
|
|
3090
|
+
};
|
|
3056
3091
|
displayName: string | null;
|
|
3057
3092
|
description: string | null;
|
|
3058
3093
|
/** @enum {string} */
|
|
@@ -3238,6 +3273,22 @@ export interface components {
|
|
|
3238
3273
|
subscriberCount: number;
|
|
3239
3274
|
};
|
|
3240
3275
|
};
|
|
3276
|
+
SellerIdentity: {
|
|
3277
|
+
legalName: string;
|
|
3278
|
+
/** Format: email */
|
|
3279
|
+
supportEmail: string;
|
|
3280
|
+
address: {
|
|
3281
|
+
line1: string;
|
|
3282
|
+
line2?: string;
|
|
3283
|
+
city: string;
|
|
3284
|
+
region?: string;
|
|
3285
|
+
postalCode: string;
|
|
3286
|
+
country: string;
|
|
3287
|
+
};
|
|
3288
|
+
/** Format: uri */
|
|
3289
|
+
supportUrl?: string;
|
|
3290
|
+
registrationNumber?: string;
|
|
3291
|
+
};
|
|
3241
3292
|
ServingState: {
|
|
3242
3293
|
/** @enum {string} */
|
|
3243
3294
|
status: "unconfigured" | "publishing" | "missing" | "invalid" | "coherent";
|