@farthershore/client 0.2.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.
Files changed (35) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +7 -1
  3. package/dist/index.js +113 -16
  4. package/dist/types/api.generated.d.ts +23 -5
  5. package/dist/types/envelope.d.ts +2 -0
  6. package/dist/types/errors.d.ts +13 -0
  7. package/dist/types/generated/schemas.d.ts +68 -17
  8. package/dist/types/index.d.ts +1 -1
  9. package/dist/types/operations/agents.d.ts +9 -9
  10. package/dist/types/operations/agreements.d.ts +7 -7
  11. package/dist/types/operations/analytics.d.ts +5 -5
  12. package/dist/types/operations/audit-notifications.d.ts +6 -6
  13. package/dist/types/operations/auth.d.ts +4 -4
  14. package/dist/types/operations/backends.d.ts +8 -11
  15. package/dist/types/operations/billing.d.ts +4 -4
  16. package/dist/types/operations/businesses.d.ts +38 -24
  17. package/dist/types/operations/change-sets.d.ts +6 -6
  18. package/dist/types/operations/consumers.d.ts +13 -13
  19. package/dist/types/operations/define.d.ts +6 -2
  20. package/dist/types/operations/environments.d.ts +5 -4
  21. package/dist/types/operations/frontend.d.ts +2 -2
  22. package/dist/types/operations/index.d.ts +308 -182
  23. package/dist/types/operations/maker-tokens.d.ts +9 -9
  24. package/dist/types/operations/organizations.d.ts +21 -21
  25. package/dist/types/operations/personas.d.ts +8 -8
  26. package/dist/types/operations/plans-usage.d.ts +3 -3
  27. package/dist/types/operations/platform.d.ts +12 -12
  28. package/dist/types/operations/portal.d.ts +11 -11
  29. package/dist/types/operations/promo-codes.d.ts +15 -5
  30. package/dist/types/operations/variables.d.ts +22 -8
  31. package/dist/types/operations/webhooks.d.ts +105 -12
  32. package/dist/types/surface-types.d.ts +16 -10
  33. package/dist/types/types.d.ts +3 -0
  34. package/dist/types/version.d.ts +2 -2
  35. package/package.json +1 -1
@@ -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" | "MAX" | "UNIQUE_COUNT" | "LATEST";
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
- /** @default true */
88
- required: boolean;
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;
@@ -2241,6 +2246,19 @@ export interface components {
2241
2246
  /** Format: date-time */
2242
2247
  createdAt: string;
2243
2248
  };
2249
+ DocsCheckIssue: {
2250
+ code: string;
2251
+ message: string;
2252
+ file?: string;
2253
+ line?: number;
2254
+ column?: number;
2255
+ path?: string;
2256
+ /** @enum {string} */
2257
+ severity?: "warning" | "info";
2258
+ };
2259
+ DocsValidateResponse: {
2260
+ issues: components["schemas"]["DocsCheckIssue"][];
2261
+ };
2244
2262
  EconomicAgreement: {
2245
2263
  id: string;
2246
2264
  environmentId: string | null;
@@ -2470,7 +2488,7 @@ export interface components {
2470
2488
  credentialType: "maker_token";
2471
2489
  tokenId: string;
2472
2490
  organizationId: string;
2473
- 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")[];
2474
2492
  /** @enum {string} */
2475
2493
  businessScopeMode: "ALL" | "SELECTED";
2476
2494
  selectedBusinessIds: string[];
@@ -2675,7 +2693,7 @@ export interface components {
2675
2693
  unit: string;
2676
2694
  periodLabel: string;
2677
2695
  } | null;
2678
- stripeConnected: boolean;
2696
+ billingConnected: boolean;
2679
2697
  };
2680
2698
  businesses: components["schemas"]["OrganizationOverviewBusiness"][];
2681
2699
  recentActivity: components["schemas"]["OrganizationOverviewActivity"][];
@@ -2824,7 +2842,7 @@ export interface components {
2824
2842
  unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
2825
2843
  };
2826
2844
  /** @enum {string} */
2827
- 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";
2828
2846
  PortalOffsetPagination: {
2829
2847
  limit: number;
2830
2848
  offset: number;
@@ -3164,6 +3182,7 @@ export interface components {
3164
3182
  };
3165
3183
  PromoCode: {
3166
3184
  id: string;
3185
+ unreadable: boolean;
3167
3186
  code: string;
3168
3187
  kind: ("percent_off" | "amount_off" | "free_months") | null;
3169
3188
  amount: number | null;
@@ -3569,7 +3588,37 @@ export interface components {
3569
3588
  };
3570
3589
  };
3571
3590
  WebhookDeliveryResponse: {
3572
- data: components["schemas"]["WebhookDelivery"];
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
+ };
3573
3622
  };
3574
3623
  WebhookEndpoint: {
3575
3624
  id: string;
@@ -3577,6 +3626,7 @@ export interface components {
3577
3626
  environmentId: string | null;
3578
3627
  events: string[];
3579
3628
  enabled: boolean;
3629
+ signingSecretActionRequired: boolean;
3580
3630
  failCount: number;
3581
3631
  disabledAt: string | null;
3582
3632
  /** Format: date-time */
@@ -3599,6 +3649,7 @@ export interface components {
3599
3649
  environmentId: string | null;
3600
3650
  events: string[];
3601
3651
  enabled: boolean;
3652
+ signingSecretActionRequired: boolean;
3602
3653
  failCount: number;
3603
3654
  disabledAt: string | null;
3604
3655
  /** Format: date-time */
@@ -3625,6 +3676,7 @@ export interface components {
3625
3676
  environmentId: string | null;
3626
3677
  events: string[];
3627
3678
  enabled: boolean;
3679
+ signingSecretActionRequired: boolean;
3628
3680
  failCount: number;
3629
3681
  disabledAt: string | null;
3630
3682
  /** Format: date-time */
@@ -3632,8 +3684,7 @@ export interface components {
3632
3684
  /** Format: date-time */
3633
3685
  updatedAt: string;
3634
3686
  secret: string;
3635
- /** Format: date-time */
3636
- previousSecretExpiresAt: string;
3687
+ previousSecretExpiresAt: string | null;
3637
3688
  };
3638
3689
  WebhookEndpointUpdateResponse: {
3639
3690
  data: components["schemas"]["WebhookEndpoint"];
@@ -1,7 +1,7 @@
1
1
  export { createFartherShore, listOperations, DRY_RUN_NOT_SUPPORTED, UNKNOWN_OPERATION, } from "./surface.js";
2
2
  export type { CreateFartherShoreOptions, FartherShore } from "./surface.js";
3
3
  export type { FartherShoreApi } from "./api.generated.js";
4
- export type { DerivedApi, DryRunPreview, Method, MethodInput, MethodOutput, OperationMeta, } from "./surface-types.js";
4
+ export type { DerivedApi, DryRunPreview, Method, MethodInput, MethodOutput, MethodPreviewOutput, OperationMeta, } from "./surface-types.js";
5
5
  export type { CallOptions, ListQuery, RequestBody, } from "./operations/define.js";
6
6
  export type { MethodPath } from "./operations/index.js";
7
7
  export * from "./types.js";
@@ -12,7 +12,7 @@ export declare const agentOperations: {
12
12
  }, {
13
13
  agents: import("../generated/schemas.js").components["schemas"]["Agent"][];
14
14
  availableRoles: string[];
15
- }>;
15
+ }, false>;
16
16
  "agents.status": import("./define.js").OperationEntry<AgentRef, {
17
17
  id: string;
18
18
  role: string;
@@ -43,7 +43,7 @@ export declare const agentOperations: {
43
43
  actionsCount: number;
44
44
  };
45
45
  catalog: import("../generated/schemas.js").components["schemas"]["AgentCatalogEntry"][];
46
- }>;
46
+ }, false>;
47
47
  "agents.runs.show": import("./define.js").OperationEntry<BusinessRef & {
48
48
  role: string;
49
49
  } & {
@@ -88,7 +88,7 @@ export declare const agentOperations: {
88
88
  };
89
89
  launches: import("../generated/schemas.js").components["schemas"]["AgentLaunch"][];
90
90
  actions: import("../generated/schemas.js").components["schemas"]["AgentAction"][];
91
- }>;
91
+ }, false>;
92
92
  "agents.enable": import("./define.js").OperationEntry<BusinessRef & {
93
93
  role: string;
94
94
  } & {
@@ -109,7 +109,7 @@ export declare const agentOperations: {
109
109
  lastRunAt: string | null;
110
110
  createdAt: string;
111
111
  updatedAt: string;
112
- }>;
112
+ }, false>;
113
113
  "agents.disable": import("./define.js").OperationEntry<BusinessRef & {
114
114
  role: string;
115
115
  } & {
@@ -130,7 +130,7 @@ export declare const agentOperations: {
130
130
  lastRunAt: string | null;
131
131
  createdAt: string;
132
132
  updatedAt: string;
133
- }>;
133
+ }, false>;
134
134
  "bulletin.list": import("./define.js").OperationEntry<BusinessRef & {
135
135
  kind?: string;
136
136
  status?: string;
@@ -142,7 +142,7 @@ export declare const agentOperations: {
142
142
  }, {
143
143
  items: import("../generated/schemas.js").components["schemas"]["BulletinPost"][];
144
144
  nextCursor: string | null;
145
- }>;
145
+ }, false>;
146
146
  "bulletin.read": import("./define.js").OperationEntry<BusinessRef & {
147
147
  postId: string;
148
148
  }, {
@@ -173,7 +173,7 @@ export declare const agentOperations: {
173
173
  changeSetId: string | null;
174
174
  createdAt: string;
175
175
  updatedAt: string;
176
- }>;
176
+ }, false>;
177
177
  "bulletin.ack": import("./define.js").OperationEntry<BusinessRef & {
178
178
  postId: string;
179
179
  }, {
@@ -204,7 +204,7 @@ export declare const agentOperations: {
204
204
  changeSetId: string | null;
205
205
  createdAt: string;
206
206
  updatedAt: string;
207
- }>;
207
+ }, false>;
208
208
  "bulletin.resolve": import("./define.js").OperationEntry<BusinessRef & {
209
209
  postId: string;
210
210
  }, {
@@ -235,6 +235,6 @@ export declare const agentOperations: {
235
235
  changeSetId: string | null;
236
236
  createdAt: string;
237
237
  updatedAt: string;
238
- }>;
238
+ }, false>;
239
239
  };
240
240
  export {};
@@ -27,7 +27,7 @@ export declare const agreementOperations: {
27
27
  offset: number;
28
28
  hasMore: boolean;
29
29
  };
30
- }>;
30
+ }, false>;
31
31
  "agreements.get": import("./define.js").OperationEntry<AgreementRef, {
32
32
  id: string;
33
33
  environmentId: string | null;
@@ -50,7 +50,7 @@ export declare const agreementOperations: {
50
50
  expiresAt: string | null;
51
51
  createdAt: string;
52
52
  contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
53
- }>;
53
+ }, false>;
54
54
  "agreements.pins": import("./define.js").OperationEntry<BusinessRef & {
55
55
  subjectId: string;
56
56
  }, {
@@ -93,7 +93,7 @@ export declare const agreementOperations: {
93
93
  migrateToLatest: {
94
94
  status: "deferred";
95
95
  };
96
- }>;
96
+ }, false>;
97
97
  "agreements.previewCreate": import("./define.js").OperationEntry<BusinessRef & {
98
98
  body: RequestBody;
99
99
  }, {
@@ -102,7 +102,7 @@ export declare const agreementOperations: {
102
102
  }, {
103
103
  effect: import("../generated/schemas.js").components["schemas"]["AgreementCreateEffect"];
104
104
  confirmationToken: string;
105
- }>;
105
+ }, false>;
106
106
  "agreements.create": import("./define.js").OperationEntry<BusinessRef & {
107
107
  body: RequestBody & {
108
108
  confirmationToken: string;
@@ -129,7 +129,7 @@ export declare const agreementOperations: {
129
129
  expiresAt: string | null;
130
130
  createdAt: string;
131
131
  contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
132
- }>;
132
+ }, false>;
133
133
  "agreements.previewAmend": import("./define.js").OperationEntry<BusinessRef & {
134
134
  agreementId: string;
135
135
  } & {
@@ -140,7 +140,7 @@ export declare const agreementOperations: {
140
140
  }, {
141
141
  effect: import("../generated/schemas.js").components["schemas"]["AgreementAmendEffect"];
142
142
  confirmationToken: string;
143
- }>;
143
+ }, false>;
144
144
  "agreements.amend": import("./define.js").OperationEntry<BusinessRef & {
145
145
  agreementId: string;
146
146
  } & {
@@ -169,6 +169,6 @@ export declare const agreementOperations: {
169
169
  expiresAt: string | null;
170
170
  createdAt: string;
171
171
  contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
172
- }>;
172
+ }, false>;
173
173
  };
174
174
  export {};
@@ -8,22 +8,22 @@ export declare const analyticsOperations: {
8
8
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTimeseriesBucket"][];
9
9
  }, {
10
10
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTimeseriesBucket"][];
11
- }>;
11
+ }, false>;
12
12
  "analytics.latency": import("./define.js").OperationEntry<QueryInput, {
13
13
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsPercentileRow"][];
14
14
  }, {
15
15
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsPercentileRow"][];
16
- }>;
16
+ }, false>;
17
17
  "analytics.top": import("./define.js").OperationEntry<QueryInput, {
18
18
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTopKRow"][];
19
19
  }, {
20
20
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTopKRow"][];
21
- }>;
21
+ }, false>;
22
22
  "analytics.log": import("./define.js").OperationEntry<QueryInput, {
23
23
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsEventFeedRow"][];
24
24
  }, {
25
25
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsEventFeedRow"][];
26
- }>;
26
+ }, false>;
27
27
  "analytics.query": import("./define.js").OperationEntry<QueryInput & {
28
28
  verb: string;
29
29
  }, {
@@ -42,6 +42,6 @@ export declare const analyticsOperations: {
42
42
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTimeseriesBucket"][];
43
43
  } | {
44
44
  result: import("../generated/schemas.js").components["schemas"]["AnalyticsTopKRow"][];
45
- }>;
45
+ }, false>;
46
46
  };
47
47
  export {};
@@ -20,7 +20,7 @@ export declare const auditNotificationOperations: {
20
20
  }, {
21
21
  items: import("../generated/schemas.js").components["schemas"]["AuditLogEntry"][];
22
22
  nextCursor: string | null;
23
- }>;
23
+ }, false>;
24
24
  "auditLogs.business.read": import("./define.js").OperationEntry<AuditFilter & {
25
25
  businessId: string;
26
26
  } & {
@@ -31,9 +31,9 @@ export declare const auditNotificationOperations: {
31
31
  }, {
32
32
  items: import("../generated/schemas.js").components["schemas"]["AuditLogEntry"][];
33
33
  nextCursor: string | null;
34
- }>;
35
- "auditLogs.export": import("./define.js").OperationEntry<AuditFilter, string, string>;
36
- "auditLogs.business.export": import("./define.js").OperationEntry<BusinessAuditFilter, string, string>;
34
+ }, false>;
35
+ "auditLogs.export": import("./define.js").OperationEntry<AuditFilter, string, string, false>;
36
+ "auditLogs.business.export": import("./define.js").OperationEntry<BusinessAuditFilter, string, string, false>;
37
37
  "notifications.preferences.read": import("./define.js").OperationEntry<{
38
38
  businessId: string;
39
39
  }, {
@@ -58,7 +58,7 @@ export declare const auditNotificationOperations: {
58
58
  team?: boolean;
59
59
  security?: boolean;
60
60
  };
61
- }>;
61
+ }, false>;
62
62
  "notifications.preferences.update": import("./define.js").OperationEntry<{
63
63
  businessId: string;
64
64
  master?: boolean;
@@ -85,6 +85,6 @@ export declare const auditNotificationOperations: {
85
85
  team?: boolean;
86
86
  security?: boolean;
87
87
  };
88
- }>;
88
+ }, false>;
89
89
  };
90
90
  export {};
@@ -1,6 +1,6 @@
1
1
  import type { CallerContext } from "../types.js";
2
2
  export declare const authOperations: {
3
- "auth.context.read": import("./define.js").OperationEntry<void, CallerContext, CallerContext>;
3
+ "auth.context.read": import("./define.js").OperationEntry<void, CallerContext, CallerContext, false>;
4
4
  "auth.context.issue": import("./define.js").OperationEntry<{
5
5
  businessId: string;
6
6
  externalOrgId: string;
@@ -12,13 +12,13 @@ export declare const authOperations: {
12
12
  }, {
13
13
  token: string;
14
14
  expiresAt: string;
15
- }>;
15
+ }, false>;
16
16
  "auth.listOrganizations": import("./define.js").OperationEntry<void, {
17
17
  userId: string;
18
18
  organizations: import("../generated/schemas.js").components["schemas"]["CliOrganizationSummary"][];
19
19
  }, {
20
20
  userId: string;
21
21
  organizations: import("../generated/schemas.js").components["schemas"]["CliOrganizationSummary"][];
22
- }>;
23
- "auth.selectedOrganization": import("./define.js").OperationEntry<void, string | undefined, string | undefined>;
22
+ }, false>;
23
+ "auth.selectedOrganization": import("./define.js").OperationEntry<void, string | undefined, string | undefined, false>;
24
24
  };
@@ -32,7 +32,7 @@ export declare const backendOperations: {
32
32
  };
33
33
  scope: "all" | "production" | "environment";
34
34
  environmentId: string | null;
35
- }>;
35
+ }, false>;
36
36
  "backends.create": import("./define.js").OperationEntry<BusinessRef & {
37
37
  name: string;
38
38
  slug?: string;
@@ -52,7 +52,6 @@ export declare const backendOperations: {
52
52
  transportMode: "direct" | "tunnel";
53
53
  runner: ("embedded" | "sidecar") | null;
54
54
  runtime: string | null;
55
- verificationRequired: boolean;
56
55
  originUrl: string | null;
57
56
  isDefault: boolean;
58
57
  status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
@@ -72,7 +71,7 @@ export declare const backendOperations: {
72
71
  originUrl: string | null;
73
72
  isDefault: boolean;
74
73
  };
75
- }>;
74
+ }, true>;
76
75
  "backends.bind": import("./define.js").OperationEntry<BusinessRef & {
77
76
  /** The logical backend slug or id. */
78
77
  backend: string;
@@ -87,7 +86,6 @@ export declare const backendOperations: {
87
86
  transportMode: "direct" | "tunnel";
88
87
  runner: ("embedded" | "sidecar") | null;
89
88
  runtime: string | null;
90
- verificationRequired: boolean;
91
89
  originUrl: string | null;
92
90
  isDefault: boolean;
93
91
  status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
@@ -102,13 +100,12 @@ export declare const backendOperations: {
102
100
  transportMode: "direct" | "tunnel";
103
101
  runner: ("embedded" | "sidecar") | null;
104
102
  runtime: string | null;
105
- verificationRequired: boolean;
106
103
  originUrl: string | null;
107
104
  isDefault: boolean;
108
105
  status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
109
106
  lastSeenAt: string | null;
110
107
  createdAt: string;
111
- }>;
108
+ }, true>;
112
109
  "backends.delete": import("./define.js").OperationEntry<BusinessRef & {
113
110
  backendId: string;
114
111
  }, {
@@ -117,7 +114,7 @@ export declare const backendOperations: {
117
114
  }, {
118
115
  id: string;
119
116
  deleted: true;
120
- }>;
117
+ }, false>;
121
118
  "runtimeTokens.read": import("./define.js").OperationEntry<ScopeFilter, {
122
119
  data: import("../generated/schemas.js").components["schemas"]["RuntimeToken"][];
123
120
  pagination: {
@@ -138,7 +135,7 @@ export declare const backendOperations: {
138
135
  };
139
136
  scope: "all" | "production" | "environment";
140
137
  environmentId: string | null;
141
- }>;
138
+ }, false>;
142
139
  "runtimeTokens.mint": import("./define.js").OperationEntry<BusinessRef & {
143
140
  environmentId?: string | null;
144
141
  backendId?: string | null;
@@ -180,7 +177,7 @@ export declare const backendOperations: {
180
177
  lastUsedAt: string | null;
181
178
  envVar: "FS_RUNTIME_TOKEN";
182
179
  token: string;
183
- }>;
180
+ }, false>;
184
181
  "runtimeTokens.rotate": import("./define.js").OperationEntry<BusinessRef & {
185
182
  tokenId: string;
186
183
  }, {
@@ -217,7 +214,7 @@ export declare const backendOperations: {
217
214
  lastUsedAt: string | null;
218
215
  envVar: "FS_RUNTIME_TOKEN";
219
216
  token: string;
220
- }>;
217
+ }, false>;
221
218
  "runtimeTokens.revoke": import("./define.js").OperationEntry<BusinessRef & {
222
219
  tokenId: string;
223
220
  }, {
@@ -250,6 +247,6 @@ export declare const backendOperations: {
250
247
  createdAt: string;
251
248
  revokedAt: string | null;
252
249
  lastUsedAt: string | null;
253
- }>;
250
+ }, false>;
254
251
  };
255
252
  export {};
@@ -15,14 +15,14 @@ export declare const billingOperations: {
15
15
  isOverride: boolean;
16
16
  chargesEnabled: boolean;
17
17
  cardPaymentsEnabled: boolean;
18
- }>;
18
+ }, false>;
19
19
  "billing.stripe.delete": import("./define.js").OperationEntry<BusinessRef & {
20
20
  deleteAccount?: boolean;
21
21
  }, {
22
22
  disconnected: true;
23
23
  }, {
24
24
  disconnected: true;
25
- }>;
25
+ }, false>;
26
26
  "billing.taxSettings.read": import("./define.js").OperationEntry<BusinessRef, {
27
27
  status: "active" | "pending";
28
28
  defaults: {
@@ -43,7 +43,7 @@ export declare const billingOperations: {
43
43
  address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
44
44
  } | null;
45
45
  missingFields: string[];
46
- }>;
46
+ }, false>;
47
47
  "billing.taxSettings.update": import("./define.js").OperationEntry<BusinessRef & {
48
48
  body: RequestBody;
49
49
  }, {
@@ -66,6 +66,6 @@ export declare const billingOperations: {
66
66
  address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
67
67
  } | null;
68
68
  missingFields: string[];
69
- }>;
69
+ }, false>;
70
70
  };
71
71
  export {};