@farthershore/client 0.1.0 → 0.3.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 +172 -0
- package/README.md +9 -8
- package/dist/index.js +105 -54
- package/dist/types/api.generated.d.ts +21 -7
- package/dist/types/generated/schemas.d.ts +3683 -0
- package/dist/types/helpers/wait-for-frontend-build.d.ts +12 -4
- package/dist/types/index.d.ts +2 -2
- package/dist/types/operations/agents.d.ts +204 -12
- package/dist/types/operations/agreements.d.ts +139 -9
- package/dist/types/operations/analytics.d.ts +27 -5
- package/dist/types/operations/audit-notifications.d.ts +64 -7
- package/dist/types/operations/auth.d.ts +12 -4
- package/dist/types/operations/backends.d.ts +211 -9
- package/dist/types/operations/billing.d.ts +60 -4
- package/dist/types/operations/businesses.d.ts +744 -27
- package/dist/types/operations/change-sets.d.ts +426 -7
- package/dist/types/operations/consumers.d.ts +133 -14
- package/dist/types/operations/define.d.ts +16 -5
- package/dist/types/operations/environments.d.ts +40 -4
- package/dist/types/operations/frontend.d.ts +20 -2
- package/dist/types/operations/index.d.ts +3941 -193
- package/dist/types/operations/maker-tokens.d.ts +175 -11
- package/dist/types/operations/organizations.d.ts +321 -19
- package/dist/types/operations/personas.d.ts +98 -8
- package/dist/types/operations/plans-usage.d.ts +69 -3
- package/dist/types/operations/platform.d.ts +420 -12
- package/dist/types/operations/portal.d.ts +409 -16
- package/dist/types/operations/promo-codes.d.ts +126 -6
- package/dist/types/operations/variables.d.ts +170 -7
- package/dist/types/operations/webhooks.d.ts +77 -14
- package/dist/types/surface-types.d.ts +25 -3
- package/dist/types/transport.d.ts +5 -10
- package/dist/types/types.d.ts +385 -411
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { PersonaLocalPreviewLease } from "../types.js";
|
|
2
2
|
type EnvironmentRef = {
|
|
3
3
|
businessId: string;
|
|
4
4
|
environmentId: string;
|
|
@@ -15,32 +15,122 @@ type LeaseInput = PersonaRef & {
|
|
|
15
15
|
export declare const personaOperations: {
|
|
16
16
|
"personas.bootstrap": import("./define.js").OperationEntry<EnvironmentRef & {
|
|
17
17
|
planKey?: string;
|
|
18
|
-
compiledPlanId?: string;
|
|
19
18
|
scopes?: string[];
|
|
20
19
|
displayName?: string;
|
|
21
20
|
subscriberId?: string;
|
|
22
21
|
accountRole?: "owner" | "admin" | "member";
|
|
23
22
|
roleKeys?: string[];
|
|
24
|
-
},
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
23
|
+
}, {
|
|
24
|
+
data: {
|
|
25
|
+
personaId: string;
|
|
26
|
+
environmentId: string;
|
|
27
|
+
subscriptionId: string;
|
|
28
|
+
subscriberId: string;
|
|
29
|
+
organizationId: string;
|
|
30
|
+
accountRole: "owner" | "admin" | "member";
|
|
31
|
+
roleKeys: string[];
|
|
32
|
+
defaultRoleKey: string | null;
|
|
33
|
+
availableRoleKeys: string[];
|
|
34
|
+
apiKey: string;
|
|
35
|
+
keyLastFour: string;
|
|
36
|
+
sessionToken: string | null;
|
|
37
|
+
expiresAt: string | null;
|
|
38
|
+
planKey: string | null;
|
|
39
|
+
scopes: string[];
|
|
40
|
+
};
|
|
41
|
+
}, {
|
|
42
|
+
data: {
|
|
43
|
+
personaId: string;
|
|
44
|
+
environmentId: string;
|
|
45
|
+
subscriptionId: string;
|
|
46
|
+
subscriberId: string;
|
|
47
|
+
organizationId: string;
|
|
48
|
+
accountRole: "owner" | "admin" | "member";
|
|
49
|
+
roleKeys: string[];
|
|
50
|
+
defaultRoleKey: string | null;
|
|
51
|
+
availableRoleKeys: string[];
|
|
52
|
+
apiKey: string;
|
|
53
|
+
keyLastFour: string;
|
|
54
|
+
sessionToken: string | null;
|
|
55
|
+
expiresAt: string | null;
|
|
56
|
+
planKey: string | null;
|
|
57
|
+
scopes: string[];
|
|
58
|
+
};
|
|
59
|
+
}>;
|
|
60
|
+
"personas.read": import("./define.js").OperationEntry<EnvironmentRef, {
|
|
61
|
+
data: import("../generated/schemas.js").components["schemas"]["TestPersona"][];
|
|
62
|
+
}, {
|
|
63
|
+
data: import("../generated/schemas.js").components["schemas"]["TestPersona"][];
|
|
64
|
+
}>;
|
|
65
|
+
"personas.login": import("./define.js").OperationEntry<PersonaRef, {
|
|
66
|
+
data: {
|
|
67
|
+
personaId: string;
|
|
68
|
+
environmentId: string;
|
|
69
|
+
portalUrl: string;
|
|
70
|
+
handoffToken: string;
|
|
71
|
+
expiresAt: string;
|
|
72
|
+
};
|
|
73
|
+
}, {
|
|
74
|
+
data: {
|
|
75
|
+
personaId: string;
|
|
76
|
+
environmentId: string;
|
|
77
|
+
portalUrl: string;
|
|
78
|
+
handoffToken: string;
|
|
79
|
+
expiresAt: string;
|
|
80
|
+
};
|
|
81
|
+
}>;
|
|
82
|
+
"personas.rotate": import("./define.js").OperationEntry<PersonaRef, {
|
|
83
|
+
data: {
|
|
84
|
+
id: string;
|
|
85
|
+
apiKey: string;
|
|
86
|
+
keyLastFour: string;
|
|
87
|
+
rotatedAt: string;
|
|
88
|
+
};
|
|
89
|
+
}, {
|
|
90
|
+
data: {
|
|
91
|
+
id: string;
|
|
92
|
+
apiKey: string;
|
|
93
|
+
keyLastFour: string;
|
|
94
|
+
rotatedAt: string;
|
|
95
|
+
};
|
|
96
|
+
}>;
|
|
97
|
+
"personas.delete": import("./define.js").OperationEntry<PersonaRef, {
|
|
98
|
+
data: {
|
|
99
|
+
id: string;
|
|
100
|
+
deleted: true;
|
|
101
|
+
alreadyDeleted: boolean;
|
|
102
|
+
};
|
|
103
|
+
}, {
|
|
104
|
+
data: {
|
|
105
|
+
id: string;
|
|
106
|
+
deleted: true;
|
|
107
|
+
alreadyDeleted: boolean;
|
|
108
|
+
};
|
|
109
|
+
}>;
|
|
29
110
|
"personas.localPreview.issue": import("./define.js").OperationEntry<EnvironmentRef & {
|
|
30
111
|
personaId: string;
|
|
31
112
|
} & {
|
|
32
113
|
localOrigin: string;
|
|
33
|
-
}, PersonaLocalPreviewLease>;
|
|
114
|
+
}, PersonaLocalPreviewLease, PersonaLocalPreviewLease>;
|
|
34
115
|
"personas.localPreview.renew": import("./define.js").OperationEntry<LeaseInput, {
|
|
35
116
|
data: {
|
|
36
117
|
localProxyLease: string;
|
|
37
118
|
localProxyLeaseExpiresAt: string;
|
|
38
119
|
};
|
|
120
|
+
}, {
|
|
121
|
+
data: {
|
|
122
|
+
localProxyLease: string;
|
|
123
|
+
localProxyLeaseExpiresAt: string;
|
|
124
|
+
};
|
|
39
125
|
}>;
|
|
40
126
|
"personas.localPreview.revoke": import("./define.js").OperationEntry<LeaseInput, {
|
|
41
127
|
data: {
|
|
42
128
|
revoked: boolean;
|
|
43
129
|
};
|
|
130
|
+
}, {
|
|
131
|
+
data: {
|
|
132
|
+
revoked: boolean;
|
|
133
|
+
};
|
|
44
134
|
}>;
|
|
45
135
|
};
|
|
46
136
|
export {};
|
|
@@ -7,12 +7,78 @@ export declare const plansUsageOperations: {
|
|
|
7
7
|
"plans.read": import("./define.js").OperationEntry<ManagementScoped & {
|
|
8
8
|
limit?: number;
|
|
9
9
|
offset?: number;
|
|
10
|
-
},
|
|
11
|
-
|
|
10
|
+
}, {
|
|
11
|
+
data: import("../generated/schemas.js").components["schemas"]["BuilderPlan"][];
|
|
12
|
+
pagination: {
|
|
13
|
+
total: number;
|
|
14
|
+
limit: number;
|
|
15
|
+
offset: number;
|
|
16
|
+
hasMore: boolean;
|
|
17
|
+
};
|
|
18
|
+
environmentId: string | null;
|
|
19
|
+
scope: "production" | "environment";
|
|
20
|
+
unreadable?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
|
|
21
|
+
}, {
|
|
22
|
+
data: import("../generated/schemas.js").components["schemas"]["BuilderPlan"][];
|
|
23
|
+
pagination: {
|
|
24
|
+
total: number;
|
|
25
|
+
limit: number;
|
|
26
|
+
offset: number;
|
|
27
|
+
hasMore: boolean;
|
|
28
|
+
};
|
|
29
|
+
environmentId: string | null;
|
|
30
|
+
scope: "production" | "environment";
|
|
31
|
+
unreadable?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
|
|
32
|
+
}>;
|
|
33
|
+
"usage.read": import("./define.js").OperationEntry<ManagementScoped, {
|
|
34
|
+
environmentId: string | null;
|
|
35
|
+
scope: "all" | "environment";
|
|
36
|
+
totalRequests: number;
|
|
37
|
+
requestsLast30Days: number;
|
|
38
|
+
activeApiKeys: number;
|
|
39
|
+
periodStart: string;
|
|
40
|
+
periodEnd: string;
|
|
41
|
+
byMember: import("../generated/schemas.js").components["schemas"]["UsageMemberBucket"][];
|
|
42
|
+
byMemberTruncated: boolean;
|
|
43
|
+
meterLabels: {
|
|
44
|
+
[key: string]: import("../generated/schemas.js").components["schemas"]["UsageMeterLabel"];
|
|
45
|
+
};
|
|
46
|
+
unratable: import("../generated/schemas.js").components["schemas"]["UsageUnratable"];
|
|
47
|
+
}, {
|
|
48
|
+
environmentId: string | null;
|
|
49
|
+
scope: "all" | "environment";
|
|
50
|
+
totalRequests: number;
|
|
51
|
+
requestsLast30Days: number;
|
|
52
|
+
activeApiKeys: number;
|
|
53
|
+
periodStart: string;
|
|
54
|
+
periodEnd: string;
|
|
55
|
+
byMember: import("../generated/schemas.js").components["schemas"]["UsageMemberBucket"][];
|
|
56
|
+
byMemberTruncated: boolean;
|
|
57
|
+
meterLabels: {
|
|
58
|
+
[key: string]: import("../generated/schemas.js").components["schemas"]["UsageMeterLabel"];
|
|
59
|
+
};
|
|
60
|
+
unratable: import("../generated/schemas.js").components["schemas"]["UsageUnratable"];
|
|
61
|
+
}>;
|
|
12
62
|
"usage.limits": import("./define.js").OperationEntry<{
|
|
13
63
|
businessId: string;
|
|
14
64
|
limit?: number;
|
|
15
65
|
offset?: number;
|
|
16
|
-
},
|
|
66
|
+
}, {
|
|
67
|
+
data: import("../generated/schemas.js").components["schemas"]["ManagementUsageLimit"][];
|
|
68
|
+
pagination: {
|
|
69
|
+
total: number;
|
|
70
|
+
limit: number;
|
|
71
|
+
offset: number;
|
|
72
|
+
hasMore: boolean;
|
|
73
|
+
};
|
|
74
|
+
}, {
|
|
75
|
+
data: import("../generated/schemas.js").components["schemas"]["ManagementUsageLimit"][];
|
|
76
|
+
pagination: {
|
|
77
|
+
total: number;
|
|
78
|
+
limit: number;
|
|
79
|
+
offset: number;
|
|
80
|
+
hasMore: boolean;
|
|
81
|
+
};
|
|
82
|
+
}>;
|
|
17
83
|
};
|
|
18
84
|
export {};
|
|
@@ -10,38 +10,446 @@ export declare const platformOperations: {
|
|
|
10
10
|
"platform.resourceCounts.report": import("./define.js").OperationEntry<BusinessRef & {
|
|
11
11
|
resource: string;
|
|
12
12
|
body: RequestBody;
|
|
13
|
-
},
|
|
13
|
+
}, {
|
|
14
|
+
resourceCount: import("../generated/schemas.js").components["schemas"]["ResourceCount"];
|
|
15
|
+
}, {
|
|
16
|
+
resourceCount: import("../generated/schemas.js").components["schemas"]["ResourceCount"];
|
|
17
|
+
}>;
|
|
14
18
|
"platform.denials.read": import("./define.js").OperationEntry<BusinessRef & {
|
|
15
19
|
requestId: string;
|
|
16
|
-
},
|
|
20
|
+
}, {
|
|
21
|
+
denialEvent: import("../generated/schemas.js").components["schemas"]["DenialEvent"];
|
|
22
|
+
}, {
|
|
23
|
+
denialEvent: import("../generated/schemas.js").components["schemas"]["DenialEvent"];
|
|
24
|
+
}>;
|
|
17
25
|
"platform.dependents.read": import("./define.js").OperationEntry<BusinessRef & {
|
|
18
26
|
route: string;
|
|
19
27
|
since?: string;
|
|
20
28
|
environmentId?: string;
|
|
21
|
-
},
|
|
29
|
+
}, {
|
|
30
|
+
businessId: string;
|
|
31
|
+
routeKey: string;
|
|
32
|
+
environmentId: string | null;
|
|
33
|
+
sinceMs: number;
|
|
34
|
+
count: number;
|
|
35
|
+
truncated: boolean;
|
|
36
|
+
consumers: import("../generated/schemas.js").components["schemas"]["BusinessDependent"][];
|
|
37
|
+
}, {
|
|
38
|
+
businessId: string;
|
|
39
|
+
routeKey: string;
|
|
40
|
+
environmentId: string | null;
|
|
41
|
+
sinceMs: number;
|
|
42
|
+
count: number;
|
|
43
|
+
truncated: boolean;
|
|
44
|
+
consumers: import("../generated/schemas.js").components["schemas"]["BusinessDependent"][];
|
|
45
|
+
}>;
|
|
22
46
|
"platform.workflowControl.replay": import("./define.js").OperationEntry<{
|
|
23
47
|
body: RequestBody;
|
|
24
|
-
},
|
|
48
|
+
}, {
|
|
49
|
+
status: "computed";
|
|
50
|
+
invoiceId: string;
|
|
51
|
+
dryRun: boolean;
|
|
52
|
+
proposedInvoice: {
|
|
53
|
+
id: string;
|
|
54
|
+
periodStart: string;
|
|
55
|
+
periodEnd: string;
|
|
56
|
+
subtotalMicros: string;
|
|
57
|
+
totalMicros: string;
|
|
58
|
+
currency: string;
|
|
59
|
+
lineItems: {
|
|
60
|
+
id: string | null;
|
|
61
|
+
description: string | null;
|
|
62
|
+
amountMicros: string;
|
|
63
|
+
}[];
|
|
64
|
+
};
|
|
65
|
+
delta: string;
|
|
66
|
+
deltaCents: number;
|
|
67
|
+
} | {
|
|
68
|
+
status: "preview_only";
|
|
69
|
+
businessId: string;
|
|
70
|
+
periodStart: string;
|
|
71
|
+
periodEnd: string;
|
|
72
|
+
dryRun: true;
|
|
73
|
+
scope: {
|
|
74
|
+
subscriptions: number;
|
|
75
|
+
usageEvents: number;
|
|
76
|
+
};
|
|
77
|
+
message: string;
|
|
78
|
+
}, {
|
|
79
|
+
status: "computed";
|
|
80
|
+
invoiceId: string;
|
|
81
|
+
dryRun: boolean;
|
|
82
|
+
proposedInvoice: {
|
|
83
|
+
id: string;
|
|
84
|
+
periodStart: string;
|
|
85
|
+
periodEnd: string;
|
|
86
|
+
subtotalMicros: string;
|
|
87
|
+
totalMicros: string;
|
|
88
|
+
currency: string;
|
|
89
|
+
lineItems: {
|
|
90
|
+
id: string | null;
|
|
91
|
+
description: string | null;
|
|
92
|
+
amountMicros: string;
|
|
93
|
+
}[];
|
|
94
|
+
};
|
|
95
|
+
delta: string;
|
|
96
|
+
deltaCents: number;
|
|
97
|
+
} | {
|
|
98
|
+
status: "preview_only";
|
|
99
|
+
businessId: string;
|
|
100
|
+
periodStart: string;
|
|
101
|
+
periodEnd: string;
|
|
102
|
+
dryRun: true;
|
|
103
|
+
scope: {
|
|
104
|
+
subscriptions: number;
|
|
105
|
+
usageEvents: number;
|
|
106
|
+
};
|
|
107
|
+
message: string;
|
|
108
|
+
}>;
|
|
25
109
|
"platform.workflowControl.rollback": import("./define.js").OperationEntry<{
|
|
26
110
|
body: RequestBody;
|
|
27
|
-
},
|
|
111
|
+
}, {
|
|
112
|
+
status: "preview_only";
|
|
113
|
+
businessId: string;
|
|
114
|
+
commitSha: string;
|
|
115
|
+
dryRun: true;
|
|
116
|
+
currentCommitSha: string | null;
|
|
117
|
+
message: string;
|
|
118
|
+
diff?: {
|
|
119
|
+
repo: string;
|
|
120
|
+
fromCommit: string;
|
|
121
|
+
toCommit: string;
|
|
122
|
+
files: {
|
|
123
|
+
path: string;
|
|
124
|
+
contentFrom: string;
|
|
125
|
+
contentTo: string;
|
|
126
|
+
}[];
|
|
127
|
+
revertCommitSha: string | null;
|
|
128
|
+
};
|
|
129
|
+
}, {
|
|
130
|
+
status: "preview_only";
|
|
131
|
+
businessId: string;
|
|
132
|
+
commitSha: string;
|
|
133
|
+
dryRun: true;
|
|
134
|
+
currentCommitSha: string | null;
|
|
135
|
+
message: string;
|
|
136
|
+
diff?: {
|
|
137
|
+
repo: string;
|
|
138
|
+
fromCommit: string;
|
|
139
|
+
toCommit: string;
|
|
140
|
+
files: {
|
|
141
|
+
path: string;
|
|
142
|
+
contentFrom: string;
|
|
143
|
+
contentTo: string;
|
|
144
|
+
}[];
|
|
145
|
+
revertCommitSha: string | null;
|
|
146
|
+
};
|
|
147
|
+
}>;
|
|
28
148
|
"automationRules.read": import("./define.js").OperationEntry<BusinessRef & Cursor & {
|
|
29
149
|
env?: string;
|
|
30
|
-
},
|
|
150
|
+
}, {
|
|
151
|
+
items: import("../generated/schemas.js").components["schemas"]["AutomationRule"][];
|
|
152
|
+
nextCursor: string | null;
|
|
153
|
+
}, {
|
|
154
|
+
items: import("../generated/schemas.js").components["schemas"]["AutomationRule"][];
|
|
155
|
+
nextCursor: string | null;
|
|
156
|
+
}>;
|
|
31
157
|
"automationRules.get": import("./define.js").OperationEntry<BusinessRef & {
|
|
32
158
|
ruleId: string;
|
|
33
|
-
},
|
|
159
|
+
}, {
|
|
160
|
+
name: string;
|
|
161
|
+
trigger: {
|
|
162
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
163
|
+
filter?: {
|
|
164
|
+
subjectType?: string;
|
|
165
|
+
subjectId?: string;
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
conditions: {
|
|
169
|
+
path: string;
|
|
170
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
171
|
+
value: string | number | boolean;
|
|
172
|
+
}[];
|
|
173
|
+
actions: ({
|
|
174
|
+
kind: "emit_webhook_event";
|
|
175
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
176
|
+
payload: {
|
|
177
|
+
[key: string]: unknown;
|
|
178
|
+
};
|
|
179
|
+
} | {
|
|
180
|
+
kind: "create_notification";
|
|
181
|
+
level: "info" | "warning" | "critical";
|
|
182
|
+
message: string;
|
|
183
|
+
} | {
|
|
184
|
+
kind: "propose_change_set";
|
|
185
|
+
intent: string;
|
|
186
|
+
roleKey: string;
|
|
187
|
+
permissions: string[];
|
|
188
|
+
} | {
|
|
189
|
+
kind: "notify_audience";
|
|
190
|
+
audience: {
|
|
191
|
+
[key: string]: unknown;
|
|
192
|
+
};
|
|
193
|
+
class: "product_update" | "transactional";
|
|
194
|
+
subject: string;
|
|
195
|
+
body: string;
|
|
196
|
+
})[];
|
|
197
|
+
enabled: boolean;
|
|
198
|
+
schemaVersion: number;
|
|
199
|
+
id: string;
|
|
200
|
+
businessId: string;
|
|
201
|
+
environmentId: string | null;
|
|
202
|
+
createdAt: string;
|
|
203
|
+
updatedAt: string;
|
|
204
|
+
}, {
|
|
205
|
+
name: string;
|
|
206
|
+
trigger: {
|
|
207
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
208
|
+
filter?: {
|
|
209
|
+
subjectType?: string;
|
|
210
|
+
subjectId?: string;
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
conditions: {
|
|
214
|
+
path: string;
|
|
215
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
216
|
+
value: string | number | boolean;
|
|
217
|
+
}[];
|
|
218
|
+
actions: ({
|
|
219
|
+
kind: "emit_webhook_event";
|
|
220
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
221
|
+
payload: {
|
|
222
|
+
[key: string]: unknown;
|
|
223
|
+
};
|
|
224
|
+
} | {
|
|
225
|
+
kind: "create_notification";
|
|
226
|
+
level: "info" | "warning" | "critical";
|
|
227
|
+
message: string;
|
|
228
|
+
} | {
|
|
229
|
+
kind: "propose_change_set";
|
|
230
|
+
intent: string;
|
|
231
|
+
roleKey: string;
|
|
232
|
+
permissions: string[];
|
|
233
|
+
} | {
|
|
234
|
+
kind: "notify_audience";
|
|
235
|
+
audience: {
|
|
236
|
+
[key: string]: unknown;
|
|
237
|
+
};
|
|
238
|
+
class: "product_update" | "transactional";
|
|
239
|
+
subject: string;
|
|
240
|
+
body: string;
|
|
241
|
+
})[];
|
|
242
|
+
enabled: boolean;
|
|
243
|
+
schemaVersion: number;
|
|
244
|
+
id: string;
|
|
245
|
+
businessId: string;
|
|
246
|
+
environmentId: string | null;
|
|
247
|
+
createdAt: string;
|
|
248
|
+
updatedAt: string;
|
|
249
|
+
}>;
|
|
34
250
|
"automationRules.create": import("./define.js").OperationEntry<BusinessRef & {
|
|
35
251
|
body: RequestBody;
|
|
36
|
-
},
|
|
252
|
+
}, {
|
|
253
|
+
name: string;
|
|
254
|
+
trigger: {
|
|
255
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
256
|
+
filter?: {
|
|
257
|
+
subjectType?: string;
|
|
258
|
+
subjectId?: string;
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
conditions: {
|
|
262
|
+
path: string;
|
|
263
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
264
|
+
value: string | number | boolean;
|
|
265
|
+
}[];
|
|
266
|
+
actions: ({
|
|
267
|
+
kind: "emit_webhook_event";
|
|
268
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
269
|
+
payload: {
|
|
270
|
+
[key: string]: unknown;
|
|
271
|
+
};
|
|
272
|
+
} | {
|
|
273
|
+
kind: "create_notification";
|
|
274
|
+
level: "info" | "warning" | "critical";
|
|
275
|
+
message: string;
|
|
276
|
+
} | {
|
|
277
|
+
kind: "propose_change_set";
|
|
278
|
+
intent: string;
|
|
279
|
+
roleKey: string;
|
|
280
|
+
permissions: string[];
|
|
281
|
+
} | {
|
|
282
|
+
kind: "notify_audience";
|
|
283
|
+
audience: {
|
|
284
|
+
[key: string]: unknown;
|
|
285
|
+
};
|
|
286
|
+
class: "product_update" | "transactional";
|
|
287
|
+
subject: string;
|
|
288
|
+
body: string;
|
|
289
|
+
})[];
|
|
290
|
+
enabled: boolean;
|
|
291
|
+
schemaVersion: number;
|
|
292
|
+
id: string;
|
|
293
|
+
businessId: string;
|
|
294
|
+
environmentId: string | null;
|
|
295
|
+
createdAt: string;
|
|
296
|
+
updatedAt: string;
|
|
297
|
+
}, {
|
|
298
|
+
name: string;
|
|
299
|
+
trigger: {
|
|
300
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
301
|
+
filter?: {
|
|
302
|
+
subjectType?: string;
|
|
303
|
+
subjectId?: string;
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
conditions: {
|
|
307
|
+
path: string;
|
|
308
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
309
|
+
value: string | number | boolean;
|
|
310
|
+
}[];
|
|
311
|
+
actions: ({
|
|
312
|
+
kind: "emit_webhook_event";
|
|
313
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
314
|
+
payload: {
|
|
315
|
+
[key: string]: unknown;
|
|
316
|
+
};
|
|
317
|
+
} | {
|
|
318
|
+
kind: "create_notification";
|
|
319
|
+
level: "info" | "warning" | "critical";
|
|
320
|
+
message: string;
|
|
321
|
+
} | {
|
|
322
|
+
kind: "propose_change_set";
|
|
323
|
+
intent: string;
|
|
324
|
+
roleKey: string;
|
|
325
|
+
permissions: string[];
|
|
326
|
+
} | {
|
|
327
|
+
kind: "notify_audience";
|
|
328
|
+
audience: {
|
|
329
|
+
[key: string]: unknown;
|
|
330
|
+
};
|
|
331
|
+
class: "product_update" | "transactional";
|
|
332
|
+
subject: string;
|
|
333
|
+
body: string;
|
|
334
|
+
})[];
|
|
335
|
+
enabled: boolean;
|
|
336
|
+
schemaVersion: number;
|
|
337
|
+
id: string;
|
|
338
|
+
businessId: string;
|
|
339
|
+
environmentId: string | null;
|
|
340
|
+
createdAt: string;
|
|
341
|
+
updatedAt: string;
|
|
342
|
+
}>;
|
|
37
343
|
"automationRules.update": import("./define.js").OperationEntry<BusinessRef & {
|
|
38
344
|
ruleId: string;
|
|
39
345
|
body: RequestBody;
|
|
40
|
-
},
|
|
346
|
+
}, {
|
|
347
|
+
name: string;
|
|
348
|
+
trigger: {
|
|
349
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
350
|
+
filter?: {
|
|
351
|
+
subjectType?: string;
|
|
352
|
+
subjectId?: string;
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
conditions: {
|
|
356
|
+
path: string;
|
|
357
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
358
|
+
value: string | number | boolean;
|
|
359
|
+
}[];
|
|
360
|
+
actions: ({
|
|
361
|
+
kind: "emit_webhook_event";
|
|
362
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
363
|
+
payload: {
|
|
364
|
+
[key: string]: unknown;
|
|
365
|
+
};
|
|
366
|
+
} | {
|
|
367
|
+
kind: "create_notification";
|
|
368
|
+
level: "info" | "warning" | "critical";
|
|
369
|
+
message: string;
|
|
370
|
+
} | {
|
|
371
|
+
kind: "propose_change_set";
|
|
372
|
+
intent: string;
|
|
373
|
+
roleKey: string;
|
|
374
|
+
permissions: string[];
|
|
375
|
+
} | {
|
|
376
|
+
kind: "notify_audience";
|
|
377
|
+
audience: {
|
|
378
|
+
[key: string]: unknown;
|
|
379
|
+
};
|
|
380
|
+
class: "product_update" | "transactional";
|
|
381
|
+
subject: string;
|
|
382
|
+
body: string;
|
|
383
|
+
})[];
|
|
384
|
+
enabled: boolean;
|
|
385
|
+
schemaVersion: number;
|
|
386
|
+
id: string;
|
|
387
|
+
businessId: string;
|
|
388
|
+
environmentId: string | null;
|
|
389
|
+
createdAt: string;
|
|
390
|
+
updatedAt: string;
|
|
391
|
+
}, {
|
|
392
|
+
name: string;
|
|
393
|
+
trigger: {
|
|
394
|
+
eventType: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached" | "rate_limit.exceeded" | "usage.recorded" | "usage.archive_checkpoint" | "gateway.request_denied" | "change_set.created" | "change_set.approved" | "change_set.applied" | "change_set.rolled_back" | "change_set.cancelled" | "billing.event_recorded" | "authz.decision" | "repo.changed" | "automation.rule_fired" | "automation.action_succeeded" | "automation.action_failed" | "automation.action_denied" | "automation.notification" | "access_request.created" | "access_request.resolved" | "build.failed" | "product.published" | "workflow.failed" | "pr.review_posted";
|
|
395
|
+
filter?: {
|
|
396
|
+
subjectType?: string;
|
|
397
|
+
subjectId?: string;
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
conditions: {
|
|
401
|
+
path: string;
|
|
402
|
+
operator: "eq" | "neq" | "gt" | "lt" | "contains" | "path_prefix";
|
|
403
|
+
value: string | number | boolean;
|
|
404
|
+
}[];
|
|
405
|
+
actions: ({
|
|
406
|
+
kind: "emit_webhook_event";
|
|
407
|
+
event: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
|
|
408
|
+
payload: {
|
|
409
|
+
[key: string]: unknown;
|
|
410
|
+
};
|
|
411
|
+
} | {
|
|
412
|
+
kind: "create_notification";
|
|
413
|
+
level: "info" | "warning" | "critical";
|
|
414
|
+
message: string;
|
|
415
|
+
} | {
|
|
416
|
+
kind: "propose_change_set";
|
|
417
|
+
intent: string;
|
|
418
|
+
roleKey: string;
|
|
419
|
+
permissions: string[];
|
|
420
|
+
} | {
|
|
421
|
+
kind: "notify_audience";
|
|
422
|
+
audience: {
|
|
423
|
+
[key: string]: unknown;
|
|
424
|
+
};
|
|
425
|
+
class: "product_update" | "transactional";
|
|
426
|
+
subject: string;
|
|
427
|
+
body: string;
|
|
428
|
+
})[];
|
|
429
|
+
enabled: boolean;
|
|
430
|
+
schemaVersion: number;
|
|
431
|
+
id: string;
|
|
432
|
+
businessId: string;
|
|
433
|
+
environmentId: string | null;
|
|
434
|
+
createdAt: string;
|
|
435
|
+
updatedAt: string;
|
|
436
|
+
}>;
|
|
41
437
|
"automationRules.delete": import("./define.js").OperationEntry<BusinessRef & {
|
|
42
438
|
ruleId: string;
|
|
43
|
-
}, void>;
|
|
44
|
-
"knowledge.guide.read": import("./define.js").OperationEntry<Cursor | undefined,
|
|
45
|
-
|
|
439
|
+
}, void, void>;
|
|
440
|
+
"knowledge.guide.read": import("./define.js").OperationEntry<Cursor | undefined, {
|
|
441
|
+
items: import("../generated/schemas.js").components["schemas"]["KnowledgeResource"][];
|
|
442
|
+
nextCursor: string | null;
|
|
443
|
+
}, {
|
|
444
|
+
items: import("../generated/schemas.js").components["schemas"]["KnowledgeResource"][];
|
|
445
|
+
nextCursor: string | null;
|
|
446
|
+
}>;
|
|
447
|
+
"knowledge.business.read": import("./define.js").OperationEntry<BusinessRef & Cursor, {
|
|
448
|
+
items: import("../generated/schemas.js").components["schemas"]["KnowledgeResource"][];
|
|
449
|
+
nextCursor: string | null;
|
|
450
|
+
}, {
|
|
451
|
+
items: import("../generated/schemas.js").components["schemas"]["KnowledgeResource"][];
|
|
452
|
+
nextCursor: string | null;
|
|
453
|
+
}>;
|
|
46
454
|
};
|
|
47
455
|
export {};
|