@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.
@@ -45,56 +45,6 @@ export interface FartherShoreApi {
45
45
  */
46
46
  readonly status: Method<"agents.status">;
47
47
  };
48
- readonly agreements: {
49
- /**
50
- * Amend an agreement's contract terms (append-only; previews first; commits with the confirmation token)
51
- *
52
- * Amend an agreement's contract terms (append-only; confirm-gated: previews first; pass --confirm <token> to commit)
53
- *
54
- * Operation `agreement.amend` · write · requires `agreement:amend` · reconcile an unknown outcome with `agreement.read`.
55
- */
56
- readonly amend: Method<"agreements.amend">;
57
- /**
58
- * Create an economic agreement (previews first; commits with the confirmation token)
59
- *
60
- * Create an economic agreement (confirm-gated: previews first; pass --confirm <token> to commit)
61
- *
62
- * Operation `agreement.create` · write · requires `agreement:create` · reconcile an unknown outcome with `agreement.read`.
63
- */
64
- readonly create: Method<"agreements.create">;
65
- /**
66
- * Show one economic agreement
67
- *
68
- * Operation `agreement.read` · read · requires `agreement:read`.
69
- */
70
- readonly get: Method<"agreements.get">;
71
- /**
72
- * Show the price pins in force for one subject
73
- *
74
- * Operation `agreement.read` · read · requires `agreement:read`.
75
- */
76
- readonly pins: Method<"agreements.pins">;
77
- /**
78
- * Preview an amendment's effect and get its confirmation token
79
- *
80
- * Operation `agreement.amend` · read · requires `agreement:amend` · reconcile an unknown outcome with `agreement.read`.
81
- */
82
- readonly previewAmend: Method<"agreements.previewAmend">;
83
- /**
84
- * Preview a new agreement's effect and get its confirmation token
85
- *
86
- * Operation `agreement.create` · read · requires `agreement:create` · reconcile an unknown outcome with `agreement.read`.
87
- */
88
- readonly previewCreate: Method<"agreements.previewCreate">;
89
- /**
90
- * List or show a business's economic agreements and their pins
91
- *
92
- * Lists a business's economic agreements, shows one agreement with its terms, and shows the agreement pins that bind subscribers to a version.
93
- *
94
- * Operation `agreement.read` · read · requires `agreement:read` · offset pagination.
95
- */
96
- readonly read: Method<"agreements.read">;
97
- };
98
48
  readonly analytics: {
99
49
  /**
100
50
  * Request latency percentiles (p50 / p95 / p99)
@@ -262,9 +212,9 @@ export interface FartherShoreApi {
262
212
  readonly billing: {
263
213
  readonly stripe: {
264
214
  /**
265
- * Show the Stripe connection a business bills through (business override or org default)
215
+ * Show the organization Stripe connection a business bills through
266
216
  *
267
- * Read whether a business bills through a connected Stripe account — a per-business override when present, otherwise the organization default — and whether that account can take charges and card payments. Read-only. Connecting Stripe is browser-only and has no tool.
217
+ * Read whether a business bills through its organization connected Stripe account and whether that account can take charges and card payments. Read-only. Connecting Stripe is browser-only and has no tool.
268
218
  *
269
219
  * Operation `stripe_connection.read` · read · requires `stripe_connection:read`.
270
220
  */
@@ -482,14 +432,6 @@ export interface FartherShoreApi {
482
432
  * Operation `business.read` · read · requires `business:read`.
483
433
  */
484
434
  readonly read: Method<"businesses.read">;
485
- /**
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.
489
- *
490
- * Operation `business.rollback` · write · requires `business:rollback` · destructive · reconcile an unknown outcome with `business.status`.
491
- */
492
- readonly rollback: Method<"businesses.rollback">;
493
435
  readonly routes: {
494
436
  /**
495
437
  * List a business's compiled routes
@@ -584,6 +526,14 @@ export interface FartherShoreApi {
584
526
  */
585
527
  readonly revoke: Method<"consumers.apiKeys.revoke">;
586
528
  };
529
+ readonly balance: {
530
+ /**
531
+ * Read one subscriber's usage-unit balances
532
+ *
533
+ * Operation `consumer.read` · read · requires `consumer:read`.
534
+ */
535
+ readonly read: Method<"consumers.balance.read">;
536
+ };
587
537
  /**
588
538
  * Block a consumer (revoking every API key) or revoke one of its API keys
589
539
  *
@@ -619,9 +569,9 @@ export interface FartherShoreApi {
619
569
  readonly enable: Method<"consumers.rbac.enable">;
620
570
  };
621
571
  /**
622
- * List a business's consumers, one consumer's API keys, or its Managed-RBAC roles
572
+ * List a business's consumers, or read one consumer's API keys, balances or Managed-RBAC roles
623
573
  *
624
- * Reads a business's consumers (subscribers). The same capability lists one consumer's API keys (metadata only; key material is never returned) and one subscriber's Managed-RBAC roles.
574
+ * Reads a business's consumers (subscribers). The same capability lists one consumer's API keys (metadata only; key material is never returned), reads its usage-unit balances (exact amounts, with whether each read is live or an estimate), and lists one subscriber's Managed-RBAC roles.
625
575
  *
626
576
  * Operation `consumer.read` · read · requires `consumer:read`.
627
577
  */
@@ -1040,6 +990,14 @@ export interface FartherShoreApi {
1040
990
  };
1041
991
  };
1042
992
  readonly portal: {
993
+ readonly balance: {
994
+ /**
995
+ * Read the signed-in subscriber's usage-unit balances
996
+ *
997
+ * No opKey · read.
998
+ */
999
+ readonly read: Method<"portal.balance.read">;
1000
+ };
1043
1001
  readonly serviceAccounts: {
1044
1002
  /**
1045
1003
  * List pending service-account approvals