@farthershore/client 0.3.0 → 0.4.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 +8 -0
- package/README.md +6 -0
- package/dist/index.js +74 -16
- package/dist/types/api.generated.d.ts +15 -5
- package/dist/types/envelope.d.ts +2 -0
- package/dist/types/errors.d.ts +13 -0
- package/dist/types/generated/schemas.d.ts +55 -17
- 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 +4 -4
- package/dist/types/operations/businesses.d.ts +25 -25
- 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 +6 -2
- 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 +298 -183
- package/dist/types/operations/maker-tokens.d.ts +9 -9
- package/dist/types/operations/organizations.d.ts +21 -21
- 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 +12 -12
- 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 +105 -12
- package/dist/types/surface-types.d.ts +16 -10
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,14 @@ All notable changes to the API client are documented here. This package
|
|
|
4
4
|
versions independently from the CLI and the other SDKs. Pre-1.0: minor versions
|
|
5
5
|
may include breaking changes.
|
|
6
6
|
|
|
7
|
+
## [0.4.0] - 2026-10-28
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- **Breaking:** `organizations.overview.read` → `OrganizationOverview.organization.stripeConnected`
|
|
12
|
+
is renamed **`billingConnected`** (generated `Schemas["OrganizationOverview"]`
|
|
13
|
+
too). Requires the matching platform release.
|
|
14
|
+
|
|
7
15
|
## [0.3.0] - 2026-10-14
|
|
8
16
|
|
|
9
17
|
### Added
|
package/README.md
CHANGED
|
@@ -54,6 +54,12 @@ Every operation is a method `fs.<namespace>.<method>(input, options?)`:
|
|
|
54
54
|
`DRY_RUN_NOT_SUPPORTED` before sending anything. `retry: "none"` makes a
|
|
55
55
|
single attempt.
|
|
56
56
|
|
|
57
|
+
On preview-capable methods, literal `{ dryRun: true }` resolves to
|
|
58
|
+
`DryRunPreview<W>` (`{ dryRun: true, wouldHave: W }`), while omitted options or
|
|
59
|
+
`{ dryRun: false }` resolve to the write result. A `CallOptions` variable
|
|
60
|
+
resolves to the union, so check `"dryRun" in result` before using the result.
|
|
61
|
+
`W` is the preview payload, which can differ from the write result.
|
|
62
|
+
|
|
57
63
|
The namespace path comes from the operation key (`runtime_token.revoke` →
|
|
58
64
|
`fs.runtimeTokens.revoke`). The namespaces:
|
|
59
65
|
|
package/dist/index.js
CHANGED
|
@@ -714,6 +714,12 @@ var PLATFORM_PERMISSION_CATALOG = {
|
|
|
714
714
|
defaultRoles: OWNER_ADMIN,
|
|
715
715
|
delegation: "maker_token"
|
|
716
716
|
}),
|
|
717
|
+
"webhook:delivery_payload_read": permission("webhook:delivery_payload_read", {
|
|
718
|
+
effect: "read",
|
|
719
|
+
allowedTargetKinds: BUSINESS,
|
|
720
|
+
defaultRoles: OWNER_ADMIN,
|
|
721
|
+
delegation: "user_session_only"
|
|
722
|
+
}),
|
|
717
723
|
"webhook:delivery_read": permission("webhook:delivery_read", {
|
|
718
724
|
effect: "read",
|
|
719
725
|
allowedTargetKinds: BUSINESS,
|
|
@@ -1056,6 +1062,11 @@ var PLATFORM_OPERATION_DEFINITIONS = [
|
|
|
1056
1062
|
{ key: "bulletin.read", class: "operate", domain: "agents" },
|
|
1057
1063
|
{ key: "bulletin.ack", class: "operate", domain: "agents" },
|
|
1058
1064
|
{ key: "bulletin.resolve", class: "operate", domain: "agents" },
|
|
1065
|
+
{
|
|
1066
|
+
key: "webhook.delivery.payload.read",
|
|
1067
|
+
class: "operate",
|
|
1068
|
+
domain: WEBHOOKS_DOMAIN
|
|
1069
|
+
},
|
|
1059
1070
|
{ key: "webhook.delivery.read", class: "operate", domain: WEBHOOKS_DOMAIN },
|
|
1060
1071
|
{ key: "promo_code.read", class: "operate", domain: PROMO_CODES_DOMAIN },
|
|
1061
1072
|
{ key: "promo_code.create", class: "operate", domain: PROMO_CODES_DOMAIN },
|
|
@@ -2050,6 +2061,10 @@ var AGENT_OPERATION_AUTHORIZATIONS = {
|
|
|
2050
2061
|
},
|
|
2051
2062
|
"webhook.create": { permission: "webhook:create", targetKind: "business" },
|
|
2052
2063
|
"webhook.delete": { permission: "webhook:delete", targetKind: "business" },
|
|
2064
|
+
"webhook.delivery.payload.read": {
|
|
2065
|
+
permission: "webhook:delivery_payload_read",
|
|
2066
|
+
targetKind: "business"
|
|
2067
|
+
},
|
|
2053
2068
|
"webhook.delivery.read": {
|
|
2054
2069
|
permission: "webhook:delivery_read",
|
|
2055
2070
|
targetKind: "business"
|
|
@@ -2477,7 +2492,7 @@ var SPECS = {
|
|
|
2477
2492
|
},
|
|
2478
2493
|
"environment.create": {
|
|
2479
2494
|
summary: "Create a preview environment bound to a git branch",
|
|
2480
|
-
description: "Create a preview environment
|
|
2495
|
+
description: "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.",
|
|
2481
2496
|
destructive: false,
|
|
2482
2497
|
oneTimeSecret: false,
|
|
2483
2498
|
preview: false,
|
|
@@ -2634,10 +2649,12 @@ var SPECS = {
|
|
|
2634
2649
|
// webhook list and delete it; deliveries need the id it never received.
|
|
2635
2650
|
reconcile: { op: "webhook.read" }
|
|
2636
2651
|
},
|
|
2637
|
-
// DECISION: NEITHER side → destructive (+ oneTimeSecret, already declared).
|
|
2652
|
+
// DECISION: NEITHER side → destructive (+ oneTimeSecret, already declared).
|
|
2653
|
+
// Rotation returns a new secret once. Readable retired secrets get a 24h
|
|
2654
|
+
// dual-sign window; unreadable ones are dropped immediately.
|
|
2638
2655
|
"webhook.rotate_secret": {
|
|
2639
|
-
summary: "Issue a new signing secret (returned once);
|
|
2640
|
-
description: "Issue a replacement signing secret for a webhook endpoint. Returns the new secret once
|
|
2656
|
+
summary: "Issue a new signing secret (returned once); readable old secrets verify for 24h",
|
|
2657
|
+
description: "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.",
|
|
2641
2658
|
destructive: true,
|
|
2642
2659
|
oneTimeSecret: true,
|
|
2643
2660
|
preview: false,
|
|
@@ -2650,9 +2667,16 @@ var SPECS = {
|
|
|
2650
2667
|
oneTimeSecret: false,
|
|
2651
2668
|
preview: false
|
|
2652
2669
|
},
|
|
2670
|
+
"webhook.delivery.payload.read": {
|
|
2671
|
+
summary: "Read a webhook delivery payload and response",
|
|
2672
|
+
description: "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.",
|
|
2673
|
+
destructive: false,
|
|
2674
|
+
oneTimeSecret: false,
|
|
2675
|
+
preview: false
|
|
2676
|
+
},
|
|
2653
2677
|
"webhook.delivery.read": {
|
|
2654
2678
|
summary: "List recent delivery attempts for a webhook endpoint",
|
|
2655
|
-
description: "List recent delivery attempts for a webhook endpoint.
|
|
2679
|
+
description: "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.",
|
|
2656
2680
|
destructive: false,
|
|
2657
2681
|
oneTimeSecret: false,
|
|
2658
2682
|
preview: false,
|
|
@@ -2850,7 +2874,7 @@ var SPECS = {
|
|
|
2850
2874
|
},
|
|
2851
2875
|
"business_variable.read": {
|
|
2852
2876
|
summary: "List variables: FS_PUBLIC_* values, secret metadata only",
|
|
2853
|
-
description: "Lists variables. Returns readable FS_PUBLIC_* values; every other variable is a write-only secret and only its lifecycle metadata is returned.",
|
|
2877
|
+
description: "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.",
|
|
2854
2878
|
destructive: false,
|
|
2855
2879
|
oneTimeSecret: false,
|
|
2856
2880
|
preview: false
|
|
@@ -3710,6 +3734,7 @@ var ERROR_CODES = {
|
|
|
3710
3734
|
ORGANIZATION_NOT_FOUND: "ORGANIZATION_NOT_FOUND",
|
|
3711
3735
|
ORG_HAS_ACTIVE_SUBSCRIPTIONS: "ORG_HAS_ACTIVE_SUBSCRIPTIONS",
|
|
3712
3736
|
ORGANIZATION_HAS_PAID_SUBSCRIBERS: "ORGANIZATION_HAS_PAID_SUBSCRIBERS",
|
|
3737
|
+
BILLING_AUTHORITY_RECONCILIATION_REQUIRED: "BILLING_AUTHORITY_RECONCILIATION_REQUIRED",
|
|
3713
3738
|
BUSINESS_HAS_PAID_SUBSCRIBERS: "BUSINESS_HAS_PAID_SUBSCRIBERS",
|
|
3714
3739
|
// PR-H: returned with HTTP 409 from DELETE /builder/organizations/:orgId
|
|
3715
3740
|
// (and the defense-in-depth Clerk-deletion guard) when the org still has
|
|
@@ -4003,7 +4028,7 @@ var RUNTIME_ERROR_CODE_TO_ERROR_CODE = {
|
|
|
4003
4028
|
var RUNTIME_ERROR_CODE_VALUES = Object.values(RUNTIME_ERROR_CODES);
|
|
4004
4029
|
function paidSubscriberDeletionMessage(code) {
|
|
4005
4030
|
if (code === ERROR_CODES.BUSINESS_HAS_PAID_SUBSCRIBERS) {
|
|
4006
|
-
return "Cancel or migrate
|
|
4031
|
+
return "Cancel or migrate paid subscriptions and resolve remaining purchased or promotional credit, including credit held by archived customers, before deleting this business.";
|
|
4007
4032
|
}
|
|
4008
4033
|
if (code === ERROR_CODES.ORGANIZATION_HAS_PAID_SUBSCRIBERS) {
|
|
4009
4034
|
return "Cancel or migrate the paid subscribers of every business in this organization before deleting it.";
|
|
@@ -4011,6 +4036,17 @@ function paidSubscriberDeletionMessage(code) {
|
|
|
4011
4036
|
return void 0;
|
|
4012
4037
|
}
|
|
4013
4038
|
|
|
4039
|
+
// ../contracts/dist/request-id.js
|
|
4040
|
+
var REQUEST_ID_HEADER = "x-request-id";
|
|
4041
|
+
var MAX_REQUEST_ID_LENGTH = 128;
|
|
4042
|
+
var REQUEST_ID_PATTERN = /^[A-Za-z0-9._:-]+$/;
|
|
4043
|
+
function isValidRequestId(value) {
|
|
4044
|
+
return typeof value === "string" && value.length > 0 && value.length <= MAX_REQUEST_ID_LENGTH && REQUEST_ID_PATTERN.test(value);
|
|
4045
|
+
}
|
|
4046
|
+
function adoptableRequestId(value) {
|
|
4047
|
+
return isValidRequestId(value) ? value : null;
|
|
4048
|
+
}
|
|
4049
|
+
|
|
4014
4050
|
// src/errors.ts
|
|
4015
4051
|
var FartherShoreError = class extends Error {
|
|
4016
4052
|
constructor(message, status, extra) {
|
|
@@ -4026,6 +4062,7 @@ var FartherShoreError = class extends Error {
|
|
|
4026
4062
|
this.retryable = extra?.retryable;
|
|
4027
4063
|
this.retryDisposition = extra?.retryDisposition;
|
|
4028
4064
|
this.outcomeUnknown = extra?.outcomeUnknown;
|
|
4065
|
+
this.requestId = adoptableRequestId(extra?.requestId) ?? adoptableRequestId(extra?.headers?.get?.(REQUEST_ID_HEADER)) ?? void 0;
|
|
4029
4066
|
if (extra?.headers !== void 0)
|
|
4030
4067
|
Object.defineProperty(this, "headers", {
|
|
4031
4068
|
value: extra.headers,
|
|
@@ -4048,6 +4085,12 @@ var FartherShoreError = class extends Error {
|
|
|
4048
4085
|
* the client never repeats such a write on its own.
|
|
4049
4086
|
*/
|
|
4050
4087
|
outcomeUnknown;
|
|
4088
|
+
/**
|
|
4089
|
+
* The id the server logged the failed request under — quote it when
|
|
4090
|
+
* reporting the failure. From the error envelope, else a valid
|
|
4091
|
+
* `x-request-id` response header; absent when no answer arrived.
|
|
4092
|
+
*/
|
|
4093
|
+
requestId;
|
|
4051
4094
|
/** Plain data (no `cause`, no stack) — safe to serialize and log. */
|
|
4052
4095
|
toJSON() {
|
|
4053
4096
|
const json = {
|
|
@@ -4063,6 +4106,7 @@ var FartherShoreError = class extends Error {
|
|
|
4063
4106
|
json.retryDisposition = this.retryDisposition;
|
|
4064
4107
|
if (this.outcomeUnknown !== void 0)
|
|
4065
4108
|
json.outcomeUnknown = this.outcomeUnknown;
|
|
4109
|
+
if (this.requestId !== void 0) json.requestId = this.requestId;
|
|
4066
4110
|
return json;
|
|
4067
4111
|
}
|
|
4068
4112
|
};
|
|
@@ -4083,7 +4127,10 @@ var FartherShoreTransportError = class extends FartherShoreError {
|
|
|
4083
4127
|
|
|
4084
4128
|
// src/operations/define.ts
|
|
4085
4129
|
function operation(entry) {
|
|
4086
|
-
return entry;
|
|
4130
|
+
return { ...entry, preview: false };
|
|
4131
|
+
}
|
|
4132
|
+
function previewOperation(entry) {
|
|
4133
|
+
return { ...entry, preview: true };
|
|
4087
4134
|
}
|
|
4088
4135
|
function seg(value) {
|
|
4089
4136
|
return encodeURIComponent(value);
|
|
@@ -4419,11 +4466,11 @@ var backendOperations = {
|
|
|
4419
4466
|
})
|
|
4420
4467
|
)
|
|
4421
4468
|
}),
|
|
4422
|
-
"backends.create":
|
|
4469
|
+
"backends.create": previewOperation({
|
|
4423
4470
|
op: "backend.create",
|
|
4424
4471
|
run: (ctx, { businessId, ...data }) => send(ctx, "POST", backends(businessId), data)
|
|
4425
4472
|
}),
|
|
4426
|
-
"backends.bind":
|
|
4473
|
+
"backends.bind": previewOperation({
|
|
4427
4474
|
op: "backend.bind",
|
|
4428
4475
|
run: (ctx, { businessId, backend, ...data }) => send(ctx, "PATCH", `${backends(businessId)}/${seg(backend)}`, data)
|
|
4429
4476
|
}),
|
|
@@ -4580,7 +4627,7 @@ var businessOperations = {
|
|
|
4580
4627
|
withQuery(`${business(businessId)}/deployments`, { env })
|
|
4581
4628
|
)
|
|
4582
4629
|
}),
|
|
4583
|
-
"businesses.publish":
|
|
4630
|
+
"businesses.publish": previewOperation({
|
|
4584
4631
|
op: "business.publish",
|
|
4585
4632
|
run: (ctx, { businessId, ...body }) => send(
|
|
4586
4633
|
ctx,
|
|
@@ -4696,7 +4743,7 @@ var changeSetOperations = {
|
|
|
4696
4743
|
return entry;
|
|
4697
4744
|
}
|
|
4698
4745
|
}),
|
|
4699
|
-
"changeSets.propose":
|
|
4746
|
+
"changeSets.propose": previewOperation({
|
|
4700
4747
|
op: "change_set.propose",
|
|
4701
4748
|
run: (ctx, { businessId, subscriberId, env, ...body }) => send(
|
|
4702
4749
|
ctx,
|
|
@@ -4870,7 +4917,7 @@ var frontendOperations = {
|
|
|
4870
4917
|
})
|
|
4871
4918
|
)
|
|
4872
4919
|
}),
|
|
4873
|
-
"frontend.rollback":
|
|
4920
|
+
"frontend.rollback": previewOperation({
|
|
4874
4921
|
op: "frontend.rollback",
|
|
4875
4922
|
run: (ctx, { businessId, ...data }) => send(
|
|
4876
4923
|
ctx,
|
|
@@ -5557,6 +5604,14 @@ var webhookOperations = {
|
|
|
5557
5604
|
"GET",
|
|
5558
5605
|
`${webhook(businessId, webhookId)}/deliveries/${seg(deliveryId)}`
|
|
5559
5606
|
)
|
|
5607
|
+
}),
|
|
5608
|
+
"webhooks.delivery.payload.read": operation({
|
|
5609
|
+
op: "webhook.delivery.payload.read",
|
|
5610
|
+
run: (ctx, { businessId, webhookId, deliveryId }) => send(
|
|
5611
|
+
ctx,
|
|
5612
|
+
"GET",
|
|
5613
|
+
`${webhook(businessId, webhookId)}/deliveries/${seg(deliveryId)}/payload`
|
|
5614
|
+
)
|
|
5560
5615
|
})
|
|
5561
5616
|
};
|
|
5562
5617
|
|
|
@@ -6118,6 +6173,7 @@ function errorEnvelopeOf(body) {
|
|
|
6118
6173
|
if (typeof raw.retryable === "boolean") envelope.retryable = raw.retryable;
|
|
6119
6174
|
if (raw.retryDisposition === "safe_to_repeat" || raw.retryDisposition === "reconcile_before_repeat")
|
|
6120
6175
|
envelope.retryDisposition = raw.retryDisposition;
|
|
6176
|
+
if (typeof raw.requestId === "string") envelope.requestId = raw.requestId;
|
|
6121
6177
|
return envelope;
|
|
6122
6178
|
}
|
|
6123
6179
|
function retrySignalOf(envelope) {
|
|
@@ -6143,7 +6199,7 @@ function diagnosticsOf(parsed) {
|
|
|
6143
6199
|
}
|
|
6144
6200
|
|
|
6145
6201
|
// src/version.ts
|
|
6146
|
-
var CLIENT_VERSION = "0.
|
|
6202
|
+
var CLIENT_VERSION = "0.4.0";
|
|
6147
6203
|
var CLIENT_PRODUCT = `@farthershore/client/${CLIENT_VERSION}`;
|
|
6148
6204
|
|
|
6149
6205
|
// src/transport.ts
|
|
@@ -6236,7 +6292,8 @@ function outcomeUnknownError(status, envelope, fallbackMessage, parsed, headers)
|
|
|
6236
6292
|
param: envelope?.param,
|
|
6237
6293
|
retryable: false,
|
|
6238
6294
|
retryDisposition: "reconcile_before_repeat",
|
|
6239
|
-
outcomeUnknown: true
|
|
6295
|
+
outcomeUnknown: true,
|
|
6296
|
+
requestId: envelope?.requestId
|
|
6240
6297
|
});
|
|
6241
6298
|
}
|
|
6242
6299
|
function requestAbortedError(cause) {
|
|
@@ -6388,7 +6445,8 @@ function httpError(res, policy, parsed) {
|
|
|
6388
6445
|
// `diagnosticsOf` keeps the TOP-LEVEL sibling arrays readable too.
|
|
6389
6446
|
details: envelope?.details ?? diagnosticsOf(parsed),
|
|
6390
6447
|
retryable: envelope?.retryable,
|
|
6391
|
-
retryDisposition: envelope?.retryDisposition
|
|
6448
|
+
retryDisposition: envelope?.retryDisposition,
|
|
6449
|
+
requestId: envelope?.requestId
|
|
6392
6450
|
}
|
|
6393
6451
|
);
|
|
6394
6452
|
}
|
|
@@ -695,7 +695,7 @@ export interface FartherShoreApi {
|
|
|
695
695
|
/**
|
|
696
696
|
* Create a preview environment bound to a git branch
|
|
697
697
|
*
|
|
698
|
-
* Create a preview environment
|
|
698
|
+
* 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
699
|
*
|
|
700
700
|
* Operation `environment.create` · write · requires `environment:create` · reconcile an unknown outcome with `environment.read`.
|
|
701
701
|
*/
|
|
@@ -1263,7 +1263,7 @@ export interface FartherShoreApi {
|
|
|
1263
1263
|
/**
|
|
1264
1264
|
* List variables: FS_PUBLIC_* values, secret metadata only
|
|
1265
1265
|
*
|
|
1266
|
-
* Lists variables. Returns readable FS_PUBLIC_* values; every other variable is a write-only secret and only its lifecycle metadata is returned.
|
|
1266
|
+
* 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
1267
|
*
|
|
1268
1268
|
* Operation `business_variable.read` · read · requires `business_variable:read`.
|
|
1269
1269
|
*/
|
|
@@ -1309,10 +1309,20 @@ export interface FartherShoreApi {
|
|
|
1309
1309
|
* Operation `webhook.delivery.read` · read · requires `webhook:delivery_read`.
|
|
1310
1310
|
*/
|
|
1311
1311
|
readonly get: Method<"webhooks.delivery.get">;
|
|
1312
|
+
readonly payload: {
|
|
1313
|
+
/**
|
|
1314
|
+
* Read a webhook delivery payload and response
|
|
1315
|
+
*
|
|
1316
|
+
* 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.
|
|
1317
|
+
*
|
|
1318
|
+
* Operation `webhook.delivery.payload.read` · read · requires `webhook:delivery_payload_read`.
|
|
1319
|
+
*/
|
|
1320
|
+
readonly read: Method<"webhooks.delivery.payload.read">;
|
|
1321
|
+
};
|
|
1312
1322
|
/**
|
|
1313
1323
|
* List recent delivery attempts for a webhook endpoint
|
|
1314
1324
|
*
|
|
1315
|
-
* List recent delivery attempts for a webhook endpoint.
|
|
1325
|
+
* 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
1326
|
*
|
|
1317
1327
|
* Operation `webhook.delivery.read` · read · requires `webhook:delivery_read` · offset pagination.
|
|
1318
1328
|
*/
|
|
@@ -1337,9 +1347,9 @@ export interface FartherShoreApi {
|
|
|
1337
1347
|
*/
|
|
1338
1348
|
readonly read: Method<"webhooks.read">;
|
|
1339
1349
|
/**
|
|
1340
|
-
* Issue a new signing secret (returned once);
|
|
1350
|
+
* Issue a new signing secret (returned once); readable old secrets verify for 24h
|
|
1341
1351
|
*
|
|
1342
|
-
* Issue a replacement signing secret for a webhook endpoint. Returns the new secret once
|
|
1352
|
+
* 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
1353
|
*
|
|
1344
1354
|
* Operation `webhook.rotate_secret` · write · requires `webhook:update` · destructive · returns a one-time secret · reconcile an unknown outcome with `webhook.read`.
|
|
1345
1355
|
*/
|
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;
|
|
@@ -1064,7 +1063,6 @@ export interface components {
|
|
|
1064
1063
|
transportMode: "direct" | "tunnel";
|
|
1065
1064
|
runner: ("embedded" | "sidecar") | null;
|
|
1066
1065
|
runtime: string | null;
|
|
1067
|
-
verificationRequired: boolean;
|
|
1068
1066
|
originUrl: string | null;
|
|
1069
1067
|
isDefault: boolean;
|
|
1070
1068
|
/** @enum {string} */
|
|
@@ -1099,7 +1097,6 @@ export interface components {
|
|
|
1099
1097
|
transportMode: "direct" | "tunnel";
|
|
1100
1098
|
runner: ("embedded" | "sidecar") | null;
|
|
1101
1099
|
runtime: string | null;
|
|
1102
|
-
verificationRequired: boolean;
|
|
1103
1100
|
originUrl: string | null;
|
|
1104
1101
|
isDefault: boolean;
|
|
1105
1102
|
/** @enum {string} */
|
|
@@ -1143,7 +1140,7 @@ export interface components {
|
|
|
1143
1140
|
organization: components["schemas"]["BuilderContextOrganization"];
|
|
1144
1141
|
role: string;
|
|
1145
1142
|
}[];
|
|
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")[];
|
|
1143
|
+
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_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
1147
1144
|
shouldPersistActiveOrganization: boolean;
|
|
1148
1145
|
platformTier: string | null;
|
|
1149
1146
|
features: {
|
|
@@ -1477,6 +1474,7 @@ export interface components {
|
|
|
1477
1474
|
runtimeHostname: string;
|
|
1478
1475
|
portalHostname: string | null;
|
|
1479
1476
|
status: string;
|
|
1477
|
+
secretInheritanceUnavailableReason?: string | null;
|
|
1480
1478
|
};
|
|
1481
1479
|
BusinessEnvironmentCreateResponse: {
|
|
1482
1480
|
id: string;
|
|
@@ -1486,6 +1484,7 @@ export interface components {
|
|
|
1486
1484
|
runtimeHostname: string;
|
|
1487
1485
|
portalHostname: string | null;
|
|
1488
1486
|
status: string;
|
|
1487
|
+
secretInheritanceUnavailableReason?: string | null;
|
|
1489
1488
|
created: boolean;
|
|
1490
1489
|
branchCreated: boolean;
|
|
1491
1490
|
};
|
|
@@ -1689,6 +1688,12 @@ export interface components {
|
|
|
1689
1688
|
BusinessVariable: {
|
|
1690
1689
|
name: string;
|
|
1691
1690
|
/** @enum {string} */
|
|
1691
|
+
scope: "business-wide" | "environment" | "production-only" | "inherited";
|
|
1692
|
+
environmentId: string | null;
|
|
1693
|
+
productionOnly: boolean;
|
|
1694
|
+
inheritedFrom: "main" | null;
|
|
1695
|
+
unavailableReason: string | null;
|
|
1696
|
+
/** @enum {string} */
|
|
1692
1697
|
visibility: "public" | "secret";
|
|
1693
1698
|
value: string | null;
|
|
1694
1699
|
hasValue: boolean;
|
|
@@ -2483,7 +2488,7 @@ export interface components {
|
|
|
2483
2488
|
credentialType: "maker_token";
|
|
2484
2489
|
tokenId: string;
|
|
2485
2490
|
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")[];
|
|
2491
|
+
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_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback")[];
|
|
2487
2492
|
/** @enum {string} */
|
|
2488
2493
|
businessScopeMode: "ALL" | "SELECTED";
|
|
2489
2494
|
selectedBusinessIds: string[];
|
|
@@ -2688,7 +2693,7 @@ export interface components {
|
|
|
2688
2693
|
unit: string;
|
|
2689
2694
|
periodLabel: string;
|
|
2690
2695
|
} | null;
|
|
2691
|
-
|
|
2696
|
+
billingConnected: boolean;
|
|
2692
2697
|
};
|
|
2693
2698
|
businesses: components["schemas"]["OrganizationOverviewBusiness"][];
|
|
2694
2699
|
recentActivity: components["schemas"]["OrganizationOverviewActivity"][];
|
|
@@ -2837,7 +2842,7 @@ export interface components {
|
|
|
2837
2842
|
unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
|
|
2838
2843
|
};
|
|
2839
2844
|
/** @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";
|
|
2845
|
+
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_payload_read" | "webhook:delivery_read" | "webhook:read" | "webhook:test" | "webhook:update" | "workflow:replay" | "workflow:rollback";
|
|
2841
2846
|
PortalOffsetPagination: {
|
|
2842
2847
|
limit: number;
|
|
2843
2848
|
offset: number;
|
|
@@ -3177,6 +3182,7 @@ export interface components {
|
|
|
3177
3182
|
};
|
|
3178
3183
|
PromoCode: {
|
|
3179
3184
|
id: string;
|
|
3185
|
+
unreadable: boolean;
|
|
3180
3186
|
code: string;
|
|
3181
3187
|
kind: ("percent_off" | "amount_off" | "free_months") | null;
|
|
3182
3188
|
amount: number | null;
|
|
@@ -3582,7 +3588,37 @@ export interface components {
|
|
|
3582
3588
|
};
|
|
3583
3589
|
};
|
|
3584
3590
|
WebhookDeliveryResponse: {
|
|
3585
|
-
data:
|
|
3591
|
+
data: {
|
|
3592
|
+
id: string;
|
|
3593
|
+
eventType: string;
|
|
3594
|
+
/**
|
|
3595
|
+
* @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.
|
|
3596
|
+
* @enum {string}
|
|
3597
|
+
*/
|
|
3598
|
+
status: "pending" | "success" | "failed" | "dead";
|
|
3599
|
+
attempts: number;
|
|
3600
|
+
lastAttemptAt: string | null;
|
|
3601
|
+
/** @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). */
|
|
3602
|
+
nextAttemptAt: string | null;
|
|
3603
|
+
responseStatus: number | null;
|
|
3604
|
+
environmentId: string | null;
|
|
3605
|
+
/** Format: date-time */
|
|
3606
|
+
createdAt: string;
|
|
3607
|
+
/** @description The exact event envelope sent to the endpoint. Requires webhook:delivery_payload_read. */
|
|
3608
|
+
payload?: {
|
|
3609
|
+
id: string;
|
|
3610
|
+
type: string;
|
|
3611
|
+
/** Format: date-time */
|
|
3612
|
+
createdAt: string;
|
|
3613
|
+
businessId: string;
|
|
3614
|
+
environmentId: string | null;
|
|
3615
|
+
data: {
|
|
3616
|
+
[key: string]: unknown;
|
|
3617
|
+
};
|
|
3618
|
+
};
|
|
3619
|
+
/** @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. */
|
|
3620
|
+
responseBody?: string | null;
|
|
3621
|
+
};
|
|
3586
3622
|
};
|
|
3587
3623
|
WebhookEndpoint: {
|
|
3588
3624
|
id: string;
|
|
@@ -3590,6 +3626,7 @@ export interface components {
|
|
|
3590
3626
|
environmentId: string | null;
|
|
3591
3627
|
events: string[];
|
|
3592
3628
|
enabled: boolean;
|
|
3629
|
+
signingSecretActionRequired: boolean;
|
|
3593
3630
|
failCount: number;
|
|
3594
3631
|
disabledAt: string | null;
|
|
3595
3632
|
/** Format: date-time */
|
|
@@ -3612,6 +3649,7 @@ export interface components {
|
|
|
3612
3649
|
environmentId: string | null;
|
|
3613
3650
|
events: string[];
|
|
3614
3651
|
enabled: boolean;
|
|
3652
|
+
signingSecretActionRequired: boolean;
|
|
3615
3653
|
failCount: number;
|
|
3616
3654
|
disabledAt: string | null;
|
|
3617
3655
|
/** Format: date-time */
|
|
@@ -3638,6 +3676,7 @@ export interface components {
|
|
|
3638
3676
|
environmentId: string | null;
|
|
3639
3677
|
events: string[];
|
|
3640
3678
|
enabled: boolean;
|
|
3679
|
+
signingSecretActionRequired: boolean;
|
|
3641
3680
|
failCount: number;
|
|
3642
3681
|
disabledAt: string | null;
|
|
3643
3682
|
/** Format: date-time */
|
|
@@ -3645,8 +3684,7 @@ export interface components {
|
|
|
3645
3684
|
/** Format: date-time */
|
|
3646
3685
|
updatedAt: string;
|
|
3647
3686
|
secret: string;
|
|
3648
|
-
|
|
3649
|
-
previousSecretExpiresAt: string;
|
|
3687
|
+
previousSecretExpiresAt: string | null;
|
|
3650
3688
|
};
|
|
3651
3689
|
WebhookEndpointUpdateResponse: {
|
|
3652
3690
|
data: components["schemas"]["WebhookEndpoint"];
|
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";
|