@farthershore/client 0.3.0 → 0.5.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 +16 -0
- package/README.md +10 -2
- package/dist/index.js +221 -111
- package/dist/types/api.generated.d.ts +18 -38
- package/dist/types/credentials.d.ts +6 -2
- package/dist/types/envelope.d.ts +2 -0
- package/dist/types/errors.d.ts +13 -0
- package/dist/types/generated/schemas.d.ts +71 -28
- package/dist/types/helpers/refs.d.ts +2 -2
- package/dist/types/index.d.ts +1 -1
- package/dist/types/operations/agents.d.ts +9 -9
- package/dist/types/operations/agreements.d.ts +7 -7
- package/dist/types/operations/analytics.d.ts +5 -5
- package/dist/types/operations/audit-notifications.d.ts +6 -6
- package/dist/types/operations/auth.d.ts +4 -4
- package/dist/types/operations/backends.d.ts +8 -11
- package/dist/types/operations/billing.d.ts +3 -10
- package/dist/types/operations/businesses.d.ts +29 -30
- package/dist/types/operations/change-sets.d.ts +6 -6
- package/dist/types/operations/consumers.d.ts +13 -13
- package/dist/types/operations/define.d.ts +13 -3
- package/dist/types/operations/environments.d.ts +5 -4
- package/dist/types/operations/frontend.d.ts +2 -2
- package/dist/types/operations/index.d.ts +307 -220
- package/dist/types/operations/maker-tokens.d.ts +9 -9
- package/dist/types/operations/organizations.d.ts +19 -31
- package/dist/types/operations/personas.d.ts +8 -8
- package/dist/types/operations/plans-usage.d.ts +3 -3
- package/dist/types/operations/platform.d.ts +18 -18
- package/dist/types/operations/portal.d.ts +11 -11
- package/dist/types/operations/promo-codes.d.ts +15 -5
- package/dist/types/operations/variables.d.ts +22 -8
- package/dist/types/operations/webhooks.d.ts +107 -14
- package/dist/types/surface-types.d.ts +16 -10
- package/dist/types/types.d.ts +4 -1
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
|
@@ -261,14 +261,6 @@ export interface FartherShoreApi {
|
|
|
261
261
|
};
|
|
262
262
|
readonly billing: {
|
|
263
263
|
readonly stripe: {
|
|
264
|
-
/**
|
|
265
|
-
* Remove a business's per-business Stripe override so it bills through the org default again
|
|
266
|
-
*
|
|
267
|
-
* Remove a business's per-business Stripe Connect override so it bills through the organization default again. Refused while any subscription is still money-bearing. Destructive live-state operation; it does not edit repo-authored business behavior.
|
|
268
|
-
*
|
|
269
|
-
* Operation `stripe_connection.delete` · write · requires `stripe_connection:delete` · destructive · reconcile an unknown outcome with `stripe_connection.read`.
|
|
270
|
-
*/
|
|
271
|
-
readonly delete: Method<"billing.stripe.delete">;
|
|
272
264
|
/**
|
|
273
265
|
* Show the Stripe connection a business bills through (business override or org default)
|
|
274
266
|
*
|
|
@@ -396,14 +388,6 @@ export interface FartherShoreApi {
|
|
|
396
388
|
* Operation `business.create` · write · requires `business:create` · reconcile an unknown outcome with `business.list`.
|
|
397
389
|
*/
|
|
398
390
|
readonly create: Method<"businesses.create">;
|
|
399
|
-
/**
|
|
400
|
-
* Permanently delete a business (stage only)
|
|
401
|
-
*
|
|
402
|
-
* (stage only) Permanently delete a business. Requires --yes. Registered only in the stage channel (`make cli-stage`); production businesses are deleted from the dashboard.
|
|
403
|
-
*
|
|
404
|
-
* Operation `business.delete` · write · requires `business:delete` · destructive · reconcile an unknown outcome with `business.list`.
|
|
405
|
-
*/
|
|
406
|
-
readonly delete: Method<"businesses.delete">;
|
|
407
391
|
readonly docs: {
|
|
408
392
|
/**
|
|
409
393
|
* Disable docs for a business (stop publishing/serving docs; scaffold kept in the repo)
|
|
@@ -499,7 +483,9 @@ export interface FartherShoreApi {
|
|
|
499
483
|
*/
|
|
500
484
|
readonly read: Method<"businesses.read">;
|
|
501
485
|
/**
|
|
502
|
-
* Roll back a prior business publish
|
|
486
|
+
* Roll back a prior business publish
|
|
487
|
+
*
|
|
488
|
+
* Roll back a prior business publish. Pass the prior publish id as publishId; the receipt returns rollbackPublishId for the new rollback.
|
|
503
489
|
*
|
|
504
490
|
* Operation `business.rollback` · write · requires `business:rollback` · destructive · reconcile an unknown outcome with `business.status`.
|
|
505
491
|
*/
|
|
@@ -695,7 +681,7 @@ export interface FartherShoreApi {
|
|
|
695
681
|
/**
|
|
696
682
|
* Create a preview environment bound to a git branch
|
|
697
683
|
*
|
|
698
|
-
* Create a preview environment
|
|
684
|
+
* Create a preview environment from its env/NAME branch. The environment name is derived from the branch; names are lowercase slugs of at most 63 characters.
|
|
699
685
|
*
|
|
700
686
|
* Operation `environment.create` · write · requires `environment:create` · reconcile an unknown outcome with `environment.read`.
|
|
701
687
|
*/
|
|
@@ -842,12 +828,6 @@ export interface FartherShoreApi {
|
|
|
842
828
|
* Operation `organization.create` · write · requires `organization:create` · reconcile an unknown outcome with `organization.list`.
|
|
843
829
|
*/
|
|
844
830
|
readonly create: Method<"organizations.create">;
|
|
845
|
-
/**
|
|
846
|
-
* Delete an organization and its managed state
|
|
847
|
-
*
|
|
848
|
-
* Operation `organization.delete` · write · requires `organization:delete` · destructive · reconcile an unknown outcome with `organization.list`.
|
|
849
|
-
*/
|
|
850
|
-
readonly delete: Method<"organizations.delete">;
|
|
851
831
|
readonly invitation: {
|
|
852
832
|
/**
|
|
853
833
|
* Accept an organization invitation
|
|
@@ -916,16 +896,6 @@ export interface FartherShoreApi {
|
|
|
916
896
|
*/
|
|
917
897
|
readonly read: Method<"organizations.overview.read">;
|
|
918
898
|
};
|
|
919
|
-
readonly ownership: {
|
|
920
|
-
/**
|
|
921
|
-
* Transfer primary ownership of a team or company organization to another member
|
|
922
|
-
*
|
|
923
|
-
* Transfer primary ownership of a team or company organization to another existing member. Destructive and irreversible for the caller; requires the signed-in owner's session.
|
|
924
|
-
*
|
|
925
|
-
* Operation `organization.ownership.transfer` · write · requires `organization:ownership_transfer` · destructive · reconcile an unknown outcome with `organization.overview.read`.
|
|
926
|
-
*/
|
|
927
|
-
readonly transfer: Method<"organizations.ownership.transfer">;
|
|
928
|
-
};
|
|
929
899
|
readonly role: {
|
|
930
900
|
/**
|
|
931
901
|
* Create a custom organization role
|
|
@@ -1263,7 +1233,7 @@ export interface FartherShoreApi {
|
|
|
1263
1233
|
/**
|
|
1264
1234
|
* List variables: FS_PUBLIC_* values, secret metadata only
|
|
1265
1235
|
*
|
|
1266
|
-
* Lists variables. Returns readable FS_PUBLIC_* values; every other variable is a write-only secret and only its lifecycle metadata is returned.
|
|
1236
|
+
* Lists variables. Returns readable FS_PUBLIC_* values; every other variable is a write-only secret and only its lifecycle metadata is returned. Each entry includes its business or environment scope and source environmentId.
|
|
1267
1237
|
*
|
|
1268
1238
|
* Operation `business_variable.read` · read · requires `business_variable:read`.
|
|
1269
1239
|
*/
|
|
@@ -1309,10 +1279,20 @@ export interface FartherShoreApi {
|
|
|
1309
1279
|
* Operation `webhook.delivery.read` · read · requires `webhook:delivery_read`.
|
|
1310
1280
|
*/
|
|
1311
1281
|
readonly get: Method<"webhooks.delivery.get">;
|
|
1282
|
+
readonly payload: {
|
|
1283
|
+
/**
|
|
1284
|
+
* Read a webhook delivery payload and response
|
|
1285
|
+
*
|
|
1286
|
+
* Read the exact webhook event envelope and the last response diagnostic. Requires webhook:delivery_payload_read, available to owner and admin user sessions only. Response diagnostics are capped at 4096 characters; unreachable endpoints get a plain-language reason that never names a host or IP.
|
|
1287
|
+
*
|
|
1288
|
+
* Operation `webhook.delivery.payload.read` · read · requires `webhook:delivery_payload_read`.
|
|
1289
|
+
*/
|
|
1290
|
+
readonly read: Method<"webhooks.delivery.payload.read">;
|
|
1291
|
+
};
|
|
1312
1292
|
/**
|
|
1313
1293
|
* List recent delivery attempts for a webhook endpoint
|
|
1314
1294
|
*
|
|
1315
|
-
* List recent delivery attempts for a webhook endpoint.
|
|
1295
|
+
* List recent delivery attempts for a webhook endpoint. Lists omit payloads and response bodies. Single-delivery reads include them only with webhook:delivery_payload_read.
|
|
1316
1296
|
*
|
|
1317
1297
|
* Operation `webhook.delivery.read` · read · requires `webhook:delivery_read` · offset pagination.
|
|
1318
1298
|
*/
|
|
@@ -1337,9 +1317,9 @@ export interface FartherShoreApi {
|
|
|
1337
1317
|
*/
|
|
1338
1318
|
readonly read: Method<"webhooks.read">;
|
|
1339
1319
|
/**
|
|
1340
|
-
* Issue a new signing secret (returned once);
|
|
1320
|
+
* Issue a new signing secret (returned once); readable old secrets verify for 24h
|
|
1341
1321
|
*
|
|
1342
|
-
* Issue a replacement signing secret for a webhook endpoint. Returns the new secret once
|
|
1322
|
+
* Issue a replacement signing secret for a webhook endpoint. Returns the new secret once. When the old secret is readable, deliveries carry both signatures for 24 hours. Repairing an unreadable old secret drops it immediately and returns previousSecretExpiresAt: null; install the new secret before deliveries can verify.
|
|
1343
1323
|
*
|
|
1344
1324
|
* Operation `webhook.rotate_secret` · write · requires `webhook:update` · destructive · returns a one-time secret · reconcile an unknown outcome with `webhook.read`.
|
|
1345
1325
|
*/
|
|
@@ -73,6 +73,10 @@ export declare function isExchangeCredential(rawToken: string): boolean;
|
|
|
73
73
|
* A CLI login (`fscli_…`, user-bound) or a maker token (`mk_…`,
|
|
74
74
|
* organization-bound), exchanged for a short-lived access token before use
|
|
75
75
|
* and re-exchanged ahead of its expiry or after a 401. Any other token is
|
|
76
|
-
* sent as is
|
|
76
|
+
* sent as is — unless `oauth` says it is an OAuth access token from the
|
|
77
|
+
* platform's sign-in: that exchanges too, and like a CLI login it is
|
|
78
|
+
* user-bound (organization from the context, else the user's last active).
|
|
77
79
|
*/
|
|
78
|
-
export declare function cliExchangeCredentials(rawToken: string
|
|
80
|
+
export declare function cliExchangeCredentials(rawToken: string, options?: {
|
|
81
|
+
oauth?: boolean;
|
|
82
|
+
}): CredentialSource;
|
package/dist/types/envelope.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ export type ErrorEnvelope = {
|
|
|
14
14
|
param?: string;
|
|
15
15
|
retryable?: boolean;
|
|
16
16
|
retryDisposition?: RetryDisposition;
|
|
17
|
+
/** The id the server logged the request under (a support reference). */
|
|
18
|
+
requestId?: string;
|
|
17
19
|
};
|
|
18
20
|
/** The server's retry verdict on a failed request. */
|
|
19
21
|
export type RetrySignal = {
|
package/dist/types/errors.d.ts
CHANGED
|
@@ -18,6 +18,11 @@ export type FartherShoreErrorOptions = {
|
|
|
18
18
|
cause?: unknown;
|
|
19
19
|
/** Response headers of the HTTP answer that failed, when one arrived. */
|
|
20
20
|
headers?: Headers;
|
|
21
|
+
/**
|
|
22
|
+
* The id the server logged the failed request under (the envelope's
|
|
23
|
+
* `error.requestId`). Defaults to a valid `x-request-id` response header.
|
|
24
|
+
*/
|
|
25
|
+
requestId?: string;
|
|
21
26
|
};
|
|
22
27
|
/** The plain-data form of a {@link FartherShoreError} (`toJSON()`). */
|
|
23
28
|
export type FartherShoreErrorJSON = {
|
|
@@ -31,6 +36,8 @@ export type FartherShoreErrorJSON = {
|
|
|
31
36
|
retryable?: boolean;
|
|
32
37
|
retryDisposition?: RetryDisposition;
|
|
33
38
|
outcomeUnknown?: boolean;
|
|
39
|
+
/** The server's reference for the failed request, when it gave one. */
|
|
40
|
+
requestId?: string;
|
|
34
41
|
};
|
|
35
42
|
/**
|
|
36
43
|
* Every failure the client reports. Carries the canonical `code` from the
|
|
@@ -64,6 +71,12 @@ export declare class FartherShoreError extends Error {
|
|
|
64
71
|
* so spreading or serializing an error never copies them.
|
|
65
72
|
*/
|
|
66
73
|
readonly headers?: Headers;
|
|
74
|
+
/**
|
|
75
|
+
* The id the server logged the failed request under — quote it when
|
|
76
|
+
* reporting the failure. From the error envelope, else a valid
|
|
77
|
+
* `x-request-id` response header; absent when no answer arrived.
|
|
78
|
+
*/
|
|
79
|
+
readonly requestId?: string;
|
|
67
80
|
constructor(message: string, status?: number | undefined, extra?: FartherShoreErrorOptions);
|
|
68
81
|
/** Plain data (no `cause`, no stack) — safe to serialize and log. */
|
|
69
82
|
toJSON(): FartherShoreErrorJSON;
|
|
@@ -31,23 +31,19 @@ export interface components {
|
|
|
31
31
|
display: string;
|
|
32
32
|
unit?: string;
|
|
33
33
|
routeDefault?: number;
|
|
34
|
-
/**
|
|
35
|
-
* @default estimated_then_settled
|
|
36
|
-
* @enum {string}
|
|
37
|
-
*/
|
|
34
|
+
/** @enum {string} */
|
|
38
35
|
enforcementType: "exact_pre_request" | "estimated_then_settled" | "postpaid" | "strict_concurrency";
|
|
39
36
|
/**
|
|
40
37
|
* @default COUNT
|
|
41
38
|
* @enum {string}
|
|
42
39
|
*/
|
|
43
|
-
aggregation: "SUM" | "COUNT" | "
|
|
40
|
+
aggregation: "SUM" | "COUNT" | "LATEST";
|
|
44
41
|
/**
|
|
45
42
|
* @default billing_period
|
|
46
43
|
* @enum {string}
|
|
47
44
|
*/
|
|
48
45
|
window: "minute" | "hour" | "day" | "month" | "billing_period";
|
|
49
46
|
valueProperty?: string;
|
|
50
|
-
uniqueProperty?: string;
|
|
51
47
|
groupBy?: string[];
|
|
52
48
|
eventCode?: string;
|
|
53
49
|
/** @enum {string} */
|
|
@@ -84,8 +80,11 @@ export interface components {
|
|
|
84
80
|
* }
|
|
85
81
|
*/
|
|
86
82
|
verification: {
|
|
87
|
-
/**
|
|
88
|
-
|
|
83
|
+
/**
|
|
84
|
+
* @default true
|
|
85
|
+
* @constant
|
|
86
|
+
*/
|
|
87
|
+
required: true;
|
|
89
88
|
};
|
|
90
89
|
meters?: string[];
|
|
91
90
|
default?: boolean;
|
|
@@ -287,13 +286,9 @@ export interface components {
|
|
|
287
286
|
};
|
|
288
287
|
};
|
|
289
288
|
customer_context?: {
|
|
290
|
-
context_tokens?: {
|
|
291
|
-
/** @default true */
|
|
292
|
-
enabled: boolean;
|
|
293
|
-
};
|
|
294
289
|
portal_auth?: {
|
|
295
290
|
/** @enum {string} */
|
|
296
|
-
strategy: "
|
|
291
|
+
strategy: "hosted" | "test-personas";
|
|
297
292
|
};
|
|
298
293
|
};
|
|
299
294
|
frontend?: never;
|
|
@@ -629,7 +624,6 @@ export interface components {
|
|
|
629
624
|
callCaps?: {
|
|
630
625
|
search?: number;
|
|
631
626
|
fetch?: number;
|
|
632
|
-
dataforseo?: number;
|
|
633
627
|
};
|
|
634
628
|
};
|
|
635
629
|
AgentLaunch: {
|
|
@@ -790,7 +784,7 @@ export interface components {
|
|
|
790
784
|
AnalyticsEventFeedRow: {
|
|
791
785
|
id: string;
|
|
792
786
|
/** @enum {string} */
|
|
793
|
-
type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "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";
|
|
787
|
+
type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "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";
|
|
794
788
|
/** Format: date-time */
|
|
795
789
|
occurredAt: string;
|
|
796
790
|
environmentId: string | null;
|
|
@@ -990,7 +984,7 @@ export interface components {
|
|
|
990
984
|
name: string;
|
|
991
985
|
trigger: {
|
|
992
986
|
/** @enum {string} */
|
|
993
|
-
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "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";
|
|
987
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "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";
|
|
994
988
|
filter?: {
|
|
995
989
|
subjectType?: string;
|
|
996
990
|
subjectId?: string;
|
|
@@ -1064,7 +1058,6 @@ export interface components {
|
|
|
1064
1058
|
transportMode: "direct" | "tunnel";
|
|
1065
1059
|
runner: ("embedded" | "sidecar") | null;
|
|
1066
1060
|
runtime: string | null;
|
|
1067
|
-
verificationRequired: boolean;
|
|
1068
1061
|
originUrl: string | null;
|
|
1069
1062
|
isDefault: boolean;
|
|
1070
1063
|
/** @enum {string} */
|
|
@@ -1099,7 +1092,6 @@ export interface components {
|
|
|
1099
1092
|
transportMode: "direct" | "tunnel";
|
|
1100
1093
|
runner: ("embedded" | "sidecar") | null;
|
|
1101
1094
|
runtime: string | null;
|
|
1102
|
-
verificationRequired: boolean;
|
|
1103
1095
|
originUrl: string | null;
|
|
1104
1096
|
isDefault: boolean;
|
|
1105
1097
|
/** @enum {string} */
|
|
@@ -1143,7 +1135,7 @@ export interface components {
|
|
|
1143
1135
|
organization: components["schemas"]["BuilderContextOrganization"];
|
|
1144
1136
|
role: string;
|
|
1145
1137
|
}[];
|
|
1146
|
-
effectivePermissions: ("agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:create" | "stripe_connection:delete" | "stripe_connection:read" | "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")[];
|
|
1138
|
+
effectivePermissions: ("agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:delete" | "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")[];
|
|
1147
1139
|
shouldPersistActiveOrganization: boolean;
|
|
1148
1140
|
platformTier: string | null;
|
|
1149
1141
|
features: {
|
|
@@ -1477,6 +1469,7 @@ export interface components {
|
|
|
1477
1469
|
runtimeHostname: string;
|
|
1478
1470
|
portalHostname: string | null;
|
|
1479
1471
|
status: string;
|
|
1472
|
+
secretInheritanceUnavailableReason?: string | null;
|
|
1480
1473
|
};
|
|
1481
1474
|
BusinessEnvironmentCreateResponse: {
|
|
1482
1475
|
id: string;
|
|
@@ -1486,6 +1479,7 @@ export interface components {
|
|
|
1486
1479
|
runtimeHostname: string;
|
|
1487
1480
|
portalHostname: string | null;
|
|
1488
1481
|
status: string;
|
|
1482
|
+
secretInheritanceUnavailableReason?: string | null;
|
|
1489
1483
|
created: boolean;
|
|
1490
1484
|
branchCreated: boolean;
|
|
1491
1485
|
};
|
|
@@ -1689,6 +1683,12 @@ export interface components {
|
|
|
1689
1683
|
BusinessVariable: {
|
|
1690
1684
|
name: string;
|
|
1691
1685
|
/** @enum {string} */
|
|
1686
|
+
scope: "business-wide" | "environment" | "production-only" | "inherited";
|
|
1687
|
+
environmentId: string | null;
|
|
1688
|
+
productionOnly: boolean;
|
|
1689
|
+
inheritedFrom: "main" | null;
|
|
1690
|
+
unavailableReason: string | null;
|
|
1691
|
+
/** @enum {string} */
|
|
1692
1692
|
visibility: "public" | "secret";
|
|
1693
1693
|
value: string | null;
|
|
1694
1694
|
hasValue: boolean;
|
|
@@ -1904,7 +1904,7 @@ export interface components {
|
|
|
1904
1904
|
/** Format: date-time */
|
|
1905
1905
|
expiresAt: string;
|
|
1906
1906
|
/** @enum {string} */
|
|
1907
|
-
credentialType: "maker_token" | "cli_session";
|
|
1907
|
+
credentialType: "maker_token" | "cli_session" | "oauth";
|
|
1908
1908
|
userId?: string;
|
|
1909
1909
|
organizationId: string;
|
|
1910
1910
|
};
|
|
@@ -2355,7 +2355,7 @@ export interface components {
|
|
|
2355
2355
|
updatedAt: string;
|
|
2356
2356
|
};
|
|
2357
2357
|
/** @enum {string} */
|
|
2358
|
-
MakerDelegablePermission: "agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:
|
|
2358
|
+
MakerDelegablePermission: "agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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";
|
|
2359
2359
|
MakerTokenBusinessScopeSummary: {
|
|
2360
2360
|
/** @constant */
|
|
2361
2361
|
mode: "ALL";
|
|
@@ -2434,6 +2434,16 @@ export interface components {
|
|
|
2434
2434
|
data: components["schemas"]["Business"][];
|
|
2435
2435
|
total: number;
|
|
2436
2436
|
};
|
|
2437
|
+
ManagementRollbackRequest: {
|
|
2438
|
+
publishId: string;
|
|
2439
|
+
reason?: string;
|
|
2440
|
+
};
|
|
2441
|
+
ManagementRollbackResponse: {
|
|
2442
|
+
businessId: string;
|
|
2443
|
+
/** @constant */
|
|
2444
|
+
status: "enqueued";
|
|
2445
|
+
rollbackPublishId: string;
|
|
2446
|
+
};
|
|
2437
2447
|
ManagementUsageLimit: {
|
|
2438
2448
|
id: string;
|
|
2439
2449
|
subscriberId: string;
|
|
@@ -2483,7 +2493,7 @@ export interface components {
|
|
|
2483
2493
|
credentialType: "maker_token";
|
|
2484
2494
|
tokenId: string;
|
|
2485
2495
|
organizationId: string;
|
|
2486
|
-
grantedPermissions: ("agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:create" | "stripe_connection:delete" | "stripe_connection:read" | "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")[];
|
|
2496
|
+
grantedPermissions: ("agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:delete" | "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")[];
|
|
2487
2497
|
/** @enum {string} */
|
|
2488
2498
|
businessScopeMode: "ALL" | "SELECTED";
|
|
2489
2499
|
selectedBusinessIds: string[];
|
|
@@ -2688,7 +2698,7 @@ export interface components {
|
|
|
2688
2698
|
unit: string;
|
|
2689
2699
|
periodLabel: string;
|
|
2690
2700
|
} | null;
|
|
2691
|
-
|
|
2701
|
+
billingConnected: boolean;
|
|
2692
2702
|
};
|
|
2693
2703
|
businesses: components["schemas"]["OrganizationOverviewBusiness"][];
|
|
2694
2704
|
recentActivity: components["schemas"]["OrganizationOverviewActivity"][];
|
|
@@ -2837,7 +2847,7 @@ export interface components {
|
|
|
2837
2847
|
unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
|
|
2838
2848
|
};
|
|
2839
2849
|
/** @enum {string} */
|
|
2840
|
-
PlatformPermission: "agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:create" | "stripe_connection:delete" | "stripe_connection:read" | "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";
|
|
2850
|
+
PlatformPermission: "agent:configure" | "agent:read" | "agreement:amend" | "agreement:create" | "agreement: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" | "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:rollback" | "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:delete" | "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";
|
|
2841
2851
|
PortalOffsetPagination: {
|
|
2842
2852
|
limit: number;
|
|
2843
2853
|
offset: number;
|
|
@@ -3177,6 +3187,7 @@ export interface components {
|
|
|
3177
3187
|
};
|
|
3178
3188
|
PromoCode: {
|
|
3179
3189
|
id: string;
|
|
3190
|
+
unreadable: boolean;
|
|
3180
3191
|
code: string;
|
|
3181
3192
|
kind: ("percent_off" | "amount_off" | "free_months") | null;
|
|
3182
3193
|
amount: number | null;
|
|
@@ -3582,7 +3593,37 @@ export interface components {
|
|
|
3582
3593
|
};
|
|
3583
3594
|
};
|
|
3584
3595
|
WebhookDeliveryResponse: {
|
|
3585
|
-
data:
|
|
3596
|
+
data: {
|
|
3597
|
+
id: string;
|
|
3598
|
+
eventType: string;
|
|
3599
|
+
/**
|
|
3600
|
+
* @description pending: queued or being sent. success: the endpoint answered 2xx. failed: the last attempt failed; another is scheduled at nextAttemptAt, and when nextAttemptAt is null (a test send) nothing further is attempted. dead: every attempt failed; it will not be retried.
|
|
3601
|
+
* @enum {string}
|
|
3602
|
+
*/
|
|
3603
|
+
status: "pending" | "success" | "failed" | "dead";
|
|
3604
|
+
attempts: number;
|
|
3605
|
+
lastAttemptAt: string | null;
|
|
3606
|
+
/** @description When the next attempt is scheduled. Null when no further attempt will be made (a success, a dead delivery, or a failed test send). */
|
|
3607
|
+
nextAttemptAt: string | null;
|
|
3608
|
+
responseStatus: number | null;
|
|
3609
|
+
environmentId: string | null;
|
|
3610
|
+
/** Format: date-time */
|
|
3611
|
+
createdAt: string;
|
|
3612
|
+
/** @description The exact event envelope sent to the endpoint. Requires webhook:delivery_payload_read. */
|
|
3613
|
+
payload?: {
|
|
3614
|
+
id: string;
|
|
3615
|
+
type: string;
|
|
3616
|
+
/** Format: date-time */
|
|
3617
|
+
createdAt: string;
|
|
3618
|
+
businessId: string;
|
|
3619
|
+
environmentId: string | null;
|
|
3620
|
+
data: {
|
|
3621
|
+
[key: string]: unknown;
|
|
3622
|
+
};
|
|
3623
|
+
};
|
|
3624
|
+
/** @description The last response diagnostic, capped at 4096 characters. When no HTTP response was received, a plain-language reason that never names a host or IP. Requires webhook:delivery_payload_read. */
|
|
3625
|
+
responseBody?: string | null;
|
|
3626
|
+
};
|
|
3586
3627
|
};
|
|
3587
3628
|
WebhookEndpoint: {
|
|
3588
3629
|
id: string;
|
|
@@ -3590,6 +3631,7 @@ export interface components {
|
|
|
3590
3631
|
environmentId: string | null;
|
|
3591
3632
|
events: string[];
|
|
3592
3633
|
enabled: boolean;
|
|
3634
|
+
signingSecretActionRequired: boolean;
|
|
3593
3635
|
failCount: number;
|
|
3594
3636
|
disabledAt: string | null;
|
|
3595
3637
|
/** Format: date-time */
|
|
@@ -3612,6 +3654,7 @@ export interface components {
|
|
|
3612
3654
|
environmentId: string | null;
|
|
3613
3655
|
events: string[];
|
|
3614
3656
|
enabled: boolean;
|
|
3657
|
+
signingSecretActionRequired: boolean;
|
|
3615
3658
|
failCount: number;
|
|
3616
3659
|
disabledAt: string | null;
|
|
3617
3660
|
/** Format: date-time */
|
|
@@ -3638,6 +3681,7 @@ export interface components {
|
|
|
3638
3681
|
environmentId: string | null;
|
|
3639
3682
|
events: string[];
|
|
3640
3683
|
enabled: boolean;
|
|
3684
|
+
signingSecretActionRequired: boolean;
|
|
3641
3685
|
failCount: number;
|
|
3642
3686
|
disabledAt: string | null;
|
|
3643
3687
|
/** Format: date-time */
|
|
@@ -3645,8 +3689,7 @@ export interface components {
|
|
|
3645
3689
|
/** Format: date-time */
|
|
3646
3690
|
updatedAt: string;
|
|
3647
3691
|
secret: string;
|
|
3648
|
-
|
|
3649
|
-
previousSecretExpiresAt: string;
|
|
3692
|
+
previousSecretExpiresAt: string | null;
|
|
3650
3693
|
};
|
|
3651
3694
|
WebhookEndpointUpdateResponse: {
|
|
3652
3695
|
data: components["schemas"]["WebhookEndpoint"];
|
|
@@ -3655,7 +3698,7 @@ export interface components {
|
|
|
3655
3698
|
data: {
|
|
3656
3699
|
events: {
|
|
3657
3700
|
/** @enum {string} */
|
|
3658
|
-
name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
3701
|
+
name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed";
|
|
3659
3702
|
description: string;
|
|
3660
3703
|
}[];
|
|
3661
3704
|
};
|
|
@@ -65,7 +65,7 @@ export declare function listAllEnvironments(source: EnvironmentListSource, busin
|
|
|
65
65
|
export declare function resolveBusiness(source: BusinessListSource, ref: string, options?: LookupOptions): Promise<string>;
|
|
66
66
|
/** Resolve an environment name (case-insensitive) or id to its row. */
|
|
67
67
|
export declare function resolveEnvironment(source: EnvironmentListSource, businessId: string, ref: string, options?: LookupOptions): Promise<EnvironmentSummary>;
|
|
68
|
-
/** Reference
|
|
68
|
+
/** Reference lookups bound to one client. */
|
|
69
69
|
export type Refs = {
|
|
70
70
|
/** A business id, slug, name or hostname → the business id. */
|
|
71
71
|
business(slugOrId: string, options?: LookupOptions): Promise<string>;
|
|
@@ -73,7 +73,7 @@ export type Refs = {
|
|
|
73
73
|
environment(businessId: string, nameOrId: string, options?: LookupOptions): Promise<EnvironmentSummary>;
|
|
74
74
|
};
|
|
75
75
|
/**
|
|
76
|
-
* Bind the
|
|
76
|
+
* Bind the lookups to a client:
|
|
77
77
|
*
|
|
78
78
|
* ```ts
|
|
79
79
|
* const refs = createRefs(fs);
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { createFartherShore, listOperations, DRY_RUN_NOT_SUPPORTED, UNKNOWN_OPERATION, } from "./surface.js";
|
|
2
2
|
export type { CreateFartherShoreOptions, FartherShore } from "./surface.js";
|
|
3
3
|
export type { FartherShoreApi } from "./api.generated.js";
|
|
4
|
-
export type { DerivedApi, DryRunPreview, Method, MethodInput, MethodOutput, OperationMeta, } from "./surface-types.js";
|
|
4
|
+
export type { DerivedApi, DryRunPreview, Method, MethodInput, MethodOutput, MethodPreviewOutput, OperationMeta, } from "./surface-types.js";
|
|
5
5
|
export type { CallOptions, ListQuery, RequestBody, } from "./operations/define.js";
|
|
6
6
|
export type { MethodPath } from "./operations/index.js";
|
|
7
7
|
export * from "./types.js";
|
|
@@ -12,7 +12,7 @@ export declare const agentOperations: {
|
|
|
12
12
|
}, {
|
|
13
13
|
agents: import("../generated/schemas.js").components["schemas"]["Agent"][];
|
|
14
14
|
availableRoles: string[];
|
|
15
|
-
}>;
|
|
15
|
+
}, false>;
|
|
16
16
|
"agents.status": import("./define.js").OperationEntry<AgentRef, {
|
|
17
17
|
id: string;
|
|
18
18
|
role: string;
|
|
@@ -43,7 +43,7 @@ export declare const agentOperations: {
|
|
|
43
43
|
actionsCount: number;
|
|
44
44
|
};
|
|
45
45
|
catalog: import("../generated/schemas.js").components["schemas"]["AgentCatalogEntry"][];
|
|
46
|
-
}>;
|
|
46
|
+
}, false>;
|
|
47
47
|
"agents.runs.show": import("./define.js").OperationEntry<BusinessRef & {
|
|
48
48
|
role: string;
|
|
49
49
|
} & {
|
|
@@ -88,7 +88,7 @@ export declare const agentOperations: {
|
|
|
88
88
|
};
|
|
89
89
|
launches: import("../generated/schemas.js").components["schemas"]["AgentLaunch"][];
|
|
90
90
|
actions: import("../generated/schemas.js").components["schemas"]["AgentAction"][];
|
|
91
|
-
}>;
|
|
91
|
+
}, false>;
|
|
92
92
|
"agents.enable": import("./define.js").OperationEntry<BusinessRef & {
|
|
93
93
|
role: string;
|
|
94
94
|
} & {
|
|
@@ -109,7 +109,7 @@ export declare const agentOperations: {
|
|
|
109
109
|
lastRunAt: string | null;
|
|
110
110
|
createdAt: string;
|
|
111
111
|
updatedAt: string;
|
|
112
|
-
}>;
|
|
112
|
+
}, false>;
|
|
113
113
|
"agents.disable": import("./define.js").OperationEntry<BusinessRef & {
|
|
114
114
|
role: string;
|
|
115
115
|
} & {
|
|
@@ -130,7 +130,7 @@ export declare const agentOperations: {
|
|
|
130
130
|
lastRunAt: string | null;
|
|
131
131
|
createdAt: string;
|
|
132
132
|
updatedAt: string;
|
|
133
|
-
}>;
|
|
133
|
+
}, false>;
|
|
134
134
|
"bulletin.list": import("./define.js").OperationEntry<BusinessRef & {
|
|
135
135
|
kind?: string;
|
|
136
136
|
status?: string;
|
|
@@ -142,7 +142,7 @@ export declare const agentOperations: {
|
|
|
142
142
|
}, {
|
|
143
143
|
items: import("../generated/schemas.js").components["schemas"]["BulletinPost"][];
|
|
144
144
|
nextCursor: string | null;
|
|
145
|
-
}>;
|
|
145
|
+
}, false>;
|
|
146
146
|
"bulletin.read": import("./define.js").OperationEntry<BusinessRef & {
|
|
147
147
|
postId: string;
|
|
148
148
|
}, {
|
|
@@ -173,7 +173,7 @@ export declare const agentOperations: {
|
|
|
173
173
|
changeSetId: string | null;
|
|
174
174
|
createdAt: string;
|
|
175
175
|
updatedAt: string;
|
|
176
|
-
}>;
|
|
176
|
+
}, false>;
|
|
177
177
|
"bulletin.ack": import("./define.js").OperationEntry<BusinessRef & {
|
|
178
178
|
postId: string;
|
|
179
179
|
}, {
|
|
@@ -204,7 +204,7 @@ export declare const agentOperations: {
|
|
|
204
204
|
changeSetId: string | null;
|
|
205
205
|
createdAt: string;
|
|
206
206
|
updatedAt: string;
|
|
207
|
-
}>;
|
|
207
|
+
}, false>;
|
|
208
208
|
"bulletin.resolve": import("./define.js").OperationEntry<BusinessRef & {
|
|
209
209
|
postId: string;
|
|
210
210
|
}, {
|
|
@@ -235,6 +235,6 @@ export declare const agentOperations: {
|
|
|
235
235
|
changeSetId: string | null;
|
|
236
236
|
createdAt: string;
|
|
237
237
|
updatedAt: string;
|
|
238
|
-
}>;
|
|
238
|
+
}, false>;
|
|
239
239
|
};
|
|
240
240
|
export {};
|