@meshery/schemas 0.8.107 → 0.8.108

package/dist/constructs/v1beta1/subscription/Subscription.d.mts

@@ -0,0 +1,624 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/entitlement/subscriptions": {
+        /** Returns all subscriptions for the organization */
+        get: operations["getSubscriptions"];
+    };
+    "/api/entitlement/subscriptions/{subscriptionId}/cancel": {
+        post: {
+            parameters: {
+                path: {
+                    /** Subscription ID */
+                    subscriptionId: string;
+                };
+            };
+            responses: {
+                200: {
+                    content: {
+                        "application/json": {
+                            page: number;
+                            page_size: number;
+                            total_count: number;
+                            subscriptions: {
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                ID: string;
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                org_id: string;
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                plan_id: string;
+                                plan?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                     */
+                                    id: string;
+                                    /**
+                                     * @description Name of the plan
+                                     * @enum {string}
+                                     */
+                                    name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                                    /** @enum {string} */
+                                    cadence: "monthly" | "yearly";
+                                    /** @enum {string} */
+                                    unit: "user" | "free";
+                                    /** @description Minimum number of units required for the plan */
+                                    minimum_units: number;
+                                    /** @description Price per unit of the plan */
+                                    price_per_unit: number;
+                                    /** @enum {string} */
+                                    currency: "usd";
+                                } & {
+                                    price_id: unknown;
+                                };
+                                quantity: number;
+                                /** Format: date-time */
+                                start_date?: string;
+                                /** Format: date-time */
+                                end_date?: string;
+                                /**
+                                 * @description Possible statuses of a Stripe subscription.
+                                 * @enum {string}
+                                 */
+                                status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+                                /** Format: date-time */
+                                created_at?: string;
+                                /** Format: date-time */
+                                updated_at?: string;
+                                /** Format: date-time */
+                                deleted_at?: string;
+                                /** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
+                                billing_id: string;
+                            }[];
+                        };
+                    };
+                };
+                /** Invalid request */
+                400: unknown;
+                /** Internal server error */
+                500: unknown;
+            };
+        };
+    };
+    "/api/entitlement/subscriptions/create": {
+        post: {
+            responses: {
+                /** A new subscription has been created */
+                200: {
+                    content: {
+                        "application/json": {
+                            subscription_id?: string;
+                            clientSecret?: string;
+                        };
+                    };
+                };
+                /** Invalid request */
+                400: unknown;
+                /** Internal server error */
+                500: unknown;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description Organization ID */
+                        org_id?: string;
+                        /** @description Price ID from the payment processor */
+                        plan_id?: string;
+                        /** @description Coupon ID to apply */
+                        coupon_id?: string;
+                        /** @description Number of users in the organization */
+                        user_count?: number;
+                        /**
+                         * Format: email
+                         * @description Email of the customer
+                         */
+                        email?: string;
+                        /**
+                         * @description Supported payment processors
+                         * @enum {string}
+                         */
+                        payment_processor?: "stripe" | "paypal" | "braintree";
+                    };
+                };
+            };
+        };
+    };
+    "/api/entitlement/subscriptions/{subscriptionId}/upgrade": {
+        post: {
+            parameters: {
+                path: {
+                    /** Subscription ID */
+                    subscriptionId: string;
+                };
+            };
+            responses: {
+                200: {
+                    content: {
+                        "application/json": {
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            ID: string;
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            org_id: string;
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            plan_id: string;
+                            plan?: {
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                id: string;
+                                /**
+                                 * @description Name of the plan
+                                 * @enum {string}
+                                 */
+                                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                                /** @enum {string} */
+                                cadence: "monthly" | "yearly";
+                                /** @enum {string} */
+                                unit: "user" | "free";
+                                /** @description Minimum number of units required for the plan */
+                                minimum_units: number;
+                                /** @description Price per unit of the plan */
+                                price_per_unit: number;
+                                /** @enum {string} */
+                                currency: "usd";
+                            } & {
+                                price_id: unknown;
+                            };
+                            quantity: number;
+                            /** Format: date-time */
+                            start_date?: string;
+                            /** Format: date-time */
+                            end_date?: string;
+                            /**
+                             * @description Possible statuses of a Stripe subscription.
+                             * @enum {string}
+                             */
+                            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+                            /** Format: date-time */
+                            created_at?: string;
+                            /** Format: date-time */
+                            updated_at?: string;
+                            /** Format: date-time */
+                            deleted_at?: string;
+                            /** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
+                            billing_id: string;
+                        };
+                    };
+                };
+                /** Invalid request */
+                400: unknown;
+                /** Internal server error */
+                500: unknown;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Old Plan id that is being changed
+                         */
+                        old_plan_id?: string;
+                        /**
+                         * Format: uuid
+                         * @description New Plan id that is being changed to
+                         */
+                        new_plan_id?: string;
+                    };
+                };
+            };
+        };
+    };
+    "/api/entitlement/subscriptions/{subscriptionId}/upgradePreview": {
+        post: {
+            parameters: {
+                path: {
+                    /** Subscription ID */
+                    subscriptionId: string;
+                };
+            };
+            responses: {
+                /** Preview of the upgraded subscription invoice */
+                200: {
+                    content: {
+                        "application/json": {
+                            [key: string]: unknown;
+                        };
+                    };
+                };
+                /** Invalid request */
+                400: unknown;
+                /** Internal server error */
+                500: unknown;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Old Plan id that is being changed
+                         */
+                        old_plan_id?: string;
+                        /**
+                         * Format: uuid
+                         * @description New Plan id that is being changed to
+                         */
+                        new_plan_id?: string;
+                    };
+                };
+            };
+        };
+    };
+    "/api/entitlement/subscriptions/webhooks": {
+        post: {
+            responses: {
+                /** Webhook processed successfully */
+                200: unknown;
+                /** Invalid webhook event */
+                400: unknown;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+}
+interface components {
+    schemas: {
+        /**
+         * @description Supported payment processors
+         * @enum {string}
+         */
+        PaymentProcessor: "stripe" | "paypal" | "braintree";
+        CreateSubscriptionRequest: {
+            /** @description Organization ID */
+            org_id?: string;
+            /** @description Price ID from the payment processor */
+            plan_id?: string;
+            /** @description Coupon ID to apply */
+            coupon_id?: string;
+            /** @description Number of users in the organization */
+            user_count?: number;
+            /**
+             * Format: email
+             * @description Email of the customer
+             */
+            email?: string;
+            /**
+             * @description Supported payment processors
+             * @enum {string}
+             */
+            payment_processor?: "stripe" | "paypal" | "braintree";
+        };
+        UpgradeSubscriptionRequest: {
+            /**
+             * Format: uuid
+             * @description Old Plan id that is being changed
+             */
+            old_plan_id?: string;
+            /**
+             * Format: uuid
+             * @description New Plan id that is being changed to
+             */
+            new_plan_id?: string;
+        };
+        CreateSubscriptionResponse: {
+            subscription_id?: string;
+            clientSecret?: string;
+        };
+        UpdateUsersRequest: {
+            /**
+             * @description Supported payment processors
+             * @enum {string}
+             */
+            payment_processor?: "stripe" | "paypal" | "braintree";
+        };
+        CancelSubscriptionRequest: {
+            /** @description Subscription ID from the payment processor */
+            subscription_id?: string;
+            /**
+             * @description Supported payment processors
+             * @enum {string}
+             */
+            payment_processor?: "stripe" | "paypal" | "braintree";
+        };
+        /** @description Payload for webhook events from payment processors */
+        WebhookEvent: {
+            [key: string]: unknown;
+        };
+        SubscriptionPage: {
+            page: number;
+            page_size: number;
+            total_count: number;
+            subscriptions: {
+                /**
+                 * Format: uuid
+                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 */
+                ID: string;
+                /**
+                 * Format: uuid
+                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 */
+                org_id: string;
+                /**
+                 * Format: uuid
+                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 */
+                plan_id: string;
+                plan?: {
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    id: string;
+                    /**
+                     * @description Name of the plan
+                     * @enum {string}
+                     */
+                    name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                    /** @enum {string} */
+                    cadence: "monthly" | "yearly";
+                    /** @enum {string} */
+                    unit: "user" | "free";
+                    /** @description Minimum number of units required for the plan */
+                    minimum_units: number;
+                    /** @description Price per unit of the plan */
+                    price_per_unit: number;
+                    /** @enum {string} */
+                    currency: "usd";
+                } & {
+                    price_id: unknown;
+                };
+                quantity: number;
+                /** Format: date-time */
+                start_date?: string;
+                /** Format: date-time */
+                end_date?: string;
+                /**
+                 * @description Possible statuses of a Stripe subscription.
+                 * @enum {string}
+                 */
+                status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+                /** Format: date-time */
+                created_at?: string;
+                /** Format: date-time */
+                updated_at?: string;
+                /** Format: date-time */
+                deleted_at?: string;
+                /** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
+                billing_id: string;
+            }[];
+        };
+        Subscription: {
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            ID: string;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            org_id: string;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            plan_id: string;
+            plan?: {
+                /**
+                 * Format: uuid
+                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 */
+                id: string;
+                /**
+                 * @description Name of the plan
+                 * @enum {string}
+                 */
+                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                /** @enum {string} */
+                cadence: "monthly" | "yearly";
+                /** @enum {string} */
+                unit: "user" | "free";
+                /** @description Minimum number of units required for the plan */
+                minimum_units: number;
+                /** @description Price per unit of the plan */
+                price_per_unit: number;
+                /** @enum {string} */
+                currency: "usd";
+            } & {
+                price_id: unknown;
+            };
+            quantity: number;
+            /** Format: date-time */
+            start_date?: string;
+            /** Format: date-time */
+            end_date?: string;
+            /**
+             * @description Possible statuses of a Stripe subscription.
+             * @enum {string}
+             */
+            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+            /** Format: date-time */
+            deleted_at?: string;
+            /** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
+            billing_id: string;
+        };
+        /**
+         * @description Possible statuses of a Stripe subscription.
+         * @enum {string}
+         */
+        SubscriptionStatus: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+    };
+    responses: {
+        /** Invalid request body or request param */
+        400: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Expired JWT token used or insufficient privilege */
+        401: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Internal server error */
+        500: {
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description Subscription ID */
+        subscriptionId: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+        /** @description Get responses by pagesize (pass all to get all responses) */
+        pagesizeWithAll: string;
+        /** @description Get ordered responses */
+        order: string;
+    };
+}
+interface operations {
+    /** Returns all subscriptions for the organization */
+    getSubscriptions: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Filter subscriptions by status */
+                status?: string[];
+            };
+        };
+        responses: {
+            /** Get subscription response */
+            200: {
+                content: {
+                    "application/json": {
+                        page: number;
+                        page_size: number;
+                        total_count: number;
+                        subscriptions: {
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            ID: string;
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            org_id: string;
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            plan_id: string;
+                            plan?: {
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                id: string;
+                                /**
+                                 * @description Name of the plan
+                                 * @enum {string}
+                                 */
+                                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                                /** @enum {string} */
+                                cadence: "monthly" | "yearly";
+                                /** @enum {string} */
+                                unit: "user" | "free";
+                                /** @description Minimum number of units required for the plan */
+                                minimum_units: number;
+                                /** @description Price per unit of the plan */
+                                price_per_unit: number;
+                                /** @enum {string} */
+                                currency: "usd";
+                            } & {
+                                price_id: unknown;
+                            };
+                            quantity: number;
+                            /** Format: date-time */
+                            start_date?: string;
+                            /** Format: date-time */
+                            end_date?: string;
+                            /**
+                             * @description Possible statuses of a Stripe subscription.
+                             * @enum {string}
+                             */
+                            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
+                            /** Format: date-time */
+                            created_at?: string;
+                            /** Format: date-time */
+                            updated_at?: string;
+                            /** Format: date-time */
+                            deleted_at?: string;
+                            /** @description Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe */
+                            billing_id: string;
+                        }[];
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };