@farthershore/client 0.4.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.
@@ -19,8 +19,7 @@ export interface components {
19
19
  };
20
20
  /**
21
21
  * @default {
22
- * "meters": [],
23
- * "billOn4xx": false
22
+ * "meters": []
24
23
  * }
25
24
  */
26
25
  metering: {
@@ -53,8 +52,6 @@ export interface components {
53
52
  reserveCeiling?: number;
54
53
  pairsWith?: string;
55
54
  }[];
56
- /** @default false */
57
- billOn4xx: boolean;
58
55
  };
59
56
  backend?: {
60
57
  [key: string]: {
@@ -286,13 +283,9 @@ export interface components {
286
283
  };
287
284
  };
288
285
  customer_context?: {
289
- context_tokens?: {
290
- /** @default true */
291
- enabled: boolean;
292
- };
293
286
  portal_auth?: {
294
287
  /** @enum {string} */
295
- strategy: "clerk" | "test-personas";
288
+ strategy: "hosted" | "test-personas";
296
289
  };
297
290
  };
298
291
  frontend?: never;
@@ -386,8 +379,6 @@ export interface components {
386
379
  name: string;
387
380
  description?: string;
388
381
  details?: string[];
389
- /** @enum {string} */
390
- kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
391
382
  /** @default [] */
392
383
  meters: {
393
384
  dimension: string;
@@ -399,15 +390,10 @@ export interface components {
399
390
  }[];
400
391
  /** @default 0 */
401
392
  recurring_fee_cents: number;
402
- /**
403
- * @default month
404
- * @enum {string}
405
- */
406
- billing_interval: "month" | "year";
393
+ /** @enum {string} */
394
+ billing_interval?: "month" | "year";
407
395
  /** @default 0 */
408
396
  trial_days: number;
409
- max_monthly_spend_cents?: number;
410
- min_monthly_spend_cents?: number;
411
397
  /** @default [] */
412
398
  limits: {
413
399
  dimension: string;
@@ -448,11 +434,6 @@ export interface components {
448
434
  resource_limits: {
449
435
  [key: string]: number;
450
436
  };
451
- /**
452
- * @default block
453
- * @enum {string}
454
- */
455
- overageBehavior: "block" | "allow_and_bill";
456
437
  /** @default true */
457
438
  selfServeEnabled: boolean;
458
439
  capacity?: {
@@ -516,63 +497,6 @@ export interface components {
516
497
  require_successor_route: boolean;
517
498
  };
518
499
  };
519
- environments?: {
520
- [key: string]: {
521
- plans?: {
522
- [key: string]: {
523
- meters?: {
524
- dimension: string;
525
- /**
526
- * @default linear
527
- * @enum {string}
528
- */
529
- kind: "linear" | "active_count" | "event_count";
530
- }[];
531
- recurring_fee_cents?: number;
532
- /** @enum {string} */
533
- billing_interval?: "month" | "year";
534
- trial_days?: number;
535
- max_monthly_spend_cents?: number;
536
- limits?: {
537
- dimension: string;
538
- window: {
539
- /** @constant */
540
- type: "named";
541
- /** @enum {string} */
542
- name: "second" | "minute" | "hour" | "day" | "week" | "month";
543
- } | {
544
- /** @constant */
545
- type: "custom";
546
- seconds: number;
547
- label?: string;
548
- };
549
- capacity: number;
550
- /** @enum {string} */
551
- enforcement?: "enforce" | "track";
552
- warnAt?: number;
553
- /** @enum {string} */
554
- strategy?: "fixed_window" | "sliding_window" | "token_bucket";
555
- bucketCapacity?: number;
556
- refillRatePerSecond?: number;
557
- scope?: {
558
- endpoint?: string;
559
- apiKey?: string;
560
- workspace?: string;
561
- region?: string;
562
- actor?: {
563
- /** @enum {string} */
564
- kind: "member" | "service_account";
565
- };
566
- };
567
- acknowledgeUnreachable?: boolean;
568
- }[];
569
- /** @enum {string} */
570
- overageBehavior?: "block" | "allow_and_bill";
571
- selfServeEnabled?: boolean;
572
- };
573
- };
574
- };
575
- };
576
500
  ephemeral?: {
577
501
  defaultPlan?: string;
578
502
  };
@@ -628,7 +552,6 @@ export interface components {
628
552
  callCaps?: {
629
553
  search?: number;
630
554
  fetch?: number;
631
- dataforseo?: number;
632
555
  };
633
556
  };
634
557
  AgentLaunch: {
@@ -712,84 +635,13 @@ export interface components {
712
635
  };
713
636
  catalog: components["schemas"]["AgentCatalogEntry"][];
714
637
  };
715
- AgreementAmendEffect: {
716
- /** @constant */
717
- kind: "amend";
718
- agreementId: string;
719
- subjectId: string;
720
- pricingPolicyId: string;
721
- pricingPolicyVersionId: string;
722
- currentVersion: {
723
- id: string;
724
- version: number;
725
- };
726
- nextVersion: number;
727
- terms: components["schemas"]["ContractTerms"];
728
- bounds: components["schemas"]["ContractTermsBounds"];
729
- ownedNamespaces: string[];
730
- effectiveAt: string | null;
731
- };
732
- AgreementAmendPreview: {
733
- effect: components["schemas"]["AgreementAmendEffect"];
734
- /** @description Pass with the SAME body to commit exactly this effect. Expires after 15 minutes; a changed body or a newly published policy version makes it stale. */
735
- confirmationToken: string;
736
- };
737
- AgreementCreateEffect: {
738
- /** @constant */
739
- kind: "create";
740
- environmentId: string | null;
741
- subjectId: string;
742
- binding: {
743
- /** @enum {string} */
744
- mode: "current" | "current_with_contract_terms" | "fixed_version";
745
- pricingPolicyId: string;
746
- pricingPolicyKey: string;
747
- pricingPolicyVersionId: string;
748
- pricingPolicyVersion: number;
749
- };
750
- /** @enum {string} */
751
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
752
- /** @enum {string} */
753
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
754
- terms?: components["schemas"]["ContractTerms"];
755
- bounds: components["schemas"]["ContractTermsBounds"];
756
- ownedNamespaces: string[];
757
- agreedBasis: {
758
- measurementRuleIds: string[];
759
- measureSetByRuleId: {
760
- [key: string]: string[];
761
- };
762
- };
763
- effectiveAt: string | null;
764
- expiresAt: string | null;
765
- };
766
- AgreementCreatePreview: {
767
- effect: components["schemas"]["AgreementCreateEffect"];
768
- /** @description Pass with the SAME body to commit exactly this effect. Expires after 15 minutes; a changed body or a newly published policy version makes it stale. */
769
- confirmationToken: string;
770
- };
771
- AgreementUsagePricingBinding: {
772
- /** @constant */
773
- mode: "current";
774
- pricingPolicyId: string;
775
- } | {
776
- /** @constant */
777
- mode: "current_with_contract_terms";
778
- pricingPolicyId: string;
779
- contractPricingVersionId: string;
780
- } | {
781
- /** @constant */
782
- mode: "fixed_version";
783
- pricingPolicyId: string;
784
- pricingPolicyVersionId: string;
785
- };
786
638
  AnalyticsEventFeedResponse: {
787
639
  result: components["schemas"]["AnalyticsEventFeedRow"][];
788
640
  };
789
641
  AnalyticsEventFeedRow: {
790
642
  id: string;
791
643
  /** @enum {string} */
792
- 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";
644
+ type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
793
645
  /** Format: date-time */
794
646
  occurredAt: string;
795
647
  environmentId: string | null;
@@ -989,7 +841,7 @@ export interface components {
989
841
  name: string;
990
842
  trigger: {
991
843
  /** @enum {string} */
992
- 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";
844
+ eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "balance.low" | "balance.exhausted" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
993
845
  filter?: {
994
846
  subjectType?: string;
995
847
  subjectId?: string;
@@ -1140,9 +992,18 @@ export interface components {
1140
992
  organization: components["schemas"]["BuilderContextOrganization"];
1141
993
  role: string;
1142
994
  }[];
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")[];
995
+ effectivePermissions: ("agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "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: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")[];
1144
996
  shouldPersistActiveOrganization: boolean;
1145
997
  platformTier: string | null;
998
+ platformSubscription: {
999
+ status: string;
1000
+ planTier: string;
1001
+ cancelAtPeriodEnd: boolean;
1002
+ currentPeriodEnd: string | null;
1003
+ } | null;
1004
+ platformPlanLapsedAt: string | null;
1005
+ platformPausesAt: string | null;
1006
+ platformPausedAt: string | null;
1146
1007
  features: {
1147
1008
  team?: boolean;
1148
1009
  };
@@ -1176,8 +1037,6 @@ export interface components {
1176
1037
  name: string;
1177
1038
  description?: string;
1178
1039
  details?: string[];
1179
- /** @enum {string} */
1180
- kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
1181
1040
  /** @default [] */
1182
1041
  meters: {
1183
1042
  dimension: string;
@@ -1189,15 +1048,10 @@ export interface components {
1189
1048
  }[];
1190
1049
  /** @default 0 */
1191
1050
  recurring_fee_cents: number;
1192
- /**
1193
- * @default month
1194
- * @enum {string}
1195
- */
1196
- billing_interval: "month" | "year";
1051
+ /** @enum {string} */
1052
+ billing_interval?: "month" | "year";
1197
1053
  /** @default 0 */
1198
1054
  trial_days: number;
1199
- max_monthly_spend_cents?: number;
1200
- min_monthly_spend_cents?: number;
1201
1055
  /** @default [] */
1202
1056
  limits: {
1203
1057
  dimension: string;
@@ -1238,11 +1092,6 @@ export interface components {
1238
1092
  resource_limits: {
1239
1093
  [key: string]: number;
1240
1094
  };
1241
- /**
1242
- * @default block
1243
- * @enum {string}
1244
- */
1245
- overageBehavior: "block" | "allow_and_bill";
1246
1095
  /** @default true */
1247
1096
  selfServeEnabled: boolean;
1248
1097
  capacity?: {
@@ -1459,6 +1308,9 @@ export interface components {
1459
1308
  createdAt: string;
1460
1309
  /** Format: date-time */
1461
1310
  updatedAt: string;
1311
+ usageUnitLabels?: {
1312
+ [key: string]: string;
1313
+ };
1462
1314
  environments: components["schemas"]["BusinessEnvironment"][];
1463
1315
  };
1464
1316
  BusinessDiagnostic: {
@@ -1514,8 +1366,6 @@ export interface components {
1514
1366
  name: string;
1515
1367
  description?: string;
1516
1368
  details?: string[];
1517
- /** @enum {string} */
1518
- kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
1519
1369
  /** @default [] */
1520
1370
  meters: {
1521
1371
  dimension: string;
@@ -1527,15 +1377,10 @@ export interface components {
1527
1377
  }[];
1528
1378
  /** @default 0 */
1529
1379
  recurring_fee_cents: number;
1530
- /**
1531
- * @default month
1532
- * @enum {string}
1533
- */
1534
- billing_interval: "month" | "year";
1380
+ /** @enum {string} */
1381
+ billing_interval?: "month" | "year";
1535
1382
  /** @default 0 */
1536
1383
  trial_days: number;
1537
- max_monthly_spend_cents?: number;
1538
- min_monthly_spend_cents?: number;
1539
1384
  /** @default [] */
1540
1385
  limits: {
1541
1386
  dimension: string;
@@ -1576,11 +1421,6 @@ export interface components {
1576
1421
  resource_limits: {
1577
1422
  [key: string]: number;
1578
1423
  };
1579
- /**
1580
- * @default block
1581
- * @enum {string}
1582
- */
1583
- overageBehavior: "block" | "allow_and_bill";
1584
1424
  /** @default true */
1585
1425
  selfServeEnabled: boolean;
1586
1426
  capacity?: {
@@ -1665,6 +1505,26 @@ export interface components {
1665
1505
  key: string;
1666
1506
  environmentId: string | null;
1667
1507
  };
1508
+ BusinessUpdateRequest: {
1509
+ /** @description Display label for the business's usage unit. Null restores the default. Declare a usage unit and release first. */
1510
+ usageUnitLabel?: string | null;
1511
+ displayName?: string;
1512
+ description?: string;
1513
+ docsEnabled?: boolean;
1514
+ featuredPlanId?: string | null;
1515
+ /** Format: uri */
1516
+ iconUrl?: string | null;
1517
+ /** Format: uri */
1518
+ logoUrl?: string | null;
1519
+ allowedOrigins?: string[];
1520
+ envBranchPrefix?: string | null;
1521
+ /** @enum {string} */
1522
+ previewEnvTrigger?: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
1523
+ /** @description White-label prefix for subscriber API keys (fsk_ → e.g. acme_). Null clears to the platform default fsk. */
1524
+ keyPrefix?: string | null;
1525
+ /** @description Show (true) or hide (false) this product on the organization's public page at /organization/<slug>. Defaults to true. */
1526
+ listedOnOrganizationPage?: boolean;
1527
+ };
1668
1528
  BusinessValidateResponse: {
1669
1529
  success: boolean;
1670
1530
  environment: {
@@ -1909,7 +1769,7 @@ export interface components {
1909
1769
  /** Format: date-time */
1910
1770
  expiresAt: string;
1911
1771
  /** @enum {string} */
1912
- credentialType: "maker_token" | "cli_session";
1772
+ credentialType: "maker_token" | "cli_session" | "oauth";
1913
1773
  userId?: string;
1914
1774
  organizationId: string;
1915
1775
  };
@@ -1984,6 +1844,28 @@ export interface components {
1984
1844
  ConsumerApiKeyList: {
1985
1845
  apiKeys: components["schemas"]["ConsumerApiKey"][];
1986
1846
  };
1847
+ ConsumerBalanceList: {
1848
+ subscriberId: string;
1849
+ balances: {
1850
+ unit: {
1851
+ key: string;
1852
+ /** @enum {string} */
1853
+ kind: "money" | "credits";
1854
+ code: string;
1855
+ displayName: string;
1856
+ };
1857
+ available: string;
1858
+ granted: string;
1859
+ revoked: string;
1860
+ consumed: string;
1861
+ exhausted: boolean;
1862
+ /** @enum {string} */
1863
+ source: "live" | "estimate";
1864
+ /** Format: date-time */
1865
+ asOf: string;
1866
+ environment: string | null;
1867
+ }[];
1868
+ };
1987
1869
  ConsumerBlockResponse: {
1988
1870
  /** @constant */
1989
1871
  blocked: true;
@@ -2094,13 +1976,6 @@ export interface components {
2094
1976
  kind: "linear" | "active_count" | "event_count";
2095
1977
  }[];
2096
1978
  };
2097
- ContractPricingVersion: {
2098
- id: string;
2099
- version: number;
2100
- terms: components["schemas"]["ContractTerms"];
2101
- effectiveAt: string;
2102
- createdAt: string;
2103
- };
2104
1979
  ContractRoute: {
2105
1980
  routeId: string;
2106
1981
  method: string;
@@ -2109,38 +1984,6 @@ export interface components {
2109
1984
  meters: string[];
2110
1985
  grantedBy: string[];
2111
1986
  };
2112
- ContractTerms: {
2113
- percentDiscount?: {
2114
- num: string;
2115
- den: string;
2116
- };
2117
- floorNanos?: string;
2118
- capNanos?: string;
2119
- selectorScope: ({
2120
- /** @constant */
2121
- kind: "catalog_item";
2122
- item: {
2123
- provider: string;
2124
- model: string;
2125
- modality?: string;
2126
- };
2127
- } | {
2128
- /** @constant */
2129
- kind: "provider_model_glob";
2130
- provider: string;
2131
- modelGlob: string;
2132
- modality?: string;
2133
- })[];
2134
- };
2135
- ContractTermsBounds: {
2136
- maxPercentDiscount?: {
2137
- num: string;
2138
- den: string;
2139
- };
2140
- minFloorNanos?: string;
2141
- maxCapNanos?: string;
2142
- requireFloorWithDiscount?: boolean;
2143
- };
2144
1987
  CustomPermissionSubject: {
2145
1988
  subject: string;
2146
1989
  verbs: string[];
@@ -2259,29 +2102,6 @@ export interface components {
2259
2102
  DocsValidateResponse: {
2260
2103
  issues: components["schemas"]["DocsCheckIssue"][];
2261
2104
  };
2262
- EconomicAgreement: {
2263
- id: string;
2264
- environmentId: string | null;
2265
- subjectId: string;
2266
- usagePricingBinding: components["schemas"]["AgreementUsagePricingBinding"];
2267
- /** @enum {string} */
2268
- newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
2269
- /** @enum {string} */
2270
- newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
2271
- effectiveAt: string;
2272
- expiresAt: string | null;
2273
- createdAt: string;
2274
- contractPricingVersions: components["schemas"]["ContractPricingVersion"][];
2275
- };
2276
- EconomicAgreementList: {
2277
- data: components["schemas"]["EconomicAgreement"][];
2278
- pagination: {
2279
- total: number;
2280
- limit: number;
2281
- offset: number;
2282
- hasMore: boolean;
2283
- };
2284
- };
2285
2105
  FrontendBuild: {
2286
2106
  id: string;
2287
2107
  /** @enum {string} */
@@ -2360,7 +2180,7 @@ export interface components {
2360
2180
  updatedAt: string;
2361
2181
  };
2362
2182
  /** @enum {string} */
2363
- 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: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" | "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";
2183
+ MakerDelegablePermission: "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "knowledge:read" | "organization:read" | "organization_bulletin:read" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "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";
2364
2184
  MakerTokenBusinessScopeSummary: {
2365
2185
  /** @constant */
2366
2186
  mode: "ALL";
@@ -2488,7 +2308,7 @@ export interface components {
2488
2308
  credentialType: "maker_token";
2489
2309
  tokenId: string;
2490
2310
  organizationId: string;
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")[];
2311
+ grantedPermissions: ("agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "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: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")[];
2492
2312
  /** @enum {string} */
2493
2313
  businessScopeMode: "ALL" | "SELECTED";
2494
2314
  selectedBusinessIds: string[];
@@ -2842,7 +2662,35 @@ export interface components {
2842
2662
  unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
2843
2663
  };
2844
2664
  /** @enum {string} */
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";
2665
+ PlatformPermission: "agent:configure" | "agent:read" | "analytics:read" | "apply_timeline:read" | "audit_log:export" | "audit_log:read" | "auth_context:issue" | "auth_context:read" | "auth_provider_connection:create" | "auth_provider_connection:delete" | "auth_provider_connection:read" | "auth_provider_connection:update" | "automation_rule:create" | "automation_rule:delete" | "automation_rule:read" | "automation_rule:update" | "backend:bind" | "backend:create" | "backend:delete" | "backend:read" | "backend_spec:write" | "brand:update" | "bulletin:ack" | "bulletin:read" | "bulletin:resolve" | "business:compile" | "business:cors_update" | "business:create" | "business:delete" | "business:docs_update" | "business:preview_env_update" | "business:publish" | "business:rbac_update" | "business:read" | "business_dependents:read" | "business_variable:create" | "business_variable:delete" | "business_variable:operation_read" | "business_variable:read" | "business_variable:revoke" | "business_variable:rotate" | "change_set:propose" | "change_set:read" | "consumer:block" | "consumer:migrate_latest" | "consumer:read" | "consumer:remove" | "consumer:roles_assign" | "denial:read" | "environment:create" | "environment:delete" | "environment:read" | "frontend:read" | "frontend:rollback" | "git_connection:create" | "git_connection:delete" | "git_connection:read" | "git_connection:update" | "knowledge:read" | "maker_token:create" | "maker_token:create_org" | "maker_token:read" | "maker_token:revoke" | "maker_token:rotate" | "notification:preferences_read" | "notification:preferences_update" | "organization:create" | "organization:delete" | "organization:manage_billing" | "organization:ownership_transfer" | "organization:read" | "organization_bulletin:read" | "organization_invitation:accept" | "organization_invitation:create" | "organization_invitation:list" | "organization_invitation:revoke" | "organization_member:list" | "organization_member:remove" | "organization_member:update" | "organization_role:create" | "organization_role:delete" | "organization_role:read" | "organization_role:update" | "persona:issue" | "persona:read" | "persona:revoke" | "persona:rotate" | "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: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";
2666
+ PortalBalance: {
2667
+ /** @constant */
2668
+ disclosure: "transparent";
2669
+ balances: components["schemas"]["UnitBalance"][];
2670
+ } | {
2671
+ /** @constant */
2672
+ disclosure: "opaque";
2673
+ balances: {
2674
+ unit: {
2675
+ key: string;
2676
+ /** @enum {string} */
2677
+ kind: "money" | "credits";
2678
+ code: string;
2679
+ displayName: string;
2680
+ };
2681
+ display: {
2682
+ /** @constant */
2683
+ kind: "fraction";
2684
+ consumedBasisPoints: number;
2685
+ remainingBasisPoints: number;
2686
+ };
2687
+ exhausted: boolean;
2688
+ /** @enum {string} */
2689
+ source: "live" | "estimate";
2690
+ /** Format: date-time */
2691
+ asOf: string;
2692
+ }[];
2693
+ };
2846
2694
  PortalOffsetPagination: {
2847
2695
  limit: number;
2848
2696
  offset: number;
@@ -3398,41 +3246,13 @@ export interface components {
3398
3246
  };
3399
3247
  StripeConnectionStatus: {
3400
3248
  connected: boolean;
3249
+ /** @constant */
3250
+ reconnectRequired?: true;
3401
3251
  /** @enum {string} */
3402
- source: "business" | "organization";
3403
- isOverride: boolean;
3252
+ source: "organization";
3404
3253
  chargesEnabled: boolean;
3405
3254
  cardPaymentsEnabled: boolean;
3406
3255
  };
3407
- StripeDisconnectResponse: {
3408
- /** @constant */
3409
- disconnected: true;
3410
- };
3411
- SubjectPins: {
3412
- subjectId: string;
3413
- environmentId: string | null;
3414
- recurringPricePin: {
3415
- planKey: string;
3416
- version: number;
3417
- recurringFeeCents: number;
3418
- billingInterval: string;
3419
- } | null;
3420
- usagePricingBinding: {
3421
- /** @constant */
3422
- source: "agreement";
3423
- agreementId: string;
3424
- binding: components["schemas"]["AgreementUsagePricingBinding"];
3425
- } | {
3426
- /** @constant */
3427
- source: "plan_default";
3428
- /** @constant */
3429
- mode: "current";
3430
- };
3431
- migrateToLatest: {
3432
- /** @constant */
3433
- status: "deferred";
3434
- };
3435
- };
3436
3256
  TaxAddress: {
3437
3257
  line1: string | null;
3438
3258
  line2: string | null;
@@ -3517,6 +3337,24 @@ export interface components {
3517
3337
  rotatedAt: string;
3518
3338
  };
3519
3339
  };
3340
+ UnitBalance: {
3341
+ unit: {
3342
+ key: string;
3343
+ /** @enum {string} */
3344
+ kind: "money" | "credits";
3345
+ code: string;
3346
+ displayName: string;
3347
+ };
3348
+ available: string;
3349
+ granted: string;
3350
+ revoked: string;
3351
+ consumed: string;
3352
+ exhausted: boolean;
3353
+ /** @enum {string} */
3354
+ source: "live" | "estimate";
3355
+ /** Format: date-time */
3356
+ asOf: string;
3357
+ };
3520
3358
  UsageLimitPlan: {
3521
3359
  key: string;
3522
3360
  version: number;
@@ -3693,7 +3531,7 @@ export interface components {
3693
3531
  data: {
3694
3532
  events: {
3695
3533
  /** @enum {string} */
3696
- name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
3534
+ 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";
3697
3535
  description: string;
3698
3536
  }[];
3699
3537
  };