@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.
- package/CHANGELOG.md +10 -0
- package/README.md +8 -4
- package/dist/index.js +64 -221
- package/dist/types/api.generated.d.ts +20 -62
- package/dist/types/generated/schemas.d.ts +117 -284
- package/dist/types/operations/billing.d.ts +4 -4
- package/dist/types/operations/businesses.d.ts +17 -17
- package/dist/types/operations/consumers.d.ts +37 -0
- package/dist/types/operations/index.d.ts +112 -209
- package/dist/types/operations/platform.d.ts +6 -6
- package/dist/types/operations/portal.d.ts +43 -0
- package/dist/types/operations/webhooks.d.ts +2 -2
- package/dist/types/transport.d.ts +2 -0
- package/dist/types/types.d.ts +26 -34
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
- package/dist/types/operations/agreements.d.ts +0 -174
|
@@ -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]: {
|
|
@@ -382,8 +379,6 @@ export interface components {
|
|
|
382
379
|
name: string;
|
|
383
380
|
description?: string;
|
|
384
381
|
details?: string[];
|
|
385
|
-
/** @enum {string} */
|
|
386
|
-
kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
|
|
387
382
|
/** @default [] */
|
|
388
383
|
meters: {
|
|
389
384
|
dimension: string;
|
|
@@ -395,15 +390,10 @@ export interface components {
|
|
|
395
390
|
}[];
|
|
396
391
|
/** @default 0 */
|
|
397
392
|
recurring_fee_cents: number;
|
|
398
|
-
/**
|
|
399
|
-
|
|
400
|
-
* @enum {string}
|
|
401
|
-
*/
|
|
402
|
-
billing_interval: "month" | "year";
|
|
393
|
+
/** @enum {string} */
|
|
394
|
+
billing_interval?: "month" | "year";
|
|
403
395
|
/** @default 0 */
|
|
404
396
|
trial_days: number;
|
|
405
|
-
max_monthly_spend_cents?: number;
|
|
406
|
-
min_monthly_spend_cents?: number;
|
|
407
397
|
/** @default [] */
|
|
408
398
|
limits: {
|
|
409
399
|
dimension: string;
|
|
@@ -444,11 +434,6 @@ export interface components {
|
|
|
444
434
|
resource_limits: {
|
|
445
435
|
[key: string]: number;
|
|
446
436
|
};
|
|
447
|
-
/**
|
|
448
|
-
* @default block
|
|
449
|
-
* @enum {string}
|
|
450
|
-
*/
|
|
451
|
-
overageBehavior: "block" | "allow_and_bill";
|
|
452
437
|
/** @default true */
|
|
453
438
|
selfServeEnabled: boolean;
|
|
454
439
|
capacity?: {
|
|
@@ -512,63 +497,6 @@ export interface components {
|
|
|
512
497
|
require_successor_route: boolean;
|
|
513
498
|
};
|
|
514
499
|
};
|
|
515
|
-
environments?: {
|
|
516
|
-
[key: string]: {
|
|
517
|
-
plans?: {
|
|
518
|
-
[key: string]: {
|
|
519
|
-
meters?: {
|
|
520
|
-
dimension: string;
|
|
521
|
-
/**
|
|
522
|
-
* @default linear
|
|
523
|
-
* @enum {string}
|
|
524
|
-
*/
|
|
525
|
-
kind: "linear" | "active_count" | "event_count";
|
|
526
|
-
}[];
|
|
527
|
-
recurring_fee_cents?: number;
|
|
528
|
-
/** @enum {string} */
|
|
529
|
-
billing_interval?: "month" | "year";
|
|
530
|
-
trial_days?: number;
|
|
531
|
-
max_monthly_spend_cents?: number;
|
|
532
|
-
limits?: {
|
|
533
|
-
dimension: string;
|
|
534
|
-
window: {
|
|
535
|
-
/** @constant */
|
|
536
|
-
type: "named";
|
|
537
|
-
/** @enum {string} */
|
|
538
|
-
name: "second" | "minute" | "hour" | "day" | "week" | "month";
|
|
539
|
-
} | {
|
|
540
|
-
/** @constant */
|
|
541
|
-
type: "custom";
|
|
542
|
-
seconds: number;
|
|
543
|
-
label?: string;
|
|
544
|
-
};
|
|
545
|
-
capacity: number;
|
|
546
|
-
/** @enum {string} */
|
|
547
|
-
enforcement?: "enforce" | "track";
|
|
548
|
-
warnAt?: number;
|
|
549
|
-
/** @enum {string} */
|
|
550
|
-
strategy?: "fixed_window" | "sliding_window" | "token_bucket";
|
|
551
|
-
bucketCapacity?: number;
|
|
552
|
-
refillRatePerSecond?: number;
|
|
553
|
-
scope?: {
|
|
554
|
-
endpoint?: string;
|
|
555
|
-
apiKey?: string;
|
|
556
|
-
workspace?: string;
|
|
557
|
-
region?: string;
|
|
558
|
-
actor?: {
|
|
559
|
-
/** @enum {string} */
|
|
560
|
-
kind: "member" | "service_account";
|
|
561
|
-
};
|
|
562
|
-
};
|
|
563
|
-
acknowledgeUnreachable?: boolean;
|
|
564
|
-
}[];
|
|
565
|
-
/** @enum {string} */
|
|
566
|
-
overageBehavior?: "block" | "allow_and_bill";
|
|
567
|
-
selfServeEnabled?: boolean;
|
|
568
|
-
};
|
|
569
|
-
};
|
|
570
|
-
};
|
|
571
|
-
};
|
|
572
500
|
ephemeral?: {
|
|
573
501
|
defaultPlan?: string;
|
|
574
502
|
};
|
|
@@ -707,84 +635,13 @@ export interface components {
|
|
|
707
635
|
};
|
|
708
636
|
catalog: components["schemas"]["AgentCatalogEntry"][];
|
|
709
637
|
};
|
|
710
|
-
AgreementAmendEffect: {
|
|
711
|
-
/** @constant */
|
|
712
|
-
kind: "amend";
|
|
713
|
-
agreementId: string;
|
|
714
|
-
subjectId: string;
|
|
715
|
-
pricingPolicyId: string;
|
|
716
|
-
pricingPolicyVersionId: string;
|
|
717
|
-
currentVersion: {
|
|
718
|
-
id: string;
|
|
719
|
-
version: number;
|
|
720
|
-
};
|
|
721
|
-
nextVersion: number;
|
|
722
|
-
terms: components["schemas"]["ContractTerms"];
|
|
723
|
-
bounds: components["schemas"]["ContractTermsBounds"];
|
|
724
|
-
ownedNamespaces: string[];
|
|
725
|
-
effectiveAt: string | null;
|
|
726
|
-
};
|
|
727
|
-
AgreementAmendPreview: {
|
|
728
|
-
effect: components["schemas"]["AgreementAmendEffect"];
|
|
729
|
-
/** @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. */
|
|
730
|
-
confirmationToken: string;
|
|
731
|
-
};
|
|
732
|
-
AgreementCreateEffect: {
|
|
733
|
-
/** @constant */
|
|
734
|
-
kind: "create";
|
|
735
|
-
environmentId: string | null;
|
|
736
|
-
subjectId: string;
|
|
737
|
-
binding: {
|
|
738
|
-
/** @enum {string} */
|
|
739
|
-
mode: "current" | "current_with_contract_terms" | "fixed_version";
|
|
740
|
-
pricingPolicyId: string;
|
|
741
|
-
pricingPolicyKey: string;
|
|
742
|
-
pricingPolicyVersionId: string;
|
|
743
|
-
pricingPolicyVersion: number;
|
|
744
|
-
};
|
|
745
|
-
/** @enum {string} */
|
|
746
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
747
|
-
/** @enum {string} */
|
|
748
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
749
|
-
terms?: components["schemas"]["ContractTerms"];
|
|
750
|
-
bounds: components["schemas"]["ContractTermsBounds"];
|
|
751
|
-
ownedNamespaces: string[];
|
|
752
|
-
agreedBasis: {
|
|
753
|
-
measurementRuleIds: string[];
|
|
754
|
-
measureSetByRuleId: {
|
|
755
|
-
[key: string]: string[];
|
|
756
|
-
};
|
|
757
|
-
};
|
|
758
|
-
effectiveAt: string | null;
|
|
759
|
-
expiresAt: string | null;
|
|
760
|
-
};
|
|
761
|
-
AgreementCreatePreview: {
|
|
762
|
-
effect: components["schemas"]["AgreementCreateEffect"];
|
|
763
|
-
/** @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. */
|
|
764
|
-
confirmationToken: string;
|
|
765
|
-
};
|
|
766
|
-
AgreementUsagePricingBinding: {
|
|
767
|
-
/** @constant */
|
|
768
|
-
mode: "current";
|
|
769
|
-
pricingPolicyId: string;
|
|
770
|
-
} | {
|
|
771
|
-
/** @constant */
|
|
772
|
-
mode: "current_with_contract_terms";
|
|
773
|
-
pricingPolicyId: string;
|
|
774
|
-
contractPricingVersionId: string;
|
|
775
|
-
} | {
|
|
776
|
-
/** @constant */
|
|
777
|
-
mode: "fixed_version";
|
|
778
|
-
pricingPolicyId: string;
|
|
779
|
-
pricingPolicyVersionId: string;
|
|
780
|
-
};
|
|
781
638
|
AnalyticsEventFeedResponse: {
|
|
782
639
|
result: components["schemas"]["AnalyticsEventFeedRow"][];
|
|
783
640
|
};
|
|
784
641
|
AnalyticsEventFeedRow: {
|
|
785
642
|
id: string;
|
|
786
643
|
/** @enum {string} */
|
|
787
|
-
type: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
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";
|
|
788
645
|
/** Format: date-time */
|
|
789
646
|
occurredAt: string;
|
|
790
647
|
environmentId: string | null;
|
|
@@ -984,7 +841,7 @@ export interface components {
|
|
|
984
841
|
name: string;
|
|
985
842
|
trigger: {
|
|
986
843
|
/** @enum {string} */
|
|
987
|
-
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
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";
|
|
988
845
|
filter?: {
|
|
989
846
|
subjectType?: string;
|
|
990
847
|
subjectId?: string;
|
|
@@ -1135,9 +992,18 @@ export interface components {
|
|
|
1135
992
|
organization: components["schemas"]["BuilderContextOrganization"];
|
|
1136
993
|
role: string;
|
|
1137
994
|
}[];
|
|
1138
|
-
effectivePermissions: ("agent:configure" | "agent:read" | "
|
|
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")[];
|
|
1139
996
|
shouldPersistActiveOrganization: boolean;
|
|
1140
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;
|
|
1141
1007
|
features: {
|
|
1142
1008
|
team?: boolean;
|
|
1143
1009
|
};
|
|
@@ -1171,8 +1037,6 @@ export interface components {
|
|
|
1171
1037
|
name: string;
|
|
1172
1038
|
description?: string;
|
|
1173
1039
|
details?: string[];
|
|
1174
|
-
/** @enum {string} */
|
|
1175
|
-
kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
|
|
1176
1040
|
/** @default [] */
|
|
1177
1041
|
meters: {
|
|
1178
1042
|
dimension: string;
|
|
@@ -1184,15 +1048,10 @@ export interface components {
|
|
|
1184
1048
|
}[];
|
|
1185
1049
|
/** @default 0 */
|
|
1186
1050
|
recurring_fee_cents: number;
|
|
1187
|
-
/**
|
|
1188
|
-
|
|
1189
|
-
* @enum {string}
|
|
1190
|
-
*/
|
|
1191
|
-
billing_interval: "month" | "year";
|
|
1051
|
+
/** @enum {string} */
|
|
1052
|
+
billing_interval?: "month" | "year";
|
|
1192
1053
|
/** @default 0 */
|
|
1193
1054
|
trial_days: number;
|
|
1194
|
-
max_monthly_spend_cents?: number;
|
|
1195
|
-
min_monthly_spend_cents?: number;
|
|
1196
1055
|
/** @default [] */
|
|
1197
1056
|
limits: {
|
|
1198
1057
|
dimension: string;
|
|
@@ -1233,11 +1092,6 @@ export interface components {
|
|
|
1233
1092
|
resource_limits: {
|
|
1234
1093
|
[key: string]: number;
|
|
1235
1094
|
};
|
|
1236
|
-
/**
|
|
1237
|
-
* @default block
|
|
1238
|
-
* @enum {string}
|
|
1239
|
-
*/
|
|
1240
|
-
overageBehavior: "block" | "allow_and_bill";
|
|
1241
1095
|
/** @default true */
|
|
1242
1096
|
selfServeEnabled: boolean;
|
|
1243
1097
|
capacity?: {
|
|
@@ -1454,6 +1308,9 @@ export interface components {
|
|
|
1454
1308
|
createdAt: string;
|
|
1455
1309
|
/** Format: date-time */
|
|
1456
1310
|
updatedAt: string;
|
|
1311
|
+
usageUnitLabels?: {
|
|
1312
|
+
[key: string]: string;
|
|
1313
|
+
};
|
|
1457
1314
|
environments: components["schemas"]["BusinessEnvironment"][];
|
|
1458
1315
|
};
|
|
1459
1316
|
BusinessDiagnostic: {
|
|
@@ -1509,8 +1366,6 @@ export interface components {
|
|
|
1509
1366
|
name: string;
|
|
1510
1367
|
description?: string;
|
|
1511
1368
|
details?: string[];
|
|
1512
|
-
/** @enum {string} */
|
|
1513
|
-
kind: "free" | "flat" | "usage" | "prepaid" | "hybrid" | "trial" | "custom";
|
|
1514
1369
|
/** @default [] */
|
|
1515
1370
|
meters: {
|
|
1516
1371
|
dimension: string;
|
|
@@ -1522,15 +1377,10 @@ export interface components {
|
|
|
1522
1377
|
}[];
|
|
1523
1378
|
/** @default 0 */
|
|
1524
1379
|
recurring_fee_cents: number;
|
|
1525
|
-
/**
|
|
1526
|
-
|
|
1527
|
-
* @enum {string}
|
|
1528
|
-
*/
|
|
1529
|
-
billing_interval: "month" | "year";
|
|
1380
|
+
/** @enum {string} */
|
|
1381
|
+
billing_interval?: "month" | "year";
|
|
1530
1382
|
/** @default 0 */
|
|
1531
1383
|
trial_days: number;
|
|
1532
|
-
max_monthly_spend_cents?: number;
|
|
1533
|
-
min_monthly_spend_cents?: number;
|
|
1534
1384
|
/** @default [] */
|
|
1535
1385
|
limits: {
|
|
1536
1386
|
dimension: string;
|
|
@@ -1571,11 +1421,6 @@ export interface components {
|
|
|
1571
1421
|
resource_limits: {
|
|
1572
1422
|
[key: string]: number;
|
|
1573
1423
|
};
|
|
1574
|
-
/**
|
|
1575
|
-
* @default block
|
|
1576
|
-
* @enum {string}
|
|
1577
|
-
*/
|
|
1578
|
-
overageBehavior: "block" | "allow_and_bill";
|
|
1579
1424
|
/** @default true */
|
|
1580
1425
|
selfServeEnabled: boolean;
|
|
1581
1426
|
capacity?: {
|
|
@@ -1660,6 +1505,26 @@ export interface components {
|
|
|
1660
1505
|
key: string;
|
|
1661
1506
|
environmentId: string | null;
|
|
1662
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
|
+
};
|
|
1663
1528
|
BusinessValidateResponse: {
|
|
1664
1529
|
success: boolean;
|
|
1665
1530
|
environment: {
|
|
@@ -1979,6 +1844,28 @@ export interface components {
|
|
|
1979
1844
|
ConsumerApiKeyList: {
|
|
1980
1845
|
apiKeys: components["schemas"]["ConsumerApiKey"][];
|
|
1981
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
|
+
};
|
|
1982
1869
|
ConsumerBlockResponse: {
|
|
1983
1870
|
/** @constant */
|
|
1984
1871
|
blocked: true;
|
|
@@ -2089,13 +1976,6 @@ export interface components {
|
|
|
2089
1976
|
kind: "linear" | "active_count" | "event_count";
|
|
2090
1977
|
}[];
|
|
2091
1978
|
};
|
|
2092
|
-
ContractPricingVersion: {
|
|
2093
|
-
id: string;
|
|
2094
|
-
version: number;
|
|
2095
|
-
terms: components["schemas"]["ContractTerms"];
|
|
2096
|
-
effectiveAt: string;
|
|
2097
|
-
createdAt: string;
|
|
2098
|
-
};
|
|
2099
1979
|
ContractRoute: {
|
|
2100
1980
|
routeId: string;
|
|
2101
1981
|
method: string;
|
|
@@ -2104,38 +1984,6 @@ export interface components {
|
|
|
2104
1984
|
meters: string[];
|
|
2105
1985
|
grantedBy: string[];
|
|
2106
1986
|
};
|
|
2107
|
-
ContractTerms: {
|
|
2108
|
-
percentDiscount?: {
|
|
2109
|
-
num: string;
|
|
2110
|
-
den: string;
|
|
2111
|
-
};
|
|
2112
|
-
floorNanos?: string;
|
|
2113
|
-
capNanos?: string;
|
|
2114
|
-
selectorScope: ({
|
|
2115
|
-
/** @constant */
|
|
2116
|
-
kind: "catalog_item";
|
|
2117
|
-
item: {
|
|
2118
|
-
provider: string;
|
|
2119
|
-
model: string;
|
|
2120
|
-
modality?: string;
|
|
2121
|
-
};
|
|
2122
|
-
} | {
|
|
2123
|
-
/** @constant */
|
|
2124
|
-
kind: "provider_model_glob";
|
|
2125
|
-
provider: string;
|
|
2126
|
-
modelGlob: string;
|
|
2127
|
-
modality?: string;
|
|
2128
|
-
})[];
|
|
2129
|
-
};
|
|
2130
|
-
ContractTermsBounds: {
|
|
2131
|
-
maxPercentDiscount?: {
|
|
2132
|
-
num: string;
|
|
2133
|
-
den: string;
|
|
2134
|
-
};
|
|
2135
|
-
minFloorNanos?: string;
|
|
2136
|
-
maxCapNanos?: string;
|
|
2137
|
-
requireFloorWithDiscount?: boolean;
|
|
2138
|
-
};
|
|
2139
1987
|
CustomPermissionSubject: {
|
|
2140
1988
|
subject: string;
|
|
2141
1989
|
verbs: string[];
|
|
@@ -2254,29 +2102,6 @@ export interface components {
|
|
|
2254
2102
|
DocsValidateResponse: {
|
|
2255
2103
|
issues: components["schemas"]["DocsCheckIssue"][];
|
|
2256
2104
|
};
|
|
2257
|
-
EconomicAgreement: {
|
|
2258
|
-
id: string;
|
|
2259
|
-
environmentId: string | null;
|
|
2260
|
-
subjectId: string;
|
|
2261
|
-
usagePricingBinding: components["schemas"]["AgreementUsagePricingBinding"];
|
|
2262
|
-
/** @enum {string} */
|
|
2263
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
2264
|
-
/** @enum {string} */
|
|
2265
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
2266
|
-
effectiveAt: string;
|
|
2267
|
-
expiresAt: string | null;
|
|
2268
|
-
createdAt: string;
|
|
2269
|
-
contractPricingVersions: components["schemas"]["ContractPricingVersion"][];
|
|
2270
|
-
};
|
|
2271
|
-
EconomicAgreementList: {
|
|
2272
|
-
data: components["schemas"]["EconomicAgreement"][];
|
|
2273
|
-
pagination: {
|
|
2274
|
-
total: number;
|
|
2275
|
-
limit: number;
|
|
2276
|
-
offset: number;
|
|
2277
|
-
hasMore: boolean;
|
|
2278
|
-
};
|
|
2279
|
-
};
|
|
2280
2105
|
FrontendBuild: {
|
|
2281
2106
|
id: string;
|
|
2282
2107
|
/** @enum {string} */
|
|
@@ -2355,7 +2180,7 @@ export interface components {
|
|
|
2355
2180
|
updatedAt: string;
|
|
2356
2181
|
};
|
|
2357
2182
|
/** @enum {string} */
|
|
2358
|
-
MakerDelegablePermission: "agent:configure" | "agent:read" | "
|
|
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";
|
|
2359
2184
|
MakerTokenBusinessScopeSummary: {
|
|
2360
2185
|
/** @constant */
|
|
2361
2186
|
mode: "ALL";
|
|
@@ -2434,16 +2259,6 @@ export interface components {
|
|
|
2434
2259
|
data: components["schemas"]["Business"][];
|
|
2435
2260
|
total: number;
|
|
2436
2261
|
};
|
|
2437
|
-
ManagementRollbackRequest: {
|
|
2438
|
-
publishId: string;
|
|
2439
|
-
reason?: string;
|
|
2440
|
-
};
|
|
2441
|
-
ManagementRollbackResponse: {
|
|
2442
|
-
businessId: string;
|
|
2443
|
-
/** @constant */
|
|
2444
|
-
status: "enqueued";
|
|
2445
|
-
rollbackPublishId: string;
|
|
2446
|
-
};
|
|
2447
2262
|
ManagementUsageLimit: {
|
|
2448
2263
|
id: string;
|
|
2449
2264
|
subscriberId: string;
|
|
@@ -2493,7 +2308,7 @@ export interface components {
|
|
|
2493
2308
|
credentialType: "maker_token";
|
|
2494
2309
|
tokenId: string;
|
|
2495
2310
|
organizationId: string;
|
|
2496
|
-
grantedPermissions: ("agent:configure" | "agent:read" | "
|
|
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")[];
|
|
2497
2312
|
/** @enum {string} */
|
|
2498
2313
|
businessScopeMode: "ALL" | "SELECTED";
|
|
2499
2314
|
selectedBusinessIds: string[];
|
|
@@ -2847,7 +2662,35 @@ export interface components {
|
|
|
2847
2662
|
unreadable?: components["schemas"]["BusinessUnreadablePlan"][];
|
|
2848
2663
|
};
|
|
2849
2664
|
/** @enum {string} */
|
|
2850
|
-
PlatformPermission: "agent:configure" | "agent:read" | "
|
|
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
|
+
};
|
|
2851
2694
|
PortalOffsetPagination: {
|
|
2852
2695
|
limit: number;
|
|
2853
2696
|
offset: number;
|
|
@@ -3403,41 +3246,13 @@ export interface components {
|
|
|
3403
3246
|
};
|
|
3404
3247
|
StripeConnectionStatus: {
|
|
3405
3248
|
connected: boolean;
|
|
3249
|
+
/** @constant */
|
|
3250
|
+
reconnectRequired?: true;
|
|
3406
3251
|
/** @enum {string} */
|
|
3407
|
-
source: "
|
|
3408
|
-
isOverride: boolean;
|
|
3252
|
+
source: "organization";
|
|
3409
3253
|
chargesEnabled: boolean;
|
|
3410
3254
|
cardPaymentsEnabled: boolean;
|
|
3411
3255
|
};
|
|
3412
|
-
StripeDisconnectResponse: {
|
|
3413
|
-
/** @constant */
|
|
3414
|
-
disconnected: true;
|
|
3415
|
-
};
|
|
3416
|
-
SubjectPins: {
|
|
3417
|
-
subjectId: string;
|
|
3418
|
-
environmentId: string | null;
|
|
3419
|
-
recurringPricePin: {
|
|
3420
|
-
planKey: string;
|
|
3421
|
-
version: number;
|
|
3422
|
-
recurringFeeCents: number;
|
|
3423
|
-
billingInterval: string;
|
|
3424
|
-
} | null;
|
|
3425
|
-
usagePricingBinding: {
|
|
3426
|
-
/** @constant */
|
|
3427
|
-
source: "agreement";
|
|
3428
|
-
agreementId: string;
|
|
3429
|
-
binding: components["schemas"]["AgreementUsagePricingBinding"];
|
|
3430
|
-
} | {
|
|
3431
|
-
/** @constant */
|
|
3432
|
-
source: "plan_default";
|
|
3433
|
-
/** @constant */
|
|
3434
|
-
mode: "current";
|
|
3435
|
-
};
|
|
3436
|
-
migrateToLatest: {
|
|
3437
|
-
/** @constant */
|
|
3438
|
-
status: "deferred";
|
|
3439
|
-
};
|
|
3440
|
-
};
|
|
3441
3256
|
TaxAddress: {
|
|
3442
3257
|
line1: string | null;
|
|
3443
3258
|
line2: string | null;
|
|
@@ -3522,6 +3337,24 @@ export interface components {
|
|
|
3522
3337
|
rotatedAt: string;
|
|
3523
3338
|
};
|
|
3524
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
|
+
};
|
|
3525
3358
|
UsageLimitPlan: {
|
|
3526
3359
|
key: string;
|
|
3527
3360
|
version: number;
|
|
@@ -3698,7 +3531,7 @@ export interface components {
|
|
|
3698
3531
|
data: {
|
|
3699
3532
|
events: {
|
|
3700
3533
|
/** @enum {string} */
|
|
3701
|
-
name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "customer.created" | "customer.deleted" | "customer.member.added" | "customer.member.updated" | "customer.member.removed";
|
|
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";
|
|
3702
3535
|
description: string;
|
|
3703
3536
|
}[];
|
|
3704
3537
|
};
|