@meshery/schemas 1.3.8 → 1.4.0

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