@farthershore/client 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/CHANGELOG.md +31 -0
- package/README.md +10 -10
- package/dist/index.js +117 -60
- package/dist/types/api.generated.d.ts +43 -25
- package/dist/types/generated/schemas.d.ts +117 -37
- package/dist/types/operations/auth.d.ts +26 -8
- package/dist/types/operations/backends.d.ts +76 -21
- package/dist/types/operations/businesses.d.ts +48 -90
- package/dist/types/operations/consumers.d.ts +2 -2
- package/dist/types/operations/define.d.ts +1 -1
- package/dist/types/operations/index.d.ts +201 -126
- 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 +12 -6
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
|
@@ -641,7 +641,7 @@ export interface components {
|
|
|
641
641
|
AnalyticsEventFeedRow: {
|
|
642
642
|
id: string;
|
|
643
643
|
/** @enum {string} */
|
|
644
|
-
type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
644
|
+
type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted" | "webhook_endpoint.paused";
|
|
645
645
|
/** Format: date-time */
|
|
646
646
|
occurredAt: string;
|
|
647
647
|
environmentId: string | null;
|
|
@@ -841,7 +841,7 @@ export interface components {
|
|
|
841
841
|
name: string;
|
|
842
842
|
trigger: {
|
|
843
843
|
/** @enum {string} */
|
|
844
|
-
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
844
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted" | "webhook_endpoint.paused";
|
|
845
845
|
filter?: {
|
|
846
846
|
subjectType?: string;
|
|
847
847
|
subjectId?: string;
|
|
@@ -908,6 +908,7 @@ export interface components {
|
|
|
908
908
|
Backend: {
|
|
909
909
|
id: string;
|
|
910
910
|
businessId: string;
|
|
911
|
+
scope: string;
|
|
911
912
|
environmentId: string | null;
|
|
912
913
|
name: string;
|
|
913
914
|
slug: string;
|
|
@@ -916,6 +917,7 @@ export interface components {
|
|
|
916
917
|
runner: ("embedded" | "sidecar") | null;
|
|
917
918
|
runtime: string | null;
|
|
918
919
|
originUrl: string | null;
|
|
920
|
+
originTemplate: string | null;
|
|
919
921
|
isDefault: boolean;
|
|
920
922
|
/** @enum {string} */
|
|
921
923
|
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
@@ -923,11 +925,40 @@ export interface components {
|
|
|
923
925
|
/** Format: date-time */
|
|
924
926
|
createdAt: string;
|
|
925
927
|
};
|
|
928
|
+
BackendBindResponse: {
|
|
929
|
+
id: string;
|
|
930
|
+
businessId: string;
|
|
931
|
+
scope: string;
|
|
932
|
+
environmentId: string | null;
|
|
933
|
+
name: string;
|
|
934
|
+
slug: string;
|
|
935
|
+
/** @enum {string} */
|
|
936
|
+
transportMode: "direct" | "tunnel";
|
|
937
|
+
runner: ("embedded" | "sidecar") | null;
|
|
938
|
+
runtime: string | null;
|
|
939
|
+
originUrl: string | null;
|
|
940
|
+
originTemplate: string | null;
|
|
941
|
+
isDefault: boolean;
|
|
942
|
+
/** @enum {string} */
|
|
943
|
+
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
944
|
+
lastSeenAt: string | null;
|
|
945
|
+
/** Format: date-time */
|
|
946
|
+
createdAt: string;
|
|
947
|
+
/** @enum {string} */
|
|
948
|
+
webhookReceiver?: "created" | "kept" | "skipped_at_limit" | "none";
|
|
949
|
+
defaultKey?: {
|
|
950
|
+
id: string;
|
|
951
|
+
lastFour: string;
|
|
952
|
+
envVars: ["FS_SECRET_KEY"];
|
|
953
|
+
token: string;
|
|
954
|
+
};
|
|
955
|
+
};
|
|
926
956
|
BackendCreatePreview: {
|
|
927
957
|
/** @enum {string} */
|
|
928
958
|
action: "create" | "update";
|
|
929
959
|
backend: {
|
|
930
960
|
businessId: string;
|
|
961
|
+
scope: string;
|
|
931
962
|
environmentId: string | null;
|
|
932
963
|
name: string;
|
|
933
964
|
slug: string;
|
|
@@ -936,12 +967,14 @@ export interface components {
|
|
|
936
967
|
runner: ("embedded" | "sidecar") | null;
|
|
937
968
|
runtime: string | null;
|
|
938
969
|
originUrl: string | null;
|
|
970
|
+
originTemplate: string | null;
|
|
939
971
|
isDefault: boolean;
|
|
940
972
|
};
|
|
941
973
|
};
|
|
942
974
|
BackendCreateResponse: {
|
|
943
975
|
id: string;
|
|
944
976
|
businessId: string;
|
|
977
|
+
scope: string;
|
|
945
978
|
environmentId: string | null;
|
|
946
979
|
name: string;
|
|
947
980
|
slug: string;
|
|
@@ -950,6 +983,7 @@ export interface components {
|
|
|
950
983
|
runner: ("embedded" | "sidecar") | null;
|
|
951
984
|
runtime: string | null;
|
|
952
985
|
originUrl: string | null;
|
|
986
|
+
originTemplate: string | null;
|
|
953
987
|
isDefault: boolean;
|
|
954
988
|
/** @enum {string} */
|
|
955
989
|
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
@@ -958,6 +992,14 @@ export interface components {
|
|
|
958
992
|
createdAt: string;
|
|
959
993
|
/** @constant */
|
|
960
994
|
updated?: true;
|
|
995
|
+
/** @enum {string} */
|
|
996
|
+
webhookReceiver?: "created" | "kept" | "skipped_at_limit" | "none";
|
|
997
|
+
defaultKey?: {
|
|
998
|
+
id: string;
|
|
999
|
+
lastFour: string;
|
|
1000
|
+
envVars: ["FS_SECRET_KEY"];
|
|
1001
|
+
token: string;
|
|
1002
|
+
};
|
|
961
1003
|
};
|
|
962
1004
|
BackendDeleteResponse: {
|
|
963
1005
|
id: string;
|
|
@@ -981,13 +1023,24 @@ export interface components {
|
|
|
981
1023
|
id: string;
|
|
982
1024
|
};
|
|
983
1025
|
legalAcceptance: {
|
|
984
|
-
accepted: ("terms" | "privacy" | "
|
|
985
|
-
outstanding: ("terms" | "privacy" | "
|
|
1026
|
+
accepted: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
1027
|
+
outstanding: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
986
1028
|
requiredVersions: {
|
|
987
1029
|
terms: string;
|
|
988
1030
|
privacy: string;
|
|
989
|
-
|
|
1031
|
+
"acceptable-use": string;
|
|
1032
|
+
"builder-agreement": string;
|
|
990
1033
|
};
|
|
1034
|
+
upcoming: {
|
|
1035
|
+
/** @enum {string} */
|
|
1036
|
+
document: "terms" | "privacy" | "acceptable-use" | "builder-agreement";
|
|
1037
|
+
version: string;
|
|
1038
|
+
effectiveOn: string;
|
|
1039
|
+
/** @enum {string} */
|
|
1040
|
+
changeClass: "routine" | "material";
|
|
1041
|
+
summary: string;
|
|
1042
|
+
accepted: boolean;
|
|
1043
|
+
}[];
|
|
991
1044
|
/** Format: uri */
|
|
992
1045
|
dashboardUrl: string;
|
|
993
1046
|
};
|
|
@@ -1003,7 +1056,7 @@ export interface components {
|
|
|
1003
1056
|
organization: components["schemas"]["BuilderContextOrganization"];
|
|
1004
1057
|
role: string;
|
|
1005
1058
|
}[];
|
|
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" | "
|
|
1059
|
+
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" | "secret_key:mint" | "secret_key:read" | "secret_key:revoke" | "secret_key: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")[];
|
|
1007
1060
|
shouldPersistActiveOrganization: boolean;
|
|
1008
1061
|
platformTier: string | null;
|
|
1009
1062
|
platformSubscription: {
|
|
@@ -1174,12 +1227,6 @@ export interface components {
|
|
|
1174
1227
|
id: string;
|
|
1175
1228
|
organizationId: string | null;
|
|
1176
1229
|
name: string;
|
|
1177
|
-
sellerLaunchRefusal?: {
|
|
1178
|
-
/** @constant */
|
|
1179
|
-
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
1180
|
-
settingsUrl: string;
|
|
1181
|
-
message: string;
|
|
1182
|
-
};
|
|
1183
1230
|
displayName: string | null;
|
|
1184
1231
|
description: string | null;
|
|
1185
1232
|
/** @enum {string} */
|
|
@@ -1271,6 +1318,12 @@ export interface components {
|
|
|
1271
1318
|
instructions: string;
|
|
1272
1319
|
agentsMdUrl: string;
|
|
1273
1320
|
};
|
|
1321
|
+
defaultKey?: {
|
|
1322
|
+
id: string;
|
|
1323
|
+
lastFour: string;
|
|
1324
|
+
envVars: ["FS_SECRET_KEY"];
|
|
1325
|
+
token: string;
|
|
1326
|
+
};
|
|
1274
1327
|
};
|
|
1275
1328
|
BusinessDependent: {
|
|
1276
1329
|
subscriberId: string;
|
|
@@ -1294,12 +1347,6 @@ export interface components {
|
|
|
1294
1347
|
id: string;
|
|
1295
1348
|
organizationId: string | null;
|
|
1296
1349
|
name: string;
|
|
1297
|
-
sellerLaunchRefusal?: {
|
|
1298
|
-
/** @constant */
|
|
1299
|
-
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
1300
|
-
settingsUrl: string;
|
|
1301
|
-
message: string;
|
|
1302
|
-
};
|
|
1303
1350
|
displayName: string | null;
|
|
1304
1351
|
description: string | null;
|
|
1305
1352
|
/** @enum {string} */
|
|
@@ -1335,6 +1382,16 @@ export interface components {
|
|
|
1335
1382
|
[key: string]: string;
|
|
1336
1383
|
};
|
|
1337
1384
|
environments: components["schemas"]["BusinessEnvironment"][];
|
|
1385
|
+
launchRequirements: {
|
|
1386
|
+
/** @enum {string} */
|
|
1387
|
+
obligation: "account.agreements_accepted" | "seller.details_complete";
|
|
1388
|
+
summary: string;
|
|
1389
|
+
missing: string[];
|
|
1390
|
+
fix: {
|
|
1391
|
+
label: string;
|
|
1392
|
+
url: string;
|
|
1393
|
+
};
|
|
1394
|
+
}[];
|
|
1338
1395
|
};
|
|
1339
1396
|
BusinessDiagnostic: {
|
|
1340
1397
|
code: string;
|
|
@@ -2203,7 +2260,7 @@ export interface components {
|
|
|
2203
2260
|
updatedAt: string;
|
|
2204
2261
|
};
|
|
2205
2262
|
/** @enum {string} */
|
|
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" | "
|
|
2263
|
+
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" | "secret_key:mint" | "secret_key:read" | "secret_key:revoke" | "secret_key: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";
|
|
2207
2264
|
MakerTokenBusinessScopeSummary: {
|
|
2208
2265
|
/** @constant */
|
|
2209
2266
|
mode: "ALL";
|
|
@@ -2331,7 +2388,7 @@ export interface components {
|
|
|
2331
2388
|
credentialType: "maker_token";
|
|
2332
2389
|
tokenId: string;
|
|
2333
2390
|
organizationId: string;
|
|
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" | "
|
|
2391
|
+
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" | "secret_key:mint" | "secret_key:read" | "secret_key:revoke" | "secret_key: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")[];
|
|
2335
2392
|
/** @enum {string} */
|
|
2336
2393
|
businessScopeMode: "ALL" | "SELECTED";
|
|
2337
2394
|
selectedBusinessIds: string[];
|
|
@@ -2691,7 +2748,7 @@ export interface components {
|
|
|
2691
2748
|
unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
|
|
2692
2749
|
};
|
|
2693
2750
|
/** @enum {string} */
|
|
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" | "
|
|
2751
|
+
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" | "secret_key:mint" | "secret_key:read" | "secret_key:revoke" | "secret_key: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";
|
|
2695
2752
|
PortalBalance: {
|
|
2696
2753
|
/** @constant */
|
|
2697
2754
|
disclosure: "transparent";
|
|
@@ -3082,12 +3139,6 @@ export interface components {
|
|
|
3082
3139
|
id: string;
|
|
3083
3140
|
organizationId: string | null;
|
|
3084
3141
|
name: string;
|
|
3085
|
-
sellerLaunchRefusal?: {
|
|
3086
|
-
/** @constant */
|
|
3087
|
-
code: "SELLER_LAUNCH_REQUIREMENTS_MISSING";
|
|
3088
|
-
settingsUrl: string;
|
|
3089
|
-
message: string;
|
|
3090
|
-
};
|
|
3091
3142
|
displayName: string | null;
|
|
3092
3143
|
description: string | null;
|
|
3093
3144
|
/** @enum {string} */
|
|
@@ -3184,15 +3235,17 @@ export interface components {
|
|
|
3184
3235
|
ResourceCountReport: {
|
|
3185
3236
|
resourceCount: components["schemas"]["ResourceCount"];
|
|
3186
3237
|
};
|
|
3187
|
-
|
|
3238
|
+
SecretKey: {
|
|
3188
3239
|
id: string;
|
|
3189
3240
|
businessId: string;
|
|
3241
|
+
scope: string;
|
|
3190
3242
|
environmentId: string | null;
|
|
3191
3243
|
backendId: string | null;
|
|
3244
|
+
isDefault: boolean;
|
|
3192
3245
|
/** @enum {string} */
|
|
3193
3246
|
kind: "live" | "test";
|
|
3194
3247
|
lastFour: string;
|
|
3195
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
3248
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
3196
3249
|
allowedMeters: string[];
|
|
3197
3250
|
allowedRoutes: string[];
|
|
3198
3251
|
/** @enum {string} */
|
|
@@ -3203,15 +3256,17 @@ export interface components {
|
|
|
3203
3256
|
revokedAt: string | null;
|
|
3204
3257
|
lastUsedAt: string | null;
|
|
3205
3258
|
};
|
|
3206
|
-
|
|
3259
|
+
SecretKeyIssuance: {
|
|
3207
3260
|
id: string;
|
|
3208
3261
|
businessId: string;
|
|
3262
|
+
scope: string;
|
|
3209
3263
|
environmentId: string | null;
|
|
3210
3264
|
backendId: string | null;
|
|
3265
|
+
isDefault: boolean;
|
|
3211
3266
|
/** @enum {string} */
|
|
3212
3267
|
kind: "live" | "test";
|
|
3213
3268
|
lastFour: string;
|
|
3214
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
3269
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
3215
3270
|
allowedMeters: string[];
|
|
3216
3271
|
allowedRoutes: string[];
|
|
3217
3272
|
/** @enum {string} */
|
|
@@ -3222,11 +3277,11 @@ export interface components {
|
|
|
3222
3277
|
revokedAt: string | null;
|
|
3223
3278
|
lastUsedAt: string | null;
|
|
3224
3279
|
/** @constant */
|
|
3225
|
-
envVar: "
|
|
3280
|
+
envVar: "FS_SECRET_KEY";
|
|
3226
3281
|
token: string;
|
|
3227
3282
|
};
|
|
3228
|
-
|
|
3229
|
-
data: components["schemas"]["
|
|
3283
|
+
SecretKeyList: {
|
|
3284
|
+
data: components["schemas"]["SecretKey"][];
|
|
3230
3285
|
pagination: {
|
|
3231
3286
|
total: number;
|
|
3232
3287
|
limit: number;
|
|
@@ -3476,6 +3531,9 @@ export interface components {
|
|
|
3476
3531
|
hasMore: boolean;
|
|
3477
3532
|
};
|
|
3478
3533
|
};
|
|
3534
|
+
WebhookDeliveryRedeliverResponse: {
|
|
3535
|
+
data: components["schemas"]["WebhookDelivery"];
|
|
3536
|
+
};
|
|
3479
3537
|
WebhookDeliveryResponse: {
|
|
3480
3538
|
data: {
|
|
3481
3539
|
id: string;
|
|
@@ -3501,6 +3559,14 @@ export interface components {
|
|
|
3501
3559
|
createdAt: string;
|
|
3502
3560
|
businessId: string;
|
|
3503
3561
|
environmentId: string | null;
|
|
3562
|
+
environment: {
|
|
3563
|
+
id: string | null;
|
|
3564
|
+
slug: string;
|
|
3565
|
+
name: string;
|
|
3566
|
+
/** @enum {string} */
|
|
3567
|
+
kind: "production" | "preview";
|
|
3568
|
+
branch: string | null;
|
|
3569
|
+
};
|
|
3504
3570
|
data: {
|
|
3505
3571
|
[key: string]: unknown;
|
|
3506
3572
|
};
|
|
@@ -3511,13 +3577,16 @@ export interface components {
|
|
|
3511
3577
|
};
|
|
3512
3578
|
WebhookEndpoint: {
|
|
3513
3579
|
id: string;
|
|
3580
|
+
/** @description Public delivery URL. For a managed tunnel receiver, /_fs/webhooks; backend names the receiving backend by its slug. */
|
|
3514
3581
|
url: string;
|
|
3582
|
+
scope: string;
|
|
3515
3583
|
environmentId: string | null;
|
|
3584
|
+
backend: string | null;
|
|
3516
3585
|
events: string[];
|
|
3517
3586
|
enabled: boolean;
|
|
3518
3587
|
signingSecretActionRequired: boolean;
|
|
3519
3588
|
failCount: number;
|
|
3520
|
-
|
|
3589
|
+
pausedAt: string | null;
|
|
3521
3590
|
/** Format: date-time */
|
|
3522
3591
|
createdAt: string;
|
|
3523
3592
|
/** Format: date-time */
|
|
@@ -3534,13 +3603,16 @@ export interface components {
|
|
|
3534
3603
|
};
|
|
3535
3604
|
WebhookEndpointIssuance: {
|
|
3536
3605
|
id: string;
|
|
3606
|
+
/** @description Public delivery URL. For a managed tunnel receiver, /_fs/webhooks; backend names the receiving backend by its slug. */
|
|
3537
3607
|
url: string;
|
|
3608
|
+
scope: string;
|
|
3538
3609
|
environmentId: string | null;
|
|
3610
|
+
backend: string | null;
|
|
3539
3611
|
events: string[];
|
|
3540
3612
|
enabled: boolean;
|
|
3541
3613
|
signingSecretActionRequired: boolean;
|
|
3542
3614
|
failCount: number;
|
|
3543
|
-
|
|
3615
|
+
pausedAt: string | null;
|
|
3544
3616
|
/** Format: date-time */
|
|
3545
3617
|
createdAt: string;
|
|
3546
3618
|
/** Format: date-time */
|
|
@@ -3561,13 +3633,16 @@ export interface components {
|
|
|
3561
3633
|
};
|
|
3562
3634
|
WebhookEndpointRotation: {
|
|
3563
3635
|
id: string;
|
|
3636
|
+
/** @description Public delivery URL. For a managed tunnel receiver, /_fs/webhooks; backend names the receiving backend by its slug. */
|
|
3564
3637
|
url: string;
|
|
3638
|
+
scope: string;
|
|
3565
3639
|
environmentId: string | null;
|
|
3640
|
+
backend: string | null;
|
|
3566
3641
|
events: string[];
|
|
3567
3642
|
enabled: boolean;
|
|
3568
3643
|
signingSecretActionRequired: boolean;
|
|
3569
3644
|
failCount: number;
|
|
3570
|
-
|
|
3645
|
+
pausedAt: string | null;
|
|
3571
3646
|
/** Format: date-time */
|
|
3572
3647
|
createdAt: string;
|
|
3573
3648
|
/** Format: date-time */
|
|
@@ -3587,6 +3662,11 @@ export interface components {
|
|
|
3587
3662
|
}[];
|
|
3588
3663
|
};
|
|
3589
3664
|
};
|
|
3665
|
+
WebhookRedeliverResponse: {
|
|
3666
|
+
data: {
|
|
3667
|
+
redelivered: number;
|
|
3668
|
+
};
|
|
3669
|
+
};
|
|
3590
3670
|
WebhookTestResponse: {
|
|
3591
3671
|
data: components["schemas"]["WebhookTestResult"];
|
|
3592
3672
|
};
|
|
@@ -50,7 +50,7 @@ export declare const authOperations: {
|
|
|
50
50
|
document: string;
|
|
51
51
|
version: string;
|
|
52
52
|
acceptedAt: string;
|
|
53
|
-
|
|
53
|
+
source: string;
|
|
54
54
|
}[];
|
|
55
55
|
notificationPreferences: {
|
|
56
56
|
businessId: string | null;
|
|
@@ -116,7 +116,7 @@ export declare const authOperations: {
|
|
|
116
116
|
document: string;
|
|
117
117
|
version: string;
|
|
118
118
|
acceptedAt: string;
|
|
119
|
-
|
|
119
|
+
source: string;
|
|
120
120
|
}[];
|
|
121
121
|
notificationPreferences: {
|
|
122
122
|
businessId: string | null;
|
|
@@ -157,22 +157,40 @@ export declare const authOperations: {
|
|
|
157
157
|
};
|
|
158
158
|
}, false>;
|
|
159
159
|
"platform.legal.read": import("./define.js").OperationEntry<void, {
|
|
160
|
-
accepted: ("terms" | "privacy" | "
|
|
161
|
-
outstanding: ("terms" | "privacy" | "
|
|
160
|
+
accepted: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
161
|
+
outstanding: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
162
162
|
requiredVersions: {
|
|
163
163
|
terms: string;
|
|
164
164
|
privacy: string;
|
|
165
|
-
|
|
165
|
+
"acceptable-use": string;
|
|
166
|
+
"builder-agreement": string;
|
|
166
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
|
+
}[];
|
|
167
176
|
dashboardUrl: string;
|
|
168
177
|
}, {
|
|
169
|
-
accepted: ("terms" | "privacy" | "
|
|
170
|
-
outstanding: ("terms" | "privacy" | "
|
|
178
|
+
accepted: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
179
|
+
outstanding: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
171
180
|
requiredVersions: {
|
|
172
181
|
terms: string;
|
|
173
182
|
privacy: string;
|
|
174
|
-
|
|
183
|
+
"acceptable-use": string;
|
|
184
|
+
"builder-agreement": string;
|
|
175
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
|
+
}[];
|
|
176
194
|
dashboardUrl: string;
|
|
177
195
|
}, false>;
|
|
178
196
|
"auth.context.read": import("./define.js").OperationEntry<void, CallerContext, CallerContext, false>;
|