@meshery/schemas 1.2.22 → 1.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/dist/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,557 +4,237 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
"/api/entitlement/subscriptions/create": {
|
|
15
|
-
post: operations["createSubscription"];
|
|
16
|
-
};
|
|
17
|
-
"/api/entitlement/subscriptions/{subscriptionId}/upgrade": {
|
|
18
|
-
post: operations["upgradeSubscription"];
|
|
19
|
-
};
|
|
20
|
-
"/api/entitlement/subscriptions/{subscriptionId}/upgradePreview": {
|
|
21
|
-
post: operations["previewSubscriptionUpgrade"];
|
|
22
|
-
};
|
|
23
|
-
"/api/entitlement/subscriptions/webhooks": {
|
|
24
|
-
post: operations["handleSubscriptionWebhook"];
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface components {
|
|
29
|
-
schemas: {
|
|
30
|
-
/**
|
|
31
|
-
* @description Supported payment processors
|
|
32
|
-
* @enum {string}
|
|
33
|
-
*/
|
|
34
|
-
PaymentProcessor: "stripe" | "paypal" | "braintree";
|
|
35
|
-
CreateSubscriptionRequest: {
|
|
36
|
-
/** @description Organization ID */
|
|
37
|
-
orgId?: string;
|
|
38
|
-
/** @description Price ID from the payment processor */
|
|
39
|
-
planId?: string;
|
|
40
|
-
/** @description Coupon ID to apply */
|
|
41
|
-
couponId?: string;
|
|
42
|
-
/** @description Number of users in the organization */
|
|
43
|
-
userCount?: number;
|
|
44
|
-
/**
|
|
45
|
-
* Format: email
|
|
46
|
-
* @description Email of the customer
|
|
47
|
-
*/
|
|
48
|
-
email?: string;
|
|
49
|
-
/**
|
|
50
|
-
* @description Supported payment processors
|
|
51
|
-
* @enum {string}
|
|
52
|
-
*/
|
|
53
|
-
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
54
|
-
};
|
|
55
|
-
UpgradeSubscriptionRequest: {
|
|
56
|
-
/**
|
|
57
|
-
* Format: uuid
|
|
58
|
-
* @description Old Plan id that is being changed
|
|
59
|
-
*/
|
|
60
|
-
oldPlanId?: string;
|
|
61
|
-
/**
|
|
62
|
-
* Format: uuid
|
|
63
|
-
* @description New Plan id that is being changed to
|
|
64
|
-
*/
|
|
65
|
-
newPlanId?: string;
|
|
66
|
-
};
|
|
67
|
-
CreateSubscriptionResponse: {
|
|
68
|
-
subscriptionId?: string;
|
|
69
|
-
clientSecret?: string;
|
|
70
|
-
};
|
|
71
|
-
UpdateUsersRequest: {
|
|
72
|
-
/**
|
|
73
|
-
* @description Supported payment processors
|
|
74
|
-
* @enum {string}
|
|
75
|
-
*/
|
|
76
|
-
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
77
|
-
};
|
|
78
|
-
CancelSubscriptionRequest: {
|
|
79
|
-
/** @description Subscription ID from the payment processor */
|
|
80
|
-
subscriptionId?: string;
|
|
81
|
-
/**
|
|
82
|
-
* @description Supported payment processors
|
|
83
|
-
* @enum {string}
|
|
84
|
-
*/
|
|
85
|
-
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
86
|
-
};
|
|
87
|
-
/** @description Payload for webhook events from payment processors */
|
|
88
|
-
WebhookEvent: { [key: string]: unknown };
|
|
89
|
-
SubscriptionPage: {
|
|
90
|
-
page: number;
|
|
91
|
-
page_size: number;
|
|
92
|
-
total_count: number;
|
|
93
|
-
subscriptions: {
|
|
94
|
-
/**
|
|
95
|
-
* Format: uuid
|
|
96
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
97
|
-
*/
|
|
98
|
-
id: string;
|
|
99
|
-
/**
|
|
100
|
-
* Format: uuid
|
|
101
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
102
|
-
*/
|
|
103
|
-
org_id: string;
|
|
104
|
-
/**
|
|
105
|
-
* Format: uuid
|
|
106
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
107
|
-
*/
|
|
108
|
-
plan_id: string;
|
|
109
|
-
plan?: {
|
|
110
|
-
/**
|
|
111
|
-
* Format: uuid
|
|
112
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
113
|
-
*/
|
|
114
|
-
id: string;
|
|
115
|
-
/**
|
|
116
|
-
* @description Name of the plan
|
|
117
|
-
* @enum {string}
|
|
118
|
-
*/
|
|
119
|
-
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
120
|
-
/** @enum {string} */
|
|
121
|
-
cadence: "monthly" | "yearly";
|
|
122
|
-
/** @enum {string} */
|
|
123
|
-
unit: "user" | "free";
|
|
124
|
-
/** @description Minimum number of units required for the plan */
|
|
125
|
-
minimum_units: number;
|
|
126
|
-
/** @description Price per unit of the plan */
|
|
127
|
-
price_per_unit: number;
|
|
128
|
-
/** @enum {string} */
|
|
129
|
-
currency: "usd";
|
|
130
|
-
};
|
|
131
|
-
quantity: number;
|
|
132
|
-
/** Format: date-time */
|
|
133
|
-
start_date?: string;
|
|
134
|
-
/** Format: date-time */
|
|
135
|
-
end_date?: string;
|
|
7
|
+
"/api/entitlement/subscriptions": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
136
14
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @
|
|
15
|
+
* Read subscriptions
|
|
16
|
+
* @description Returns all subscriptions for the organization
|
|
139
17
|
*/
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
/** Format: date-time */
|
|
149
|
-
created_at?: string;
|
|
150
|
-
/** Format: date-time */
|
|
151
|
-
updated_at?: string;
|
|
152
|
-
/** Format: date-time */
|
|
153
|
-
deleted_at?: string;
|
|
154
|
-
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
155
|
-
billing_id: string;
|
|
156
|
-
}[];
|
|
18
|
+
get: operations["getSubscriptions"];
|
|
19
|
+
put?: never;
|
|
20
|
+
post?: never;
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
157
26
|
};
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
plan?: {
|
|
175
|
-
/**
|
|
176
|
-
* Format: uuid
|
|
177
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
178
|
-
*/
|
|
179
|
-
id: string;
|
|
180
|
-
/**
|
|
181
|
-
* @description Name of the plan
|
|
182
|
-
* @enum {string}
|
|
183
|
-
*/
|
|
184
|
-
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
185
|
-
/** @enum {string} */
|
|
186
|
-
cadence: "monthly" | "yearly";
|
|
187
|
-
/** @enum {string} */
|
|
188
|
-
unit: "user" | "free";
|
|
189
|
-
/** @description Minimum number of units required for the plan */
|
|
190
|
-
minimum_units: number;
|
|
191
|
-
/** @description Price per unit of the plan */
|
|
192
|
-
price_per_unit: number;
|
|
193
|
-
/** @enum {string} */
|
|
194
|
-
currency: "usd";
|
|
195
|
-
};
|
|
196
|
-
quantity: number;
|
|
197
|
-
/** Format: date-time */
|
|
198
|
-
start_date?: string;
|
|
199
|
-
/** Format: date-time */
|
|
200
|
-
end_date?: string;
|
|
201
|
-
/**
|
|
202
|
-
* @description Possible statuses of a Stripe subscription.
|
|
203
|
-
* @enum {string}
|
|
204
|
-
*/
|
|
205
|
-
status:
|
|
206
|
-
| "incomplete"
|
|
207
|
-
| "incomplete_expired"
|
|
208
|
-
| "trialing"
|
|
209
|
-
| "active"
|
|
210
|
-
| "past_due"
|
|
211
|
-
| "canceled"
|
|
212
|
-
| "unpaid";
|
|
213
|
-
/** Format: date-time */
|
|
214
|
-
created_at?: string;
|
|
215
|
-
/** Format: date-time */
|
|
216
|
-
updated_at?: string;
|
|
217
|
-
/** Format: date-time */
|
|
218
|
-
deleted_at?: string;
|
|
219
|
-
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
220
|
-
billing_id: string;
|
|
27
|
+
"/api/entitlement/subscriptions/{subscriptionId}/cancel": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
get?: never;
|
|
35
|
+
put?: never;
|
|
36
|
+
/** Cancel an existing subscription . The subscription will remain active until the end of the billing period and then it will be canceled. */
|
|
37
|
+
post: operations["cancelSubscription"];
|
|
38
|
+
delete?: never;
|
|
39
|
+
options?: never;
|
|
40
|
+
head?: never;
|
|
41
|
+
patch?: never;
|
|
42
|
+
trace?: never;
|
|
221
43
|
};
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
content: {
|
|
239
|
-
"text/plain": string;
|
|
240
|
-
};
|
|
44
|
+
"/api/entitlement/subscriptions/create": {
|
|
45
|
+
parameters: {
|
|
46
|
+
query?: never;
|
|
47
|
+
header?: never;
|
|
48
|
+
path?: never;
|
|
49
|
+
cookie?: never;
|
|
50
|
+
};
|
|
51
|
+
get?: never;
|
|
52
|
+
put?: never;
|
|
53
|
+
/** Create a new subscription for an organization */
|
|
54
|
+
post: operations["createSubscription"];
|
|
55
|
+
delete?: never;
|
|
56
|
+
options?: never;
|
|
57
|
+
head?: never;
|
|
58
|
+
patch?: never;
|
|
59
|
+
trace?: never;
|
|
241
60
|
};
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
61
|
+
"/api/entitlement/subscriptions/{subscriptionId}/upgrade": {
|
|
62
|
+
parameters: {
|
|
63
|
+
query?: never;
|
|
64
|
+
header?: never;
|
|
65
|
+
path?: never;
|
|
66
|
+
cookie?: never;
|
|
67
|
+
};
|
|
68
|
+
get?: never;
|
|
69
|
+
put?: never;
|
|
70
|
+
/** Upgrade or downgrade an existing subscription by changing one of the plans in the subscription */
|
|
71
|
+
post: operations["upgradeSubscription"];
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
247
77
|
};
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
78
|
+
"/api/entitlement/subscriptions/{subscriptionId}/upgradePreview": {
|
|
79
|
+
parameters: {
|
|
80
|
+
query?: never;
|
|
81
|
+
header?: never;
|
|
82
|
+
path?: never;
|
|
83
|
+
cookie?: never;
|
|
84
|
+
};
|
|
85
|
+
get?: never;
|
|
86
|
+
put?: never;
|
|
87
|
+
/** Preview the invoice for upgrading or downgrading an existing subscription by changing one of the plans in the subscription */
|
|
88
|
+
post: operations["previewSubscriptionUpgrade"];
|
|
89
|
+
delete?: never;
|
|
90
|
+
options?: never;
|
|
91
|
+
head?: never;
|
|
92
|
+
patch?: never;
|
|
93
|
+
trace?: never;
|
|
253
94
|
};
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
95
|
+
"/api/entitlement/subscriptions/webhooks": {
|
|
96
|
+
parameters: {
|
|
97
|
+
query?: never;
|
|
98
|
+
header?: never;
|
|
99
|
+
path?: never;
|
|
100
|
+
cookie?: never;
|
|
101
|
+
};
|
|
102
|
+
get?: never;
|
|
103
|
+
put?: never;
|
|
104
|
+
/** Handle webhook events from payment processors */
|
|
105
|
+
post: operations["handleSubscriptionWebhook"];
|
|
106
|
+
delete?: never;
|
|
107
|
+
options?: never;
|
|
108
|
+
head?: never;
|
|
109
|
+
patch?: never;
|
|
110
|
+
trace?: never;
|
|
259
111
|
};
|
|
260
|
-
};
|
|
261
|
-
parameters: {
|
|
262
|
-
/** @description Subscription ID */
|
|
263
|
-
subscriptionId: string;
|
|
264
|
-
/** @description Get responses by page */
|
|
265
|
-
page: string;
|
|
266
|
-
/** @description Get responses by pagesize */
|
|
267
|
-
pagesize: string;
|
|
268
|
-
/** @description Get responses by pagesize (pass all to get all responses) */
|
|
269
|
-
pagesizeWithAll: string;
|
|
270
|
-
/** @description Get ordered responses */
|
|
271
|
-
order: string;
|
|
272
|
-
};
|
|
273
112
|
}
|
|
274
|
-
|
|
275
|
-
export interface
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
113
|
+
export type webhooks = Record<string, never>;
|
|
114
|
+
export interface components {
|
|
115
|
+
schemas: {
|
|
116
|
+
/**
|
|
117
|
+
* @description Supported payment processors
|
|
118
|
+
* @enum {string}
|
|
119
|
+
*/
|
|
120
|
+
PaymentProcessor: "stripe" | "paypal" | "braintree";
|
|
121
|
+
CreateSubscriptionRequest: {
|
|
122
|
+
/** @description Organization ID */
|
|
123
|
+
orgId?: string;
|
|
124
|
+
/** @description Price ID from the payment processor */
|
|
125
|
+
planId?: string;
|
|
126
|
+
/** @description Coupon ID to apply */
|
|
127
|
+
couponId?: string;
|
|
128
|
+
/** @description Number of users in the organization */
|
|
129
|
+
userCount?: number;
|
|
130
|
+
/**
|
|
131
|
+
* Format: email
|
|
132
|
+
* @description Email of the customer
|
|
133
|
+
*/
|
|
134
|
+
email?: string;
|
|
135
|
+
/**
|
|
136
|
+
* @description Supported payment processors
|
|
137
|
+
* @enum {string}
|
|
138
|
+
*/
|
|
139
|
+
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
140
|
+
};
|
|
141
|
+
UpgradeSubscriptionRequest: {
|
|
142
|
+
/**
|
|
143
|
+
* Format: uuid
|
|
144
|
+
* @description Old Plan id that is being changed
|
|
145
|
+
*/
|
|
146
|
+
oldPlanId?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Format: uuid
|
|
149
|
+
* @description New Plan id that is being changed to
|
|
150
|
+
*/
|
|
151
|
+
newPlanId?: string;
|
|
152
|
+
};
|
|
153
|
+
CreateSubscriptionResponse: {
|
|
154
|
+
subscriptionId?: string;
|
|
155
|
+
clientSecret?: string;
|
|
156
|
+
};
|
|
157
|
+
UpdateUsersRequest: {
|
|
158
|
+
/**
|
|
159
|
+
* @description Supported payment processors
|
|
160
|
+
* @enum {string}
|
|
161
|
+
*/
|
|
162
|
+
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
163
|
+
};
|
|
164
|
+
CancelSubscriptionRequest: {
|
|
165
|
+
/** @description Subscription ID from the payment processor */
|
|
166
|
+
subscriptionId?: string;
|
|
167
|
+
/**
|
|
168
|
+
* @description Supported payment processors
|
|
169
|
+
* @enum {string}
|
|
170
|
+
*/
|
|
171
|
+
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
172
|
+
};
|
|
173
|
+
/** @description Payload for webhook events from payment processors */
|
|
174
|
+
WebhookEvent: Record<string, never>;
|
|
175
|
+
SubscriptionPage: {
|
|
295
176
|
page: number;
|
|
296
177
|
page_size: number;
|
|
297
178
|
total_count: number;
|
|
298
179
|
subscriptions: {
|
|
299
|
-
/**
|
|
300
|
-
* Format: uuid
|
|
301
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
302
|
-
*/
|
|
303
|
-
id: string;
|
|
304
|
-
/**
|
|
305
|
-
* Format: uuid
|
|
306
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
307
|
-
*/
|
|
308
|
-
org_id: string;
|
|
309
|
-
/**
|
|
310
|
-
* Format: uuid
|
|
311
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
312
|
-
*/
|
|
313
|
-
plan_id: string;
|
|
314
|
-
plan?: {
|
|
315
180
|
/**
|
|
316
181
|
* Format: uuid
|
|
317
182
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
318
183
|
*/
|
|
319
184
|
id: string;
|
|
320
185
|
/**
|
|
321
|
-
*
|
|
322
|
-
* @
|
|
186
|
+
* Format: uuid
|
|
187
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
323
188
|
*/
|
|
324
|
-
|
|
325
|
-
/** @enum {string} */
|
|
326
|
-
cadence: "monthly" | "yearly";
|
|
327
|
-
/** @enum {string} */
|
|
328
|
-
unit: "user" | "free";
|
|
329
|
-
/** @description Minimum number of units required for the plan */
|
|
330
|
-
minimum_units: number;
|
|
331
|
-
/** @description Price per unit of the plan */
|
|
332
|
-
price_per_unit: number;
|
|
333
|
-
/** @enum {string} */
|
|
334
|
-
currency: "usd";
|
|
335
|
-
};
|
|
336
|
-
quantity: number;
|
|
337
|
-
/** Format: date-time */
|
|
338
|
-
start_date?: string;
|
|
339
|
-
/** Format: date-time */
|
|
340
|
-
end_date?: string;
|
|
341
|
-
/**
|
|
342
|
-
* @description Possible statuses of a Stripe subscription.
|
|
343
|
-
* @enum {string}
|
|
344
|
-
*/
|
|
345
|
-
status:
|
|
346
|
-
| "incomplete"
|
|
347
|
-
| "incomplete_expired"
|
|
348
|
-
| "trialing"
|
|
349
|
-
| "active"
|
|
350
|
-
| "past_due"
|
|
351
|
-
| "canceled"
|
|
352
|
-
| "unpaid";
|
|
353
|
-
/** Format: date-time */
|
|
354
|
-
created_at?: string;
|
|
355
|
-
/** Format: date-time */
|
|
356
|
-
updated_at?: string;
|
|
357
|
-
/** Format: date-time */
|
|
358
|
-
deleted_at?: string;
|
|
359
|
-
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
360
|
-
billing_id: string;
|
|
361
|
-
}[];
|
|
362
|
-
};
|
|
363
|
-
};
|
|
364
|
-
};
|
|
365
|
-
/** Invalid request body or request param */
|
|
366
|
-
400: {
|
|
367
|
-
content: {
|
|
368
|
-
"text/plain": string;
|
|
369
|
-
};
|
|
370
|
-
};
|
|
371
|
-
/** Expired JWT token used or insufficient privilege */
|
|
372
|
-
401: {
|
|
373
|
-
content: {
|
|
374
|
-
"text/plain": string;
|
|
375
|
-
};
|
|
376
|
-
};
|
|
377
|
-
/** Internal server error */
|
|
378
|
-
500: {
|
|
379
|
-
content: {
|
|
380
|
-
"text/plain": string;
|
|
381
|
-
};
|
|
382
|
-
};
|
|
383
|
-
};
|
|
384
|
-
};
|
|
385
|
-
cancelSubscription: {
|
|
386
|
-
parameters: {
|
|
387
|
-
path: {
|
|
388
|
-
/** Subscription ID */
|
|
389
|
-
subscriptionId: string;
|
|
390
|
-
};
|
|
391
|
-
};
|
|
392
|
-
responses: {
|
|
393
|
-
200: {
|
|
394
|
-
content: {
|
|
395
|
-
"application/json": {
|
|
396
|
-
page: number;
|
|
397
|
-
page_size: number;
|
|
398
|
-
total_count: number;
|
|
399
|
-
subscriptions: {
|
|
400
|
-
/**
|
|
401
|
-
* Format: uuid
|
|
402
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
403
|
-
*/
|
|
404
|
-
id: string;
|
|
405
|
-
/**
|
|
406
|
-
* Format: uuid
|
|
407
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
408
|
-
*/
|
|
409
|
-
org_id: string;
|
|
410
|
-
/**
|
|
411
|
-
* Format: uuid
|
|
412
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
413
|
-
*/
|
|
414
|
-
plan_id: string;
|
|
415
|
-
plan?: {
|
|
189
|
+
org_id: string;
|
|
416
190
|
/**
|
|
417
191
|
* Format: uuid
|
|
418
192
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
419
193
|
*/
|
|
420
|
-
|
|
194
|
+
plan_id: string;
|
|
195
|
+
plan?: {
|
|
196
|
+
/**
|
|
197
|
+
* Format: uuid
|
|
198
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
199
|
+
*/
|
|
200
|
+
id: string;
|
|
201
|
+
/**
|
|
202
|
+
* @description Name of the plan
|
|
203
|
+
* @enum {string}
|
|
204
|
+
*/
|
|
205
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
206
|
+
/** @enum {string} */
|
|
207
|
+
cadence: "monthly" | "yearly";
|
|
208
|
+
/** @enum {string} */
|
|
209
|
+
unit: "user" | "free";
|
|
210
|
+
/** @description Minimum number of units required for the plan */
|
|
211
|
+
minimum_units: number;
|
|
212
|
+
/** @description Price per unit of the plan */
|
|
213
|
+
price_per_unit: number;
|
|
214
|
+
/** @enum {string} */
|
|
215
|
+
currency: "usd";
|
|
216
|
+
};
|
|
217
|
+
quantity: number;
|
|
218
|
+
/** Format: date-time */
|
|
219
|
+
start_date?: string;
|
|
220
|
+
/** Format: date-time */
|
|
221
|
+
end_date?: string;
|
|
421
222
|
/**
|
|
422
|
-
* @description
|
|
223
|
+
* @description Possible statuses of a Stripe subscription.
|
|
423
224
|
* @enum {string}
|
|
424
225
|
*/
|
|
425
|
-
|
|
426
|
-
/**
|
|
427
|
-
|
|
428
|
-
/**
|
|
429
|
-
|
|
430
|
-
/**
|
|
431
|
-
|
|
432
|
-
/** @description
|
|
433
|
-
|
|
434
|
-
/** @enum {string} */
|
|
435
|
-
currency: "usd";
|
|
436
|
-
};
|
|
437
|
-
quantity: number;
|
|
438
|
-
/** Format: date-time */
|
|
439
|
-
start_date?: string;
|
|
440
|
-
/** Format: date-time */
|
|
441
|
-
end_date?: string;
|
|
442
|
-
/**
|
|
443
|
-
* @description Possible statuses of a Stripe subscription.
|
|
444
|
-
* @enum {string}
|
|
445
|
-
*/
|
|
446
|
-
status:
|
|
447
|
-
| "incomplete"
|
|
448
|
-
| "incomplete_expired"
|
|
449
|
-
| "trialing"
|
|
450
|
-
| "active"
|
|
451
|
-
| "past_due"
|
|
452
|
-
| "canceled"
|
|
453
|
-
| "unpaid";
|
|
454
|
-
/** Format: date-time */
|
|
455
|
-
created_at?: string;
|
|
456
|
-
/** Format: date-time */
|
|
457
|
-
updated_at?: string;
|
|
458
|
-
/** Format: date-time */
|
|
459
|
-
deleted_at?: string;
|
|
460
|
-
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
461
|
-
billing_id: string;
|
|
226
|
+
status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
227
|
+
/** Format: date-time */
|
|
228
|
+
created_at?: string;
|
|
229
|
+
/** Format: date-time */
|
|
230
|
+
updated_at?: string;
|
|
231
|
+
/** Format: date-time */
|
|
232
|
+
deleted_at?: string;
|
|
233
|
+
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
234
|
+
billing_id: string;
|
|
462
235
|
}[];
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
};
|
|
466
|
-
/** Invalid request body or request param */
|
|
467
|
-
400: {
|
|
468
|
-
content: {
|
|
469
|
-
"text/plain": string;
|
|
470
|
-
};
|
|
471
|
-
};
|
|
472
|
-
/** Expired JWT token used or insufficient privilege */
|
|
473
|
-
401: {
|
|
474
|
-
content: {
|
|
475
|
-
"text/plain": string;
|
|
476
|
-
};
|
|
477
|
-
};
|
|
478
|
-
/** Result not found */
|
|
479
|
-
404: {
|
|
480
|
-
content: {
|
|
481
|
-
"text/plain": string;
|
|
482
|
-
};
|
|
483
|
-
};
|
|
484
|
-
/** Internal server error */
|
|
485
|
-
500: {
|
|
486
|
-
content: {
|
|
487
|
-
"text/plain": string;
|
|
488
|
-
};
|
|
489
|
-
};
|
|
490
|
-
};
|
|
491
|
-
};
|
|
492
|
-
createSubscription: {
|
|
493
|
-
responses: {
|
|
494
|
-
/** A new subscription has been created */
|
|
495
|
-
200: {
|
|
496
|
-
content: {
|
|
497
|
-
"application/json": {
|
|
498
|
-
subscriptionId?: string;
|
|
499
|
-
clientSecret?: string;
|
|
500
|
-
};
|
|
501
|
-
};
|
|
502
|
-
};
|
|
503
|
-
/** Invalid request body or request param */
|
|
504
|
-
400: {
|
|
505
|
-
content: {
|
|
506
|
-
"text/plain": string;
|
|
507
|
-
};
|
|
508
|
-
};
|
|
509
|
-
/** Expired JWT token used or insufficient privilege */
|
|
510
|
-
401: {
|
|
511
|
-
content: {
|
|
512
|
-
"text/plain": string;
|
|
513
|
-
};
|
|
514
|
-
};
|
|
515
|
-
/** Internal server error */
|
|
516
|
-
500: {
|
|
517
|
-
content: {
|
|
518
|
-
"text/plain": string;
|
|
519
|
-
};
|
|
520
|
-
};
|
|
521
|
-
};
|
|
522
|
-
requestBody: {
|
|
523
|
-
content: {
|
|
524
|
-
"application/json": {
|
|
525
|
-
/** @description Organization ID */
|
|
526
|
-
orgId?: string;
|
|
527
|
-
/** @description Price ID from the payment processor */
|
|
528
|
-
planId?: string;
|
|
529
|
-
/** @description Coupon ID to apply */
|
|
530
|
-
couponId?: string;
|
|
531
|
-
/** @description Number of users in the organization */
|
|
532
|
-
userCount?: number;
|
|
533
|
-
/**
|
|
534
|
-
* Format: email
|
|
535
|
-
* @description Email of the customer
|
|
536
|
-
*/
|
|
537
|
-
email?: string;
|
|
538
|
-
/**
|
|
539
|
-
* @description Supported payment processors
|
|
540
|
-
* @enum {string}
|
|
541
|
-
*/
|
|
542
|
-
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
543
|
-
};
|
|
544
|
-
};
|
|
545
|
-
};
|
|
546
|
-
};
|
|
547
|
-
upgradeSubscription: {
|
|
548
|
-
parameters: {
|
|
549
|
-
path: {
|
|
550
|
-
/** Subscription ID */
|
|
551
|
-
subscriptionId: string;
|
|
552
|
-
};
|
|
553
|
-
};
|
|
554
|
-
responses: {
|
|
555
|
-
200: {
|
|
556
|
-
content: {
|
|
557
|
-
"application/json": {
|
|
236
|
+
};
|
|
237
|
+
Subscription: {
|
|
558
238
|
/**
|
|
559
239
|
* Format: uuid
|
|
560
240
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
@@ -571,26 +251,26 @@ export interface operations {
|
|
|
571
251
|
*/
|
|
572
252
|
plan_id: string;
|
|
573
253
|
plan?: {
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
254
|
+
/**
|
|
255
|
+
* Format: uuid
|
|
256
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
257
|
+
*/
|
|
258
|
+
id: string;
|
|
259
|
+
/**
|
|
260
|
+
* @description Name of the plan
|
|
261
|
+
* @enum {string}
|
|
262
|
+
*/
|
|
263
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
264
|
+
/** @enum {string} */
|
|
265
|
+
cadence: "monthly" | "yearly";
|
|
266
|
+
/** @enum {string} */
|
|
267
|
+
unit: "user" | "free";
|
|
268
|
+
/** @description Minimum number of units required for the plan */
|
|
269
|
+
minimum_units: number;
|
|
270
|
+
/** @description Price per unit of the plan */
|
|
271
|
+
price_per_unit: number;
|
|
272
|
+
/** @enum {string} */
|
|
273
|
+
currency: "usd";
|
|
594
274
|
};
|
|
595
275
|
quantity: number;
|
|
596
276
|
/** Format: date-time */
|
|
@@ -601,14 +281,7 @@ export interface operations {
|
|
|
601
281
|
* @description Possible statuses of a Stripe subscription.
|
|
602
282
|
* @enum {string}
|
|
603
283
|
*/
|
|
604
|
-
status:
|
|
605
|
-
| "incomplete"
|
|
606
|
-
| "incomplete_expired"
|
|
607
|
-
| "trialing"
|
|
608
|
-
| "active"
|
|
609
|
-
| "past_due"
|
|
610
|
-
| "canceled"
|
|
611
|
-
| "unpaid";
|
|
284
|
+
status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
612
285
|
/** Format: date-time */
|
|
613
286
|
created_at?: string;
|
|
614
287
|
/** Format: date-time */
|
|
@@ -617,136 +290,628 @@ export interface operations {
|
|
|
617
290
|
deleted_at?: string;
|
|
618
291
|
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
619
292
|
billing_id: string;
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
"text/plain": string;
|
|
627
|
-
};
|
|
628
|
-
};
|
|
629
|
-
/** Expired JWT token used or insufficient privilege */
|
|
630
|
-
401: {
|
|
631
|
-
content: {
|
|
632
|
-
"text/plain": string;
|
|
633
|
-
};
|
|
634
|
-
};
|
|
635
|
-
/** Result not found */
|
|
636
|
-
404: {
|
|
637
|
-
content: {
|
|
638
|
-
"text/plain": string;
|
|
639
|
-
};
|
|
640
|
-
};
|
|
641
|
-
/** Internal server error */
|
|
642
|
-
500: {
|
|
643
|
-
content: {
|
|
644
|
-
"text/plain": string;
|
|
645
|
-
};
|
|
646
|
-
};
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* @description Possible statuses of a Stripe subscription.
|
|
296
|
+
* @enum {string}
|
|
297
|
+
*/
|
|
298
|
+
SubscriptionStatus: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
647
299
|
};
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
300
|
+
responses: {
|
|
301
|
+
/** @description Invalid request body or request param */
|
|
302
|
+
400: {
|
|
303
|
+
headers: {
|
|
304
|
+
[name: string]: unknown;
|
|
305
|
+
};
|
|
306
|
+
content: {
|
|
307
|
+
"text/plain": string;
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
311
|
+
401: {
|
|
312
|
+
headers: {
|
|
313
|
+
[name: string]: unknown;
|
|
314
|
+
};
|
|
315
|
+
content: {
|
|
316
|
+
"text/plain": string;
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
/** @description Result not found */
|
|
320
|
+
404: {
|
|
321
|
+
headers: {
|
|
322
|
+
[name: string]: unknown;
|
|
323
|
+
};
|
|
324
|
+
content: {
|
|
325
|
+
"text/plain": string;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
/** @description Internal server error */
|
|
329
|
+
500: {
|
|
330
|
+
headers: {
|
|
331
|
+
[name: string]: unknown;
|
|
332
|
+
};
|
|
333
|
+
content: {
|
|
334
|
+
"text/plain": string;
|
|
335
|
+
};
|
|
336
|
+
};
|
|
663
337
|
};
|
|
664
|
-
};
|
|
665
|
-
previewSubscriptionUpgrade: {
|
|
666
338
|
parameters: {
|
|
667
|
-
|
|
668
|
-
/** Subscription ID */
|
|
339
|
+
/** @description Subscription ID */
|
|
669
340
|
subscriptionId: string;
|
|
670
|
-
|
|
341
|
+
/** @description Get responses by page */
|
|
342
|
+
page: string;
|
|
343
|
+
/** @description Get responses by pagesize */
|
|
344
|
+
pagesize: string;
|
|
345
|
+
/** @description Get responses by pagesize (pass all to get all responses) */
|
|
346
|
+
pagesizeWithAll: string;
|
|
347
|
+
/** @description Get ordered responses */
|
|
348
|
+
order: string;
|
|
671
349
|
};
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
350
|
+
requestBodies: never;
|
|
351
|
+
headers: never;
|
|
352
|
+
pathItems: never;
|
|
353
|
+
}
|
|
354
|
+
export type $defs = Record<string, never>;
|
|
355
|
+
export interface operations {
|
|
356
|
+
getSubscriptions: {
|
|
357
|
+
parameters: {
|
|
358
|
+
query?: {
|
|
359
|
+
/** @description Get responses by page */
|
|
360
|
+
page?: string;
|
|
361
|
+
/** @description Get responses by pagesize */
|
|
362
|
+
pagesize?: string;
|
|
363
|
+
/** @description Get ordered responses */
|
|
364
|
+
order?: string;
|
|
365
|
+
/** @description Filter subscriptions by status */
|
|
366
|
+
status?: string[];
|
|
367
|
+
};
|
|
368
|
+
header?: never;
|
|
369
|
+
path?: never;
|
|
370
|
+
cookie?: never;
|
|
371
|
+
};
|
|
372
|
+
requestBody?: never;
|
|
373
|
+
responses: {
|
|
374
|
+
/** @description Get subscription response */
|
|
375
|
+
200: {
|
|
376
|
+
headers: {
|
|
377
|
+
[name: string]: unknown;
|
|
378
|
+
};
|
|
379
|
+
content: {
|
|
380
|
+
"application/json": {
|
|
381
|
+
page: number;
|
|
382
|
+
page_size: number;
|
|
383
|
+
total_count: number;
|
|
384
|
+
subscriptions: {
|
|
385
|
+
/**
|
|
386
|
+
* Format: uuid
|
|
387
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
388
|
+
*/
|
|
389
|
+
id: string;
|
|
390
|
+
/**
|
|
391
|
+
* Format: uuid
|
|
392
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
393
|
+
*/
|
|
394
|
+
org_id: string;
|
|
395
|
+
/**
|
|
396
|
+
* Format: uuid
|
|
397
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
398
|
+
*/
|
|
399
|
+
plan_id: string;
|
|
400
|
+
plan?: {
|
|
401
|
+
/**
|
|
402
|
+
* Format: uuid
|
|
403
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
404
|
+
*/
|
|
405
|
+
id: string;
|
|
406
|
+
/**
|
|
407
|
+
* @description Name of the plan
|
|
408
|
+
* @enum {string}
|
|
409
|
+
*/
|
|
410
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
411
|
+
/** @enum {string} */
|
|
412
|
+
cadence: "monthly" | "yearly";
|
|
413
|
+
/** @enum {string} */
|
|
414
|
+
unit: "user" | "free";
|
|
415
|
+
/** @description Minimum number of units required for the plan */
|
|
416
|
+
minimum_units: number;
|
|
417
|
+
/** @description Price per unit of the plan */
|
|
418
|
+
price_per_unit: number;
|
|
419
|
+
/** @enum {string} */
|
|
420
|
+
currency: "usd";
|
|
421
|
+
};
|
|
422
|
+
quantity: number;
|
|
423
|
+
/** Format: date-time */
|
|
424
|
+
start_date?: string;
|
|
425
|
+
/** Format: date-time */
|
|
426
|
+
end_date?: string;
|
|
427
|
+
/**
|
|
428
|
+
* @description Possible statuses of a Stripe subscription.
|
|
429
|
+
* @enum {string}
|
|
430
|
+
*/
|
|
431
|
+
status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
432
|
+
/** Format: date-time */
|
|
433
|
+
created_at?: string;
|
|
434
|
+
/** Format: date-time */
|
|
435
|
+
updated_at?: string;
|
|
436
|
+
/** Format: date-time */
|
|
437
|
+
deleted_at?: string;
|
|
438
|
+
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
439
|
+
billing_id: string;
|
|
440
|
+
}[];
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
/** @description Invalid request body or request param */
|
|
445
|
+
400: {
|
|
446
|
+
headers: {
|
|
447
|
+
[name: string]: unknown;
|
|
448
|
+
};
|
|
449
|
+
content: {
|
|
450
|
+
"text/plain": string;
|
|
451
|
+
};
|
|
452
|
+
};
|
|
453
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
454
|
+
401: {
|
|
455
|
+
headers: {
|
|
456
|
+
[name: string]: unknown;
|
|
457
|
+
};
|
|
458
|
+
content: {
|
|
459
|
+
"text/plain": string;
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
/** @description Internal server error */
|
|
463
|
+
500: {
|
|
464
|
+
headers: {
|
|
465
|
+
[name: string]: unknown;
|
|
466
|
+
};
|
|
467
|
+
content: {
|
|
468
|
+
"text/plain": string;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
703
472
|
};
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
473
|
+
cancelSubscription: {
|
|
474
|
+
parameters: {
|
|
475
|
+
query?: never;
|
|
476
|
+
header?: never;
|
|
477
|
+
path: {
|
|
478
|
+
/** @description Subscription ID */
|
|
479
|
+
subscriptionId: string;
|
|
480
|
+
};
|
|
481
|
+
cookie?: never;
|
|
482
|
+
};
|
|
483
|
+
requestBody?: never;
|
|
484
|
+
responses: {
|
|
485
|
+
200: {
|
|
486
|
+
headers: {
|
|
487
|
+
[name: string]: unknown;
|
|
488
|
+
};
|
|
489
|
+
content: {
|
|
490
|
+
"application/json": {
|
|
491
|
+
page: number;
|
|
492
|
+
page_size: number;
|
|
493
|
+
total_count: number;
|
|
494
|
+
subscriptions: {
|
|
495
|
+
/**
|
|
496
|
+
* Format: uuid
|
|
497
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
498
|
+
*/
|
|
499
|
+
id: string;
|
|
500
|
+
/**
|
|
501
|
+
* Format: uuid
|
|
502
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
503
|
+
*/
|
|
504
|
+
org_id: string;
|
|
505
|
+
/**
|
|
506
|
+
* Format: uuid
|
|
507
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
508
|
+
*/
|
|
509
|
+
plan_id: string;
|
|
510
|
+
plan?: {
|
|
511
|
+
/**
|
|
512
|
+
* Format: uuid
|
|
513
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
514
|
+
*/
|
|
515
|
+
id: string;
|
|
516
|
+
/**
|
|
517
|
+
* @description Name of the plan
|
|
518
|
+
* @enum {string}
|
|
519
|
+
*/
|
|
520
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
521
|
+
/** @enum {string} */
|
|
522
|
+
cadence: "monthly" | "yearly";
|
|
523
|
+
/** @enum {string} */
|
|
524
|
+
unit: "user" | "free";
|
|
525
|
+
/** @description Minimum number of units required for the plan */
|
|
526
|
+
minimum_units: number;
|
|
527
|
+
/** @description Price per unit of the plan */
|
|
528
|
+
price_per_unit: number;
|
|
529
|
+
/** @enum {string} */
|
|
530
|
+
currency: "usd";
|
|
531
|
+
};
|
|
532
|
+
quantity: number;
|
|
533
|
+
/** Format: date-time */
|
|
534
|
+
start_date?: string;
|
|
535
|
+
/** Format: date-time */
|
|
536
|
+
end_date?: string;
|
|
537
|
+
/**
|
|
538
|
+
* @description Possible statuses of a Stripe subscription.
|
|
539
|
+
* @enum {string}
|
|
540
|
+
*/
|
|
541
|
+
status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
542
|
+
/** Format: date-time */
|
|
543
|
+
created_at?: string;
|
|
544
|
+
/** Format: date-time */
|
|
545
|
+
updated_at?: string;
|
|
546
|
+
/** Format: date-time */
|
|
547
|
+
deleted_at?: string;
|
|
548
|
+
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
549
|
+
billing_id: string;
|
|
550
|
+
}[];
|
|
551
|
+
};
|
|
552
|
+
};
|
|
553
|
+
};
|
|
554
|
+
/** @description Invalid request body or request param */
|
|
555
|
+
400: {
|
|
556
|
+
headers: {
|
|
557
|
+
[name: string]: unknown;
|
|
558
|
+
};
|
|
559
|
+
content: {
|
|
560
|
+
"text/plain": string;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
564
|
+
401: {
|
|
565
|
+
headers: {
|
|
566
|
+
[name: string]: unknown;
|
|
567
|
+
};
|
|
568
|
+
content: {
|
|
569
|
+
"text/plain": string;
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
/** @description Result not found */
|
|
573
|
+
404: {
|
|
574
|
+
headers: {
|
|
575
|
+
[name: string]: unknown;
|
|
576
|
+
};
|
|
577
|
+
content: {
|
|
578
|
+
"text/plain": string;
|
|
579
|
+
};
|
|
580
|
+
};
|
|
581
|
+
/** @description Internal server error */
|
|
582
|
+
500: {
|
|
583
|
+
headers: {
|
|
584
|
+
[name: string]: unknown;
|
|
585
|
+
};
|
|
586
|
+
content: {
|
|
587
|
+
"text/plain": string;
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
};
|
|
719
591
|
};
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
592
|
+
createSubscription: {
|
|
593
|
+
parameters: {
|
|
594
|
+
query?: never;
|
|
595
|
+
header?: never;
|
|
596
|
+
path?: never;
|
|
597
|
+
cookie?: never;
|
|
598
|
+
};
|
|
599
|
+
requestBody: {
|
|
600
|
+
content: {
|
|
601
|
+
"application/json": {
|
|
602
|
+
/** @description Organization ID */
|
|
603
|
+
orgId?: string;
|
|
604
|
+
/** @description Price ID from the payment processor */
|
|
605
|
+
planId?: string;
|
|
606
|
+
/** @description Coupon ID to apply */
|
|
607
|
+
couponId?: string;
|
|
608
|
+
/** @description Number of users in the organization */
|
|
609
|
+
userCount?: number;
|
|
610
|
+
/**
|
|
611
|
+
* Format: email
|
|
612
|
+
* @description Email of the customer
|
|
613
|
+
*/
|
|
614
|
+
email?: string;
|
|
615
|
+
/**
|
|
616
|
+
* @description Supported payment processors
|
|
617
|
+
* @enum {string}
|
|
618
|
+
*/
|
|
619
|
+
paymentProcessor?: "stripe" | "paypal" | "braintree";
|
|
620
|
+
};
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
responses: {
|
|
624
|
+
/** @description A new subscription has been created */
|
|
625
|
+
200: {
|
|
626
|
+
headers: {
|
|
627
|
+
[name: string]: unknown;
|
|
628
|
+
};
|
|
629
|
+
content: {
|
|
630
|
+
"application/json": {
|
|
631
|
+
subscriptionId?: string;
|
|
632
|
+
clientSecret?: string;
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
};
|
|
636
|
+
/** @description Invalid request body or request param */
|
|
637
|
+
400: {
|
|
638
|
+
headers: {
|
|
639
|
+
[name: string]: unknown;
|
|
640
|
+
};
|
|
641
|
+
content: {
|
|
642
|
+
"text/plain": string;
|
|
643
|
+
};
|
|
644
|
+
};
|
|
645
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
646
|
+
401: {
|
|
647
|
+
headers: {
|
|
648
|
+
[name: string]: unknown;
|
|
649
|
+
};
|
|
650
|
+
content: {
|
|
651
|
+
"text/plain": string;
|
|
652
|
+
};
|
|
653
|
+
};
|
|
654
|
+
/** @description Internal server error */
|
|
655
|
+
500: {
|
|
656
|
+
headers: {
|
|
657
|
+
[name: string]: unknown;
|
|
658
|
+
};
|
|
659
|
+
content: {
|
|
660
|
+
"text/plain": string;
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
};
|
|
743
664
|
};
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
665
|
+
upgradeSubscription: {
|
|
666
|
+
parameters: {
|
|
667
|
+
query?: never;
|
|
668
|
+
header?: never;
|
|
669
|
+
path: {
|
|
670
|
+
/** @description Subscription ID */
|
|
671
|
+
subscriptionId: string;
|
|
672
|
+
};
|
|
673
|
+
cookie?: never;
|
|
674
|
+
};
|
|
675
|
+
requestBody: {
|
|
676
|
+
content: {
|
|
677
|
+
"application/json": {
|
|
678
|
+
/**
|
|
679
|
+
* Format: uuid
|
|
680
|
+
* @description Old Plan id that is being changed
|
|
681
|
+
*/
|
|
682
|
+
oldPlanId?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Format: uuid
|
|
685
|
+
* @description New Plan id that is being changed to
|
|
686
|
+
*/
|
|
687
|
+
newPlanId?: string;
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
responses: {
|
|
692
|
+
200: {
|
|
693
|
+
headers: {
|
|
694
|
+
[name: string]: unknown;
|
|
695
|
+
};
|
|
696
|
+
content: {
|
|
697
|
+
"application/json": {
|
|
698
|
+
/**
|
|
699
|
+
* Format: uuid
|
|
700
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
701
|
+
*/
|
|
702
|
+
id: string;
|
|
703
|
+
/**
|
|
704
|
+
* Format: uuid
|
|
705
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
706
|
+
*/
|
|
707
|
+
org_id: string;
|
|
708
|
+
/**
|
|
709
|
+
* Format: uuid
|
|
710
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
711
|
+
*/
|
|
712
|
+
plan_id: string;
|
|
713
|
+
plan?: {
|
|
714
|
+
/**
|
|
715
|
+
* Format: uuid
|
|
716
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
717
|
+
*/
|
|
718
|
+
id: string;
|
|
719
|
+
/**
|
|
720
|
+
* @description Name of the plan
|
|
721
|
+
* @enum {string}
|
|
722
|
+
*/
|
|
723
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
724
|
+
/** @enum {string} */
|
|
725
|
+
cadence: "monthly" | "yearly";
|
|
726
|
+
/** @enum {string} */
|
|
727
|
+
unit: "user" | "free";
|
|
728
|
+
/** @description Minimum number of units required for the plan */
|
|
729
|
+
minimum_units: number;
|
|
730
|
+
/** @description Price per unit of the plan */
|
|
731
|
+
price_per_unit: number;
|
|
732
|
+
/** @enum {string} */
|
|
733
|
+
currency: "usd";
|
|
734
|
+
};
|
|
735
|
+
quantity: number;
|
|
736
|
+
/** Format: date-time */
|
|
737
|
+
start_date?: string;
|
|
738
|
+
/** Format: date-time */
|
|
739
|
+
end_date?: string;
|
|
740
|
+
/**
|
|
741
|
+
* @description Possible statuses of a Stripe subscription.
|
|
742
|
+
* @enum {string}
|
|
743
|
+
*/
|
|
744
|
+
status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
|
|
745
|
+
/** Format: date-time */
|
|
746
|
+
created_at?: string;
|
|
747
|
+
/** Format: date-time */
|
|
748
|
+
updated_at?: string;
|
|
749
|
+
/** Format: date-time */
|
|
750
|
+
deleted_at?: string;
|
|
751
|
+
/** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
|
|
752
|
+
billing_id: string;
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
/** @description Invalid request body or request param */
|
|
757
|
+
400: {
|
|
758
|
+
headers: {
|
|
759
|
+
[name: string]: unknown;
|
|
760
|
+
};
|
|
761
|
+
content: {
|
|
762
|
+
"text/plain": string;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
766
|
+
401: {
|
|
767
|
+
headers: {
|
|
768
|
+
[name: string]: unknown;
|
|
769
|
+
};
|
|
770
|
+
content: {
|
|
771
|
+
"text/plain": string;
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
/** @description Result not found */
|
|
775
|
+
404: {
|
|
776
|
+
headers: {
|
|
777
|
+
[name: string]: unknown;
|
|
778
|
+
};
|
|
779
|
+
content: {
|
|
780
|
+
"text/plain": string;
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
/** @description Internal server error */
|
|
784
|
+
500: {
|
|
785
|
+
headers: {
|
|
786
|
+
[name: string]: unknown;
|
|
787
|
+
};
|
|
788
|
+
content: {
|
|
789
|
+
"text/plain": string;
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
};
|
|
794
|
+
previewSubscriptionUpgrade: {
|
|
795
|
+
parameters: {
|
|
796
|
+
query?: never;
|
|
797
|
+
header?: never;
|
|
798
|
+
path: {
|
|
799
|
+
/** @description Subscription ID */
|
|
800
|
+
subscriptionId: string;
|
|
801
|
+
};
|
|
802
|
+
cookie?: never;
|
|
803
|
+
};
|
|
804
|
+
requestBody: {
|
|
805
|
+
content: {
|
|
806
|
+
"application/json": {
|
|
807
|
+
/**
|
|
808
|
+
* Format: uuid
|
|
809
|
+
* @description Old Plan id that is being changed
|
|
810
|
+
*/
|
|
811
|
+
oldPlanId?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Format: uuid
|
|
814
|
+
* @description New Plan id that is being changed to
|
|
815
|
+
*/
|
|
816
|
+
newPlanId?: string;
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
};
|
|
820
|
+
responses: {
|
|
821
|
+
/** @description Preview of the upgraded subscription invoice */
|
|
822
|
+
200: {
|
|
823
|
+
headers: {
|
|
824
|
+
[name: string]: unknown;
|
|
825
|
+
};
|
|
826
|
+
content: {
|
|
827
|
+
"application/json": Record<string, never>;
|
|
828
|
+
};
|
|
829
|
+
};
|
|
830
|
+
/** @description Invalid request body or request param */
|
|
831
|
+
400: {
|
|
832
|
+
headers: {
|
|
833
|
+
[name: string]: unknown;
|
|
834
|
+
};
|
|
835
|
+
content: {
|
|
836
|
+
"text/plain": string;
|
|
837
|
+
};
|
|
838
|
+
};
|
|
839
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
840
|
+
401: {
|
|
841
|
+
headers: {
|
|
842
|
+
[name: string]: unknown;
|
|
843
|
+
};
|
|
844
|
+
content: {
|
|
845
|
+
"text/plain": string;
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
/** @description Result not found */
|
|
849
|
+
404: {
|
|
850
|
+
headers: {
|
|
851
|
+
[name: string]: unknown;
|
|
852
|
+
};
|
|
853
|
+
content: {
|
|
854
|
+
"text/plain": string;
|
|
855
|
+
};
|
|
856
|
+
};
|
|
857
|
+
/** @description Internal server error */
|
|
858
|
+
500: {
|
|
859
|
+
headers: {
|
|
860
|
+
[name: string]: unknown;
|
|
861
|
+
};
|
|
862
|
+
content: {
|
|
863
|
+
"text/plain": string;
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
handleSubscriptionWebhook: {
|
|
869
|
+
parameters: {
|
|
870
|
+
query?: never;
|
|
871
|
+
header?: never;
|
|
872
|
+
path?: never;
|
|
873
|
+
cookie?: never;
|
|
874
|
+
};
|
|
875
|
+
requestBody: {
|
|
876
|
+
content: {
|
|
877
|
+
"application/json": Record<string, never>;
|
|
878
|
+
};
|
|
879
|
+
};
|
|
880
|
+
responses: {
|
|
881
|
+
/** @description Webhook processed */
|
|
882
|
+
200: {
|
|
883
|
+
headers: {
|
|
884
|
+
[name: string]: unknown;
|
|
885
|
+
};
|
|
886
|
+
content?: never;
|
|
887
|
+
};
|
|
888
|
+
/** @description Invalid request body or request param */
|
|
889
|
+
400: {
|
|
890
|
+
headers: {
|
|
891
|
+
[name: string]: unknown;
|
|
892
|
+
};
|
|
893
|
+
content: {
|
|
894
|
+
"text/plain": string;
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
898
|
+
401: {
|
|
899
|
+
headers: {
|
|
900
|
+
[name: string]: unknown;
|
|
901
|
+
};
|
|
902
|
+
content: {
|
|
903
|
+
"text/plain": string;
|
|
904
|
+
};
|
|
905
|
+
};
|
|
906
|
+
/** @description Internal server error */
|
|
907
|
+
500: {
|
|
908
|
+
headers: {
|
|
909
|
+
[name: string]: unknown;
|
|
910
|
+
};
|
|
911
|
+
content: {
|
|
912
|
+
"text/plain": string;
|
|
913
|
+
};
|
|
914
|
+
};
|
|
915
|
+
};
|
|
748
916
|
};
|
|
749
|
-
};
|
|
750
917
|
}
|
|
751
|
-
|
|
752
|
-
export interface external {}
|