@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
|
@@ -5,14 +5,14 @@ type BusinessRef = {
|
|
|
5
5
|
export declare const billingOperations: {
|
|
6
6
|
"billing.stripe.read": import("./define.js").OperationEntry<BusinessRef, {
|
|
7
7
|
connected: boolean;
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
reconnectRequired?: true;
|
|
9
|
+
source: "organization";
|
|
10
10
|
chargesEnabled: boolean;
|
|
11
11
|
cardPaymentsEnabled: boolean;
|
|
12
12
|
}, {
|
|
13
13
|
connected: boolean;
|
|
14
|
-
|
|
15
|
-
|
|
14
|
+
reconnectRequired?: true;
|
|
15
|
+
source: "organization";
|
|
16
16
|
chargesEnabled: boolean;
|
|
17
17
|
cardPaymentsEnabled: boolean;
|
|
18
18
|
}, false>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { BrandAssetUploadResult, PublishBusinessBody } from "../types.js";
|
|
2
|
-
import { type ListQuery
|
|
1
|
+
import type { BrandAssetUploadResult, BusinessUpdateInput, PublishBusinessBody } from "../types.js";
|
|
2
|
+
import { type ListQuery } from "./define.js";
|
|
3
3
|
type BusinessRef = {
|
|
4
4
|
businessId: string;
|
|
5
5
|
};
|
|
@@ -108,6 +108,9 @@ export declare const businessOperations: {
|
|
|
108
108
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
109
109
|
createdAt: string;
|
|
110
110
|
updatedAt: string;
|
|
111
|
+
usageUnitLabels?: {
|
|
112
|
+
[key: string]: string;
|
|
113
|
+
};
|
|
111
114
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
112
115
|
}, {
|
|
113
116
|
id: string;
|
|
@@ -139,6 +142,9 @@ export declare const businessOperations: {
|
|
|
139
142
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
140
143
|
createdAt: string;
|
|
141
144
|
updatedAt: string;
|
|
145
|
+
usageUnitLabels?: {
|
|
146
|
+
[key: string]: string;
|
|
147
|
+
};
|
|
142
148
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
143
149
|
}, false>;
|
|
144
150
|
"businesses.create": import("./define.js").OperationEntry<{
|
|
@@ -342,18 +348,6 @@ export declare const businessOperations: {
|
|
|
342
348
|
updatedAt: string;
|
|
343
349
|
_release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
|
|
344
350
|
}, true>;
|
|
345
|
-
"businesses.rollback": import("./define.js").OperationEntry<BusinessRef & {
|
|
346
|
-
publishId: string;
|
|
347
|
-
reason?: string;
|
|
348
|
-
}, {
|
|
349
|
-
businessId: string;
|
|
350
|
-
status: "enqueued";
|
|
351
|
-
rollbackPublishId: string;
|
|
352
|
-
}, {
|
|
353
|
-
businessId: string;
|
|
354
|
-
status: "enqueued";
|
|
355
|
-
rollbackPublishId: string;
|
|
356
|
-
}, false>;
|
|
357
351
|
"businesses.compile": import("./define.js").OperationEntry<BusinessRef & {
|
|
358
352
|
ir: unknown;
|
|
359
353
|
env?: string;
|
|
@@ -404,7 +398,7 @@ export declare const businessOperations: {
|
|
|
404
398
|
"businesses.brand.update": import("./define.js").OperationEntry<BusinessRef & {
|
|
405
399
|
env?: string;
|
|
406
400
|
} & {
|
|
407
|
-
body:
|
|
401
|
+
body: BusinessUpdateInput;
|
|
408
402
|
}, {
|
|
409
403
|
id: string;
|
|
410
404
|
organizationId: string | null;
|
|
@@ -477,7 +471,7 @@ export declare const businessOperations: {
|
|
|
477
471
|
"businesses.previewEnv.set": import("./define.js").OperationEntry<BusinessRef & {
|
|
478
472
|
env?: string;
|
|
479
473
|
} & {
|
|
480
|
-
body:
|
|
474
|
+
body: BusinessUpdateInput;
|
|
481
475
|
}, {
|
|
482
476
|
id: string;
|
|
483
477
|
organizationId: string | null;
|
|
@@ -664,7 +658,7 @@ export declare const businessOperations: {
|
|
|
664
658
|
"businesses.cors.update": import("./define.js").OperationEntry<BusinessRef & {
|
|
665
659
|
env?: string;
|
|
666
660
|
} & {
|
|
667
|
-
body:
|
|
661
|
+
body: BusinessUpdateInput;
|
|
668
662
|
}, {
|
|
669
663
|
id: string;
|
|
670
664
|
organizationId: string | null;
|
|
@@ -756,6 +750,9 @@ export declare const businessOperations: {
|
|
|
756
750
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
757
751
|
createdAt: string;
|
|
758
752
|
updatedAt: string;
|
|
753
|
+
usageUnitLabels?: {
|
|
754
|
+
[key: string]: string;
|
|
755
|
+
};
|
|
759
756
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
760
757
|
}, {
|
|
761
758
|
id: string;
|
|
@@ -787,6 +784,9 @@ export declare const businessOperations: {
|
|
|
787
784
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
788
785
|
createdAt: string;
|
|
789
786
|
updatedAt: string;
|
|
787
|
+
usageUnitLabels?: {
|
|
788
|
+
[key: string]: string;
|
|
789
|
+
};
|
|
790
790
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
791
791
|
}, false>;
|
|
792
792
|
"businesses.rbac.enable": import("./define.js").OperationEntry<BusinessRef, {
|
|
@@ -161,6 +161,43 @@ export declare const consumerOperations: {
|
|
|
161
161
|
}, {
|
|
162
162
|
apiKeys: import("../generated/schemas.js").components["schemas"]["ConsumerApiKey"][];
|
|
163
163
|
}, false>;
|
|
164
|
+
"consumers.balance.read": import("./define.js").OperationEntry<SubscriberRef, {
|
|
165
|
+
subscriberId: string;
|
|
166
|
+
balances: {
|
|
167
|
+
unit: {
|
|
168
|
+
key: string;
|
|
169
|
+
kind: "money" | "credits";
|
|
170
|
+
code: string;
|
|
171
|
+
displayName: string;
|
|
172
|
+
};
|
|
173
|
+
available: string;
|
|
174
|
+
granted: string;
|
|
175
|
+
revoked: string;
|
|
176
|
+
consumed: string;
|
|
177
|
+
exhausted: boolean;
|
|
178
|
+
source: "live" | "estimate";
|
|
179
|
+
asOf: string;
|
|
180
|
+
environment: string | null;
|
|
181
|
+
}[];
|
|
182
|
+
}, {
|
|
183
|
+
subscriberId: string;
|
|
184
|
+
balances: {
|
|
185
|
+
unit: {
|
|
186
|
+
key: string;
|
|
187
|
+
kind: "money" | "credits";
|
|
188
|
+
code: string;
|
|
189
|
+
displayName: string;
|
|
190
|
+
};
|
|
191
|
+
available: string;
|
|
192
|
+
granted: string;
|
|
193
|
+
revoked: string;
|
|
194
|
+
consumed: string;
|
|
195
|
+
exhausted: boolean;
|
|
196
|
+
source: "live" | "estimate";
|
|
197
|
+
asOf: string;
|
|
198
|
+
environment: string | null;
|
|
199
|
+
}[];
|
|
200
|
+
}, false>;
|
|
164
201
|
"consumers.apiKeys.revoke": import("./define.js").OperationEntry<SubscriberRef & {
|
|
165
202
|
keyId: string;
|
|
166
203
|
}, void, void, false>;
|
|
@@ -95,14 +95,14 @@ export declare const OPERATION_TABLE: {
|
|
|
95
95
|
}, {
|
|
96
96
|
data: {
|
|
97
97
|
events: {
|
|
98
|
-
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";
|
|
98
|
+
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";
|
|
99
99
|
description: string;
|
|
100
100
|
}[];
|
|
101
101
|
};
|
|
102
102
|
}, {
|
|
103
103
|
data: {
|
|
104
104
|
events: {
|
|
105
|
-
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";
|
|
105
|
+
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";
|
|
106
106
|
description: string;
|
|
107
107
|
}[];
|
|
108
108
|
};
|
|
@@ -754,6 +754,51 @@ export declare const OPERATION_TABLE: {
|
|
|
754
754
|
} & {
|
|
755
755
|
serviceAccountId: string;
|
|
756
756
|
}, void, void, false>;
|
|
757
|
+
"portal.balance.read": import("./define.js").OperationEntry<{
|
|
758
|
+
businessId: string;
|
|
759
|
+
}, {
|
|
760
|
+
disclosure: "transparent";
|
|
761
|
+
balances: import("../generated/schemas.js").components["schemas"]["UnitBalance"][];
|
|
762
|
+
} | {
|
|
763
|
+
disclosure: "opaque";
|
|
764
|
+
balances: {
|
|
765
|
+
unit: {
|
|
766
|
+
key: string;
|
|
767
|
+
kind: "money" | "credits";
|
|
768
|
+
code: string;
|
|
769
|
+
displayName: string;
|
|
770
|
+
};
|
|
771
|
+
display: {
|
|
772
|
+
kind: "fraction";
|
|
773
|
+
consumedBasisPoints: number;
|
|
774
|
+
remainingBasisPoints: number;
|
|
775
|
+
};
|
|
776
|
+
exhausted: boolean;
|
|
777
|
+
source: "live" | "estimate";
|
|
778
|
+
asOf: string;
|
|
779
|
+
}[];
|
|
780
|
+
}, {
|
|
781
|
+
disclosure: "transparent";
|
|
782
|
+
balances: import("../generated/schemas.js").components["schemas"]["UnitBalance"][];
|
|
783
|
+
} | {
|
|
784
|
+
disclosure: "opaque";
|
|
785
|
+
balances: {
|
|
786
|
+
unit: {
|
|
787
|
+
key: string;
|
|
788
|
+
kind: "money" | "credits";
|
|
789
|
+
code: string;
|
|
790
|
+
displayName: string;
|
|
791
|
+
};
|
|
792
|
+
display: {
|
|
793
|
+
kind: "fraction";
|
|
794
|
+
consumedBasisPoints: number;
|
|
795
|
+
remainingBasisPoints: number;
|
|
796
|
+
};
|
|
797
|
+
exhausted: boolean;
|
|
798
|
+
source: "live" | "estimate";
|
|
799
|
+
asOf: string;
|
|
800
|
+
}[];
|
|
801
|
+
}, false>;
|
|
757
802
|
"portal.usageLimits.list": import("./define.js").OperationEntry<{
|
|
758
803
|
businessId: string;
|
|
759
804
|
} & {
|
|
@@ -1224,7 +1269,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1224
1269
|
}, {
|
|
1225
1270
|
name: string;
|
|
1226
1271
|
trigger: {
|
|
1227
|
-
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";
|
|
1272
|
+
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";
|
|
1228
1273
|
filter?: {
|
|
1229
1274
|
subjectType?: string;
|
|
1230
1275
|
subjectId?: string;
|
|
@@ -1269,7 +1314,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1269
1314
|
}, {
|
|
1270
1315
|
name: string;
|
|
1271
1316
|
trigger: {
|
|
1272
|
-
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";
|
|
1317
|
+
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";
|
|
1273
1318
|
filter?: {
|
|
1274
1319
|
subjectType?: string;
|
|
1275
1320
|
subjectId?: string;
|
|
@@ -1319,7 +1364,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1319
1364
|
}, {
|
|
1320
1365
|
name: string;
|
|
1321
1366
|
trigger: {
|
|
1322
|
-
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";
|
|
1367
|
+
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";
|
|
1323
1368
|
filter?: {
|
|
1324
1369
|
subjectType?: string;
|
|
1325
1370
|
subjectId?: string;
|
|
@@ -1364,7 +1409,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1364
1409
|
}, {
|
|
1365
1410
|
name: string;
|
|
1366
1411
|
trigger: {
|
|
1367
|
-
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";
|
|
1412
|
+
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";
|
|
1368
1413
|
filter?: {
|
|
1369
1414
|
subjectType?: string;
|
|
1370
1415
|
subjectId?: string;
|
|
@@ -1415,7 +1460,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1415
1460
|
}, {
|
|
1416
1461
|
name: string;
|
|
1417
1462
|
trigger: {
|
|
1418
|
-
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";
|
|
1463
|
+
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";
|
|
1419
1464
|
filter?: {
|
|
1420
1465
|
subjectType?: string;
|
|
1421
1466
|
subjectId?: string;
|
|
@@ -1460,7 +1505,7 @@ export declare const OPERATION_TABLE: {
|
|
|
1460
1505
|
}, {
|
|
1461
1506
|
name: string;
|
|
1462
1507
|
trigger: {
|
|
1463
|
-
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";
|
|
1508
|
+
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";
|
|
1464
1509
|
filter?: {
|
|
1465
1510
|
subjectType?: string;
|
|
1466
1511
|
subjectId?: string;
|
|
@@ -2614,6 +2659,46 @@ export declare const OPERATION_TABLE: {
|
|
|
2614
2659
|
}, {
|
|
2615
2660
|
apiKeys: import("../generated/schemas.js").components["schemas"]["ConsumerApiKey"][];
|
|
2616
2661
|
}, false>;
|
|
2662
|
+
"consumers.balance.read": import("./define.js").OperationEntry<{
|
|
2663
|
+
businessId: string;
|
|
2664
|
+
subscriberId: string;
|
|
2665
|
+
}, {
|
|
2666
|
+
subscriberId: string;
|
|
2667
|
+
balances: {
|
|
2668
|
+
unit: {
|
|
2669
|
+
key: string;
|
|
2670
|
+
kind: "money" | "credits";
|
|
2671
|
+
code: string;
|
|
2672
|
+
displayName: string;
|
|
2673
|
+
};
|
|
2674
|
+
available: string;
|
|
2675
|
+
granted: string;
|
|
2676
|
+
revoked: string;
|
|
2677
|
+
consumed: string;
|
|
2678
|
+
exhausted: boolean;
|
|
2679
|
+
source: "live" | "estimate";
|
|
2680
|
+
asOf: string;
|
|
2681
|
+
environment: string | null;
|
|
2682
|
+
}[];
|
|
2683
|
+
}, {
|
|
2684
|
+
subscriberId: string;
|
|
2685
|
+
balances: {
|
|
2686
|
+
unit: {
|
|
2687
|
+
key: string;
|
|
2688
|
+
kind: "money" | "credits";
|
|
2689
|
+
code: string;
|
|
2690
|
+
displayName: string;
|
|
2691
|
+
};
|
|
2692
|
+
available: string;
|
|
2693
|
+
granted: string;
|
|
2694
|
+
revoked: string;
|
|
2695
|
+
consumed: string;
|
|
2696
|
+
exhausted: boolean;
|
|
2697
|
+
source: "live" | "estimate";
|
|
2698
|
+
asOf: string;
|
|
2699
|
+
environment: string | null;
|
|
2700
|
+
}[];
|
|
2701
|
+
}, false>;
|
|
2617
2702
|
"consumers.apiKeys.revoke": import("./define.js").OperationEntry<{
|
|
2618
2703
|
businessId: string;
|
|
2619
2704
|
subscriberId: string;
|
|
@@ -3183,6 +3268,9 @@ export declare const OPERATION_TABLE: {
|
|
|
3183
3268
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
3184
3269
|
createdAt: string;
|
|
3185
3270
|
updatedAt: string;
|
|
3271
|
+
usageUnitLabels?: {
|
|
3272
|
+
[key: string]: string;
|
|
3273
|
+
};
|
|
3186
3274
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
3187
3275
|
}, {
|
|
3188
3276
|
id: string;
|
|
@@ -3214,6 +3302,9 @@ export declare const OPERATION_TABLE: {
|
|
|
3214
3302
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
3215
3303
|
createdAt: string;
|
|
3216
3304
|
updatedAt: string;
|
|
3305
|
+
usageUnitLabels?: {
|
|
3306
|
+
[key: string]: string;
|
|
3307
|
+
};
|
|
3217
3308
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
3218
3309
|
}, false>;
|
|
3219
3310
|
"businesses.create": import("./define.js").OperationEntry<{
|
|
@@ -3437,20 +3528,6 @@ export declare const OPERATION_TABLE: {
|
|
|
3437
3528
|
updatedAt: string;
|
|
3438
3529
|
_release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
|
|
3439
3530
|
}, true>;
|
|
3440
|
-
"businesses.rollback": import("./define.js").OperationEntry<{
|
|
3441
|
-
businessId: string;
|
|
3442
|
-
} & {
|
|
3443
|
-
publishId: string;
|
|
3444
|
-
reason?: string;
|
|
3445
|
-
}, {
|
|
3446
|
-
businessId: string;
|
|
3447
|
-
status: "enqueued";
|
|
3448
|
-
rollbackPublishId: string;
|
|
3449
|
-
}, {
|
|
3450
|
-
businessId: string;
|
|
3451
|
-
status: "enqueued";
|
|
3452
|
-
rollbackPublishId: string;
|
|
3453
|
-
}, false>;
|
|
3454
3531
|
"businesses.compile": import("./define.js").OperationEntry<{
|
|
3455
3532
|
businessId: string;
|
|
3456
3533
|
} & {
|
|
@@ -3507,7 +3584,7 @@ export declare const OPERATION_TABLE: {
|
|
|
3507
3584
|
} & {
|
|
3508
3585
|
env?: string;
|
|
3509
3586
|
} & {
|
|
3510
|
-
body: import("
|
|
3587
|
+
body: import("../types.js").BusinessUpdateInput;
|
|
3511
3588
|
}, {
|
|
3512
3589
|
id: string;
|
|
3513
3590
|
organizationId: string | null;
|
|
@@ -3586,7 +3663,7 @@ export declare const OPERATION_TABLE: {
|
|
|
3586
3663
|
} & {
|
|
3587
3664
|
env?: string;
|
|
3588
3665
|
} & {
|
|
3589
|
-
body: import("
|
|
3666
|
+
body: import("../types.js").BusinessUpdateInput;
|
|
3590
3667
|
}, {
|
|
3591
3668
|
id: string;
|
|
3592
3669
|
organizationId: string | null;
|
|
@@ -3783,7 +3860,7 @@ export declare const OPERATION_TABLE: {
|
|
|
3783
3860
|
} & {
|
|
3784
3861
|
env?: string;
|
|
3785
3862
|
} & {
|
|
3786
|
-
body: import("
|
|
3863
|
+
body: import("../types.js").BusinessUpdateInput;
|
|
3787
3864
|
}, {
|
|
3788
3865
|
id: string;
|
|
3789
3866
|
organizationId: string | null;
|
|
@@ -3877,6 +3954,9 @@ export declare const OPERATION_TABLE: {
|
|
|
3877
3954
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
3878
3955
|
createdAt: string;
|
|
3879
3956
|
updatedAt: string;
|
|
3957
|
+
usageUnitLabels?: {
|
|
3958
|
+
[key: string]: string;
|
|
3959
|
+
};
|
|
3880
3960
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
3881
3961
|
}, {
|
|
3882
3962
|
id: string;
|
|
@@ -3908,6 +3988,9 @@ export declare const OPERATION_TABLE: {
|
|
|
3908
3988
|
previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
|
|
3909
3989
|
createdAt: string;
|
|
3910
3990
|
updatedAt: string;
|
|
3991
|
+
usageUnitLabels?: {
|
|
3992
|
+
[key: string]: string;
|
|
3993
|
+
};
|
|
3911
3994
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
3912
3995
|
}, false>;
|
|
3913
3996
|
"businesses.rbac.enable": import("./define.js").OperationEntry<{
|
|
@@ -3935,14 +4018,14 @@ export declare const OPERATION_TABLE: {
|
|
|
3935
4018
|
businessId: string;
|
|
3936
4019
|
}, {
|
|
3937
4020
|
connected: boolean;
|
|
3938
|
-
|
|
3939
|
-
|
|
4021
|
+
reconnectRequired?: true;
|
|
4022
|
+
source: "organization";
|
|
3940
4023
|
chargesEnabled: boolean;
|
|
3941
4024
|
cardPaymentsEnabled: boolean;
|
|
3942
4025
|
}, {
|
|
3943
4026
|
connected: boolean;
|
|
3944
|
-
|
|
3945
|
-
|
|
4027
|
+
reconnectRequired?: true;
|
|
4028
|
+
source: "organization";
|
|
3946
4029
|
chargesEnabled: boolean;
|
|
3947
4030
|
cardPaymentsEnabled: boolean;
|
|
3948
4031
|
}, false>;
|
|
@@ -4435,186 +4518,6 @@ export declare const OPERATION_TABLE: {
|
|
|
4435
4518
|
} | {
|
|
4436
4519
|
result: import("../generated/schemas.js").components["schemas"]["AnalyticsTopKRow"][];
|
|
4437
4520
|
}, false>;
|
|
4438
|
-
"agreements.read": import("./define.js").OperationEntry<{
|
|
4439
|
-
businessId: string;
|
|
4440
|
-
} & {
|
|
4441
|
-
subjectId?: string;
|
|
4442
|
-
environmentId?: string;
|
|
4443
|
-
limit?: number;
|
|
4444
|
-
offset?: number;
|
|
4445
|
-
}, {
|
|
4446
|
-
data: import("../generated/schemas.js").components["schemas"]["EconomicAgreement"][];
|
|
4447
|
-
pagination: {
|
|
4448
|
-
total: number;
|
|
4449
|
-
limit: number;
|
|
4450
|
-
offset: number;
|
|
4451
|
-
hasMore: boolean;
|
|
4452
|
-
};
|
|
4453
|
-
}, {
|
|
4454
|
-
data: import("../generated/schemas.js").components["schemas"]["EconomicAgreement"][];
|
|
4455
|
-
pagination: {
|
|
4456
|
-
total: number;
|
|
4457
|
-
limit: number;
|
|
4458
|
-
offset: number;
|
|
4459
|
-
hasMore: boolean;
|
|
4460
|
-
};
|
|
4461
|
-
}, false>;
|
|
4462
|
-
"agreements.get": import("./define.js").OperationEntry<{
|
|
4463
|
-
businessId: string;
|
|
4464
|
-
} & {
|
|
4465
|
-
agreementId: string;
|
|
4466
|
-
}, {
|
|
4467
|
-
id: string;
|
|
4468
|
-
environmentId: string | null;
|
|
4469
|
-
subjectId: string;
|
|
4470
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4471
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4472
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4473
|
-
effectiveAt: string;
|
|
4474
|
-
expiresAt: string | null;
|
|
4475
|
-
createdAt: string;
|
|
4476
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4477
|
-
}, {
|
|
4478
|
-
id: string;
|
|
4479
|
-
environmentId: string | null;
|
|
4480
|
-
subjectId: string;
|
|
4481
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4482
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4483
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4484
|
-
effectiveAt: string;
|
|
4485
|
-
expiresAt: string | null;
|
|
4486
|
-
createdAt: string;
|
|
4487
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4488
|
-
}, false>;
|
|
4489
|
-
"agreements.pins": import("./define.js").OperationEntry<{
|
|
4490
|
-
businessId: string;
|
|
4491
|
-
} & {
|
|
4492
|
-
subjectId: string;
|
|
4493
|
-
}, {
|
|
4494
|
-
subjectId: string;
|
|
4495
|
-
environmentId: string | null;
|
|
4496
|
-
recurringPricePin: {
|
|
4497
|
-
planKey: string;
|
|
4498
|
-
version: number;
|
|
4499
|
-
recurringFeeCents: number;
|
|
4500
|
-
billingInterval: string;
|
|
4501
|
-
} | null;
|
|
4502
|
-
usagePricingBinding: {
|
|
4503
|
-
source: "agreement";
|
|
4504
|
-
agreementId: string;
|
|
4505
|
-
binding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4506
|
-
} | {
|
|
4507
|
-
source: "plan_default";
|
|
4508
|
-
mode: "current";
|
|
4509
|
-
};
|
|
4510
|
-
migrateToLatest: {
|
|
4511
|
-
status: "deferred";
|
|
4512
|
-
};
|
|
4513
|
-
}, {
|
|
4514
|
-
subjectId: string;
|
|
4515
|
-
environmentId: string | null;
|
|
4516
|
-
recurringPricePin: {
|
|
4517
|
-
planKey: string;
|
|
4518
|
-
version: number;
|
|
4519
|
-
recurringFeeCents: number;
|
|
4520
|
-
billingInterval: string;
|
|
4521
|
-
} | null;
|
|
4522
|
-
usagePricingBinding: {
|
|
4523
|
-
source: "agreement";
|
|
4524
|
-
agreementId: string;
|
|
4525
|
-
binding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4526
|
-
} | {
|
|
4527
|
-
source: "plan_default";
|
|
4528
|
-
mode: "current";
|
|
4529
|
-
};
|
|
4530
|
-
migrateToLatest: {
|
|
4531
|
-
status: "deferred";
|
|
4532
|
-
};
|
|
4533
|
-
}, false>;
|
|
4534
|
-
"agreements.previewCreate": import("./define.js").OperationEntry<{
|
|
4535
|
-
businessId: string;
|
|
4536
|
-
} & {
|
|
4537
|
-
body: import("./define.js").RequestBody;
|
|
4538
|
-
}, {
|
|
4539
|
-
effect: import("../generated/schemas.js").components["schemas"]["AgreementCreateEffect"];
|
|
4540
|
-
confirmationToken: string;
|
|
4541
|
-
}, {
|
|
4542
|
-
effect: import("../generated/schemas.js").components["schemas"]["AgreementCreateEffect"];
|
|
4543
|
-
confirmationToken: string;
|
|
4544
|
-
}, false>;
|
|
4545
|
-
"agreements.create": import("./define.js").OperationEntry<{
|
|
4546
|
-
businessId: string;
|
|
4547
|
-
} & {
|
|
4548
|
-
body: import("./define.js").RequestBody & {
|
|
4549
|
-
confirmationToken: string;
|
|
4550
|
-
};
|
|
4551
|
-
}, {
|
|
4552
|
-
id: string;
|
|
4553
|
-
environmentId: string | null;
|
|
4554
|
-
subjectId: string;
|
|
4555
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4556
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4557
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4558
|
-
effectiveAt: string;
|
|
4559
|
-
expiresAt: string | null;
|
|
4560
|
-
createdAt: string;
|
|
4561
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4562
|
-
}, {
|
|
4563
|
-
id: string;
|
|
4564
|
-
environmentId: string | null;
|
|
4565
|
-
subjectId: string;
|
|
4566
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4567
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4568
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4569
|
-
effectiveAt: string;
|
|
4570
|
-
expiresAt: string | null;
|
|
4571
|
-
createdAt: string;
|
|
4572
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4573
|
-
}, false>;
|
|
4574
|
-
"agreements.previewAmend": import("./define.js").OperationEntry<{
|
|
4575
|
-
businessId: string;
|
|
4576
|
-
} & {
|
|
4577
|
-
agreementId: string;
|
|
4578
|
-
} & {
|
|
4579
|
-
body: import("./define.js").RequestBody;
|
|
4580
|
-
}, {
|
|
4581
|
-
effect: import("../generated/schemas.js").components["schemas"]["AgreementAmendEffect"];
|
|
4582
|
-
confirmationToken: string;
|
|
4583
|
-
}, {
|
|
4584
|
-
effect: import("../generated/schemas.js").components["schemas"]["AgreementAmendEffect"];
|
|
4585
|
-
confirmationToken: string;
|
|
4586
|
-
}, false>;
|
|
4587
|
-
"agreements.amend": import("./define.js").OperationEntry<{
|
|
4588
|
-
businessId: string;
|
|
4589
|
-
} & {
|
|
4590
|
-
agreementId: string;
|
|
4591
|
-
} & {
|
|
4592
|
-
body: import("./define.js").RequestBody & {
|
|
4593
|
-
confirmationToken: string;
|
|
4594
|
-
};
|
|
4595
|
-
}, {
|
|
4596
|
-
id: string;
|
|
4597
|
-
environmentId: string | null;
|
|
4598
|
-
subjectId: string;
|
|
4599
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4600
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4601
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4602
|
-
effectiveAt: string;
|
|
4603
|
-
expiresAt: string | null;
|
|
4604
|
-
createdAt: string;
|
|
4605
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4606
|
-
}, {
|
|
4607
|
-
id: string;
|
|
4608
|
-
environmentId: string | null;
|
|
4609
|
-
subjectId: string;
|
|
4610
|
-
usagePricingBinding: import("../generated/schemas.js").components["schemas"]["AgreementUsagePricingBinding"];
|
|
4611
|
-
newMeterPolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4612
|
-
newMeasurePolicy: "adopt_at_current_rate" | "exclude_until_renewal" | "require_amendment";
|
|
4613
|
-
effectiveAt: string;
|
|
4614
|
-
expiresAt: string | null;
|
|
4615
|
-
createdAt: string;
|
|
4616
|
-
contractPricingVersions: import("../generated/schemas.js").components["schemas"]["ContractPricingVersion"][];
|
|
4617
|
-
}, false>;
|
|
4618
4521
|
"agents.list": import("./define.js").OperationEntry<{
|
|
4619
4522
|
businessId: string;
|
|
4620
4523
|
}, {
|