@farthershore/client 0.5.0 → 0.6.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.
@@ -159,7 +159,7 @@ export declare const platformOperations: {
159
159
  }, {
160
160
  name: string;
161
161
  trigger: {
162
- 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";
162
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
163
163
  filter?: {
164
164
  subjectType?: string;
165
165
  subjectId?: string;
@@ -204,7 +204,7 @@ export declare const platformOperations: {
204
204
  }, {
205
205
  name: string;
206
206
  trigger: {
207
- 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";
207
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
208
208
  filter?: {
209
209
  subjectType?: string;
210
210
  subjectId?: string;
@@ -252,7 +252,7 @@ export declare const platformOperations: {
252
252
  }, {
253
253
  name: string;
254
254
  trigger: {
255
- 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";
255
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
256
256
  filter?: {
257
257
  subjectType?: string;
258
258
  subjectId?: string;
@@ -297,7 +297,7 @@ export declare const platformOperations: {
297
297
  }, {
298
298
  name: string;
299
299
  trigger: {
300
- 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";
300
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
301
301
  filter?: {
302
302
  subjectType?: string;
303
303
  subjectId?: string;
@@ -346,7 +346,7 @@ export declare const platformOperations: {
346
346
  }, {
347
347
  name: string;
348
348
  trigger: {
349
- 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";
349
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
350
350
  filter?: {
351
351
  subjectType?: string;
352
352
  subjectId?: string;
@@ -391,7 +391,7 @@ export declare const platformOperations: {
391
391
  }, {
392
392
  name: string;
393
393
  trigger: {
394
- 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";
394
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
395
395
  filter?: {
396
396
  subjectType?: string;
397
397
  subjectId?: string;
@@ -141,6 +141,49 @@ export declare const portalOperations: {
141
141
  "portal.serviceAccounts.revoke": import("./define.js").OperationEntry<BusinessRef & {
142
142
  serviceAccountId: string;
143
143
  }, void, void, false>;
144
+ "portal.balance.read": import("./define.js").OperationEntry<BusinessRef, {
145
+ disclosure: "transparent";
146
+ balances: import("../generated/schemas.js").components["schemas"]["UnitBalance"][];
147
+ } | {
148
+ disclosure: "opaque";
149
+ balances: {
150
+ unit: {
151
+ key: string;
152
+ kind: "money" | "credits";
153
+ code: string;
154
+ displayName: string;
155
+ };
156
+ display: {
157
+ kind: "fraction";
158
+ consumedBasisPoints: number;
159
+ remainingBasisPoints: number;
160
+ };
161
+ exhausted: boolean;
162
+ source: "live" | "estimate";
163
+ asOf: string;
164
+ }[];
165
+ }, {
166
+ disclosure: "transparent";
167
+ balances: import("../generated/schemas.js").components["schemas"]["UnitBalance"][];
168
+ } | {
169
+ disclosure: "opaque";
170
+ balances: {
171
+ unit: {
172
+ key: string;
173
+ kind: "money" | "credits";
174
+ code: string;
175
+ displayName: string;
176
+ };
177
+ display: {
178
+ kind: "fraction";
179
+ consumedBasisPoints: number;
180
+ remainingBasisPoints: number;
181
+ };
182
+ exhausted: boolean;
183
+ source: "live" | "estimate";
184
+ asOf: string;
185
+ }[];
186
+ }, false>;
144
187
  "portal.usageLimits.list": import("./define.js").OperationEntry<BusinessRef & Page, {
145
188
  data: import("../generated/schemas.js").components["schemas"]["PortalUsageLimitDto"][];
146
189
  pagination: import("../generated/schemas.js").components["schemas"]["PortalOffsetPagination"];
@@ -83,14 +83,14 @@ export declare const webhookOperations: {
83
83
  "webhooks.eventType.read": import("./define.js").OperationEntry<BusinessRef, {
84
84
  data: {
85
85
  events: {
86
- 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";
86
+ name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed";
87
87
  description: string;
88
88
  }[];
89
89
  };
90
90
  }, {
91
91
  data: {
92
92
  events: {
93
- 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";
93
+ name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed";
94
94
  description: string;
95
95
  }[];
96
96
  };
@@ -68,6 +68,8 @@ export type CreateTransportOptions = {
68
68
  surface: string;
69
69
  /** Appended to the `x-fs-client` header, e.g. `"farthershore-cli/1.2.3"`. */
70
70
  clientInfo?: string;
71
+ /** CLI version for API upgrade enforcement; other clients omit it. */
72
+ cliVersion?: string;
71
73
  retry?: RetryOptions;
72
74
  };
73
75
  /** An organization a CLI login can act in, with the user's role key. */
@@ -50,17 +50,15 @@ export type AnalyticsPercentilesResult = Schemas["AnalyticsPercentilesResponse"]
50
50
  export type AnalyticsEventFeedResult = Schemas["AnalyticsEventFeedResponse"];
51
51
  /** `analytics.query`: any verb's answer; the verb sent decides which. */
52
52
  export type AnalyticsQueryResult = Schemas["AnalyticsQueryResponse"];
53
- /** `GET /management/businesses/:id/usage`: the trailing-30-day summary. */
53
+ /** `GET /agent/v1/businesses/:id/usage`: the trailing-30-day summary. */
54
54
  export type UsageSummary = Schemas["UsageSummary"];
55
- /** `GET /management/businesses/:id/usage-limits`: subscriber limits, paged. */
55
+ /** `GET /agent/v1/businesses/:id/usage-limits`: subscriber limits, paged. */
56
56
  export type ManagementUsageLimitList = Schemas["ManagementUsageLimitListResponse"];
57
- /** `GET /management/businesses/:id/plans`: plans in one scope, paged. */
57
+ /** `GET /agent/v1/businesses/:id/plans`: plans in one scope, paged. */
58
58
  export type PlanList = Schemas["PlanList"];
59
59
  /** `GET /businesses/:id/stripe/status`. No account ids. */
60
60
  export type StripeConnectionStatus = Schemas["StripeConnectionStatus"];
61
- /** `POST /businesses/:id/stripe/disconnect`. */
62
- export type StripeDisconnectResult = Schemas["StripeDisconnectResponse"];
63
- /** `GET`/`POST /management/businesses/:id/tax-settings`. */
61
+ /** `GET`/`POST /agent/v1/businesses/:id/tax-settings`. */
64
62
  export type TaxSettings = Schemas["TaxSettings"];
65
63
  /** Offset pagination block. */
66
64
  export type OffsetPagination = {
@@ -81,7 +79,7 @@ export type PublishBusinessBody = {
81
79
  };
82
80
  /** The `_release` block the publish route returns. */
83
81
  export type PublishRelease = Schemas["PublishRelease"];
84
- /** `GET /management/businesses/subdomain-availability` response. */
82
+ /** `GET /agent/v1/businesses/subdomain-availability` response. */
85
83
  export type ManagedSubdomainAvailability = Schemas["ManagedSubdomainAvailability"];
86
84
  /** `businesses.routes.read`: the routes the current contract serves. */
87
85
  export type BusinessRouteList = Schemas["BusinessRouteList"];
@@ -120,36 +118,36 @@ export type BusinessRbacUpdateResult = Schemas["BusinessRbacUpdateResponse"];
120
118
  export type BrandAssetUploadResult = Schemas["BusinessIconUploadResponse"] | Schemas["BusinessLogoUploadResponse"];
121
119
  /** A webhook endpoint as list and update return it: never the signing secret. */
122
120
  export type WebhookEndpoint = Schemas["WebhookEndpoint"];
123
- /** `GET /management/businesses/:id/webhooks`: one page of endpoints. */
121
+ /** `GET /agent/v1/businesses/:id/webhooks`: one page of endpoints. */
124
122
  export type WebhookEndpointList = Schemas["WebhookEndpointList"];
125
123
  /**
126
- * `POST /management/businesses/:id/webhooks`: the endpoint plus its signing
124
+ * `POST /agent/v1/businesses/:id/webhooks`: the endpoint plus its signing
127
125
  * `secret`, returned exactly once. Store it in the receiver's secret store.
128
126
  */
129
127
  export type WebhookEndpointCreateResult = Schemas["WebhookEndpointCreateResponse"];
130
- /** `PATCH /management/businesses/:id/webhooks/:webhookId`. */
128
+ /** `PATCH /agent/v1/businesses/:id/webhooks/:webhookId`. */
131
129
  export type WebhookEndpointUpdateResult = Schemas["WebhookEndpointUpdateResponse"];
132
130
  /**
133
- * `POST /management/businesses/:id/webhooks/:webhookId/rotate-secret`: the
131
+ * `POST /agent/v1/businesses/:id/webhooks/:webhookId/rotate-secret`: the
134
132
  * endpoint plus its NEW signing `secret`, returned exactly once; the previous
135
133
  * secret keeps signing until `previousSecretExpiresAt`.
136
134
  */
137
135
  export type WebhookEndpointRotateSecretResult = Schemas["WebhookEndpointRotateSecretResponse"];
138
- /** `DELETE /management/businesses/:id/webhooks/:webhookId`. */
136
+ /** `DELETE /agent/v1/businesses/:id/webhooks/:webhookId`. */
139
137
  export type WebhookEndpointDeleteResult = Schemas["WebhookEndpointDeleteResponse"];
140
- /** `POST /management/businesses/:id/webhooks/:webhookId/test` (`data.success` is the headline). */
138
+ /** `POST /agent/v1/businesses/:id/webhooks/:webhookId/test` (`data.success` is the headline). */
141
139
  export type WebhookTestResult = Schemas["WebhookTestResponse"];
142
140
  /** One delivery of an event to an endpoint. */
143
141
  export type WebhookDelivery = Schemas["WebhookDelivery"];
144
- /** `GET /management/businesses/:id/webhooks/:webhookId/deliveries`: one page, newest first. */
142
+ /** `GET /agent/v1/businesses/:id/webhooks/:webhookId/deliveries`: one page, newest first. */
145
143
  export type WebhookDeliveryList = Schemas["WebhookDeliveryList"];
146
144
  /**
147
- * `GET /management/businesses/:id/webhooks/:webhookId/deliveries/:deliveryId`:
145
+ * `GET /agent/v1/businesses/:id/webhooks/:webhookId/deliveries/:deliveryId`:
148
146
  * one delivery's metadata. Not its payload nor the endpoint's response body
149
147
  * (both can carry subscriber PII; no permission gates them yet).
150
148
  */
151
149
  export type WebhookDeliveryResult = Schemas["WebhookDeliveryResponse"];
152
- /** `GET /management/businesses/:id/webhook-event-types`: the subscribable events. */
150
+ /** `GET /agent/v1/businesses/:id/webhook-event-types`: the subscribable events. */
153
151
  export type WebhookEventTypeList = Schemas["WebhookEventTypeList"];
154
152
  /** An operating agent of a business. Closed: only these fields. */
155
153
  export type AgentSummary = Schemas["Agent"];
@@ -236,6 +234,11 @@ export type ConsumerRbacRoleList = Schemas["ConsumerRbacRoleList"];
236
234
  export type ConsumerApiKey = Schemas["ConsumerApiKey"];
237
235
  /** `GET …/consumers/:subscriberId/api-keys`. */
238
236
  export type ConsumerApiKeyList = Schemas["ConsumerApiKeyList"];
237
+ /**
238
+ * `GET …/consumers/:subscriberId/balance`: one subscriber's usage-unit
239
+ * balances, exact amounts, one per (environment, unit).
240
+ */
241
+ export type ConsumerBalanceList = Schemas["ConsumerBalanceList"];
239
242
  /** `POST …/consumers/:subscriberId/block`. */
240
243
  export type BlockConsumerResult = Schemas["ConsumerBlockResponse"];
241
244
  /** `POST …/consumers/:subscriberId/remove`. */
@@ -285,21 +288,6 @@ export type AuditLogPage = Schemas["AuditLogList"];
285
288
  export type AuditLogEntry = Schemas["AuditLogEntry"];
286
289
  /** The caller's email opt-outs for a business (`true` = opted out). */
287
290
  export type NotificationPreferences = Schemas["NotificationPreferences"];
288
- /** An economic agreement (builder surface). Closed: only these fields. */
289
- export type EconomicAgreement = Schemas["EconomicAgreement"];
290
- /** `GET /businesses/:id/agreements`: one page of agreements. */
291
- export type EconomicAgreementList = Schemas["EconomicAgreementList"];
292
- /**
293
- * What creating an agreement would do, plus the `confirmationToken` that
294
- * commits exactly that effect. Nothing is written.
295
- */
296
- export type AgreementCreatePreview = Schemas["AgreementCreatePreview"];
297
- /** What amending an agreement would do, plus its `confirmationToken`. */
298
- export type AgreementAmendPreview = Schemas["AgreementAmendPreview"];
299
- /** Either agreement preview. */
300
- export type AgreementPreview = AgreementCreatePreview | AgreementAmendPreview;
301
- /** What one subject's prices are pinned to (read-only). */
302
- export type SubjectPins = Schemas["SubjectPins"];
303
291
  /** A runtime token as list and revoke return it: never the secret. */
304
292
  export type RuntimeTokenSummary = Schemas["RuntimeToken"];
305
293
  /**
@@ -410,6 +398,11 @@ export type PortalServiceAccountDenyResult = Schemas["PortalServiceAccountDenyRe
410
398
  export type PortalServiceAccountApprovalList = Schemas["PortalServiceAccountPendingApprovalListResponse"];
411
399
  /** A subscriber usage limit: one subject and one value lane. */
412
400
  export type PortalUsageLimit = Schemas["PortalUsageLimitDto"];
401
+ /**
402
+ * `portal.balance.read`: the signed-in subscriber's usage-unit balances.
403
+ * Amounts on a transparent plan; only shares used and left on an opaque one.
404
+ */
405
+ export type PortalBalance = Schemas["PortalBalance"];
413
406
  /** `portal.usageLimits.list`: one offset page. */
414
407
  export type PortalUsageLimitList = Schemas["PortalUsageLimitListResponse"];
415
408
  /** `portal.usageLimits.remove`. */
@@ -440,7 +433,6 @@ export type PersonaLocalPreviewLease = {
440
433
  localProxyLeaseExpiresAt: string;
441
434
  };
442
435
  };
443
- /** Target and receipt for undoing a prior publish. */
444
- export type RollbackBusinessBody = Schemas["ManagementRollbackRequest"];
445
- export type RollbackBusinessResult = Schemas["ManagementRollbackResponse"];
436
+ /** Platform-owned business metadata update. */
437
+ export type BusinessUpdateInput = components["schemas"]["BusinessUpdateRequest"];
446
438
  export {};
@@ -3,6 +3,6 @@
3
3
  * `package.json` by `version.test.ts` and checked in the built bundle by
4
4
  * `scripts/check-pack.mjs`.
5
5
  */
6
- export declare const CLIENT_VERSION = "0.5.0";
6
+ export declare const CLIENT_VERSION = "0.6.0";
7
7
  /** The `x-fs-client` product token for this package. */
8
- export declare const CLIENT_PRODUCT = "@farthershore/client/0.5.0";
8
+ export declare const CLIENT_PRODUCT = "@farthershore/client/0.6.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farthershore/client",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "Farther Shore API client: the authenticated HTTP transport, credential sources, and typed errors shared by the CLI and agent tooling",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -1,174 +0,0 @@
1
- import { type RequestBody } from "./define.js";
2
- type BusinessRef = {
3
- businessId: string;
4
- };
5
- type AgreementRef = BusinessRef & {
6
- agreementId: string;
7
- };
8
- export declare const agreementOperations: {
9
- "agreements.read": import("./define.js").OperationEntry<BusinessRef & {
10
- subjectId?: string;
11
- environmentId?: string;
12
- limit?: number;
13
- offset?: number;
14
- }, {
15
- data: import("../generated/schemas.js").components["schemas"]["EconomicAgreement"][];
16
- pagination: {
17
- total: number;
18
- limit: number;
19
- offset: number;
20
- hasMore: boolean;
21
- };
22
- }, {
23
- data: import("../generated/schemas.js").components["schemas"]["EconomicAgreement"][];
24
- pagination: {
25
- total: number;
26
- limit: number;
27
- offset: number;
28
- hasMore: boolean;
29
- };
30
- }, false>;
31
- "agreements.get": import("./define.js").OperationEntry<AgreementRef, {
32
- id: string;
33
- environmentId: string | null;
34
- subjectId: string;
35
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
36
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
37
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
38
- effectiveAt: string;
39
- expiresAt: string | null;
40
- createdAt: string;
41
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
42
- }, {
43
- id: string;
44
- environmentId: string | null;
45
- subjectId: string;
46
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
47
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
48
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
49
- effectiveAt: string;
50
- expiresAt: string | null;
51
- createdAt: string;
52
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
53
- }, false>;
54
- "agreements.pins": import("./define.js").OperationEntry<BusinessRef & {
55
- subjectId: string;
56
- }, {
57
- subjectId: string;
58
- environmentId: string | null;
59
- recurringPricePin: {
60
- planKey: string;
61
- version: number;
62
- recurringFeeCents: number;
63
- billingInterval: string;
64
- } | null;
65
- usagePricingBinding: {
66
- source: "agreement";
67
- agreementId: string;
68
- binding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
69
- } | {
70
- source: "plan_default";
71
- mode: "current";
72
- };
73
- migrateToLatest: {
74
- status: "deferred";
75
- };
76
- }, {
77
- subjectId: string;
78
- environmentId: string | null;
79
- recurringPricePin: {
80
- planKey: string;
81
- version: number;
82
- recurringFeeCents: number;
83
- billingInterval: string;
84
- } | null;
85
- usagePricingBinding: {
86
- source: "agreement";
87
- agreementId: string;
88
- binding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
89
- } | {
90
- source: "plan_default";
91
- mode: "current";
92
- };
93
- migrateToLatest: {
94
- status: "deferred";
95
- };
96
- }, false>;
97
- "agreements.previewCreate": import("./define.js").OperationEntry<BusinessRef & {
98
- body: RequestBody;
99
- }, {
100
- effect: import("../generated/schemas.js").components["schemas"]["AgreementCreateEffect"];
101
- confirmationToken: string;
102
- }, {
103
- effect: import("../generated/schemas.js").components["schemas"]["AgreementCreateEffect"];
104
- confirmationToken: string;
105
- }, false>;
106
- "agreements.create": import("./define.js").OperationEntry<BusinessRef & {
107
- body: RequestBody & {
108
- confirmationToken: string;
109
- };
110
- }, {
111
- id: string;
112
- environmentId: string | null;
113
- subjectId: string;
114
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
115
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
116
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
117
- effectiveAt: string;
118
- expiresAt: string | null;
119
- createdAt: string;
120
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
121
- }, {
122
- id: string;
123
- environmentId: string | null;
124
- subjectId: string;
125
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
126
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
127
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
128
- effectiveAt: string;
129
- expiresAt: string | null;
130
- createdAt: string;
131
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
132
- }, false>;
133
- "agreements.previewAmend": import("./define.js").OperationEntry<BusinessRef & {
134
- agreementId: string;
135
- } & {
136
- body: RequestBody;
137
- }, {
138
- effect: import("../generated/schemas.js").components["schemas"]["AgreementAmendEffect"];
139
- confirmationToken: string;
140
- }, {
141
- effect: import("../generated/schemas.js").components["schemas"]["AgreementAmendEffect"];
142
- confirmationToken: string;
143
- }, false>;
144
- "agreements.amend": import("./define.js").OperationEntry<BusinessRef & {
145
- agreementId: string;
146
- } & {
147
- body: RequestBody & {
148
- confirmationToken: string;
149
- };
150
- }, {
151
- id: string;
152
- environmentId: string | null;
153
- subjectId: string;
154
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
155
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
156
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
157
- effectiveAt: string;
158
- expiresAt: string | null;
159
- createdAt: string;
160
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
161
- }, {
162
- id: string;
163
- environmentId: string | null;
164
- subjectId: string;
165
- usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
166
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
167
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
168
- effectiveAt: string;
169
- expiresAt: string | null;
170
- createdAt: string;
171
- contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
172
- }, false>;
173
- };
174
- export {};