@meshery/schemas 1.2.11 → 1.2.13

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

@@ -1,876 +0,0 @@
-/**
- * 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: operations["cancelSubscription"];
-    };
-    "/api/entitlement/subscriptions/create": {
-        post: operations["createSubscription"];
-    };
-    "/api/entitlement/subscriptions/{subscriptionId}/upgrade": {
-        post: operations["upgradeSubscription"];
-    };
-    "/api/entitlement/subscriptions/{subscriptionId}/upgrade-preview": {
-        post: operations["previewSubscriptionUpgrade"];
-    };
-    "/api/entitlement/subscriptions/webhooks": {
-        post: operations["handleSubscriptionWebhook"];
-    };
-}
-interface components {
-    schemas: {
-        /**
-         * @description Payment processor used to charge the subscription.
-         * @enum {string}
-         */
-        PaymentProcessor: "stripe" | "paypal" | "braintree";
-        /** @description Payload for creating a new subscription through a payment processor. */
-        CreateSubscriptionRequest: {
-            /**
-             * Format: uuid
-             * @description ID of the organization subscribing.
-             */
-            orgId?: string;
-            /** @description Price ID from the payment processor. */
-            planId?: string;
-            /** @description Coupon ID to apply. */
-            couponId?: string;
-            /** @description Number of users in the organization. */
-            userCount?: number;
-            /**
-             * Format: email
-             * @description Email of the customer.
-             */
-            email?: string;
-            /**
-             * @description Payment processor used to complete the subscription checkout.
-             * @enum {string}
-             */
-            paymentProcessor?: "stripe" | "paypal" | "braintree";
-        };
-        /** @description Payload for upgrading or downgrading a subscription by changing one of its plans. */
-        UpgradeSubscriptionRequest: {
-            /**
-             * Format: uuid
-             * @description Plan ID that is being replaced.
-             */
-            oldPlanId?: string;
-            /**
-             * Format: uuid
-             * @description Plan ID that replaces the old plan.
-             */
-            newPlanId?: string;
-        };
-        /** @description Response body returned after a subscription is created. */
-        CreateSubscriptionResponse: {
-            /** @description ID of the associated subscription in the payment processor. */
-            subscriptionId?: string;
-            /** @description Client secret returned by the payment processor for the subscription checkout flow. */
-            clientSecret?: string;
-        };
-        /** @description Payload for synchronizing the current user count with the payment processor. */
-        UpdateUsersRequest: {
-            /**
-             * @description Payment processor currently billing the subscription.
-             * @enum {string}
-             */
-            paymentProcessor?: "stripe" | "paypal" | "braintree";
-        };
-        /** @description Payload for cancelling a subscription in an external processor. */
-        CancelSubscriptionRequest: {
-            /** @description Subscription ID from the payment processor. */
-            subscriptionId?: string;
-            /**
-             * @description Payment processor currently billing the subscription.
-             * @enum {string}
-             */
-            paymentProcessor?: "stripe" | "paypal" | "braintree";
-        };
-        /** @description Payload for webhook events from payment processors. */
-        WebhookEvent: {
-            [key: string]: unknown;
-        };
-        /** @description Paginated list of subscriptions. */
-        SubscriptionPage: {
-            /** @description Current page number of the result set. */
-            page: number;
-            /** @description Number of items per page. */
-            pageSize: number;
-            /** @description Total number of items available. */
-            totalCount: number;
-            /** @description Subscriptions returned on the current page. */
-            subscriptions: {
-                /**
-                 * Format: uuid
-                 * @description Unique identifier for the subscription.
-                 */
-                id: string;
-                /**
-                 * Format: uuid
-                 * @description ID of the organization that owns this subscription.
-                 */
-                orgId: string;
-                /**
-                 * Format: uuid
-                 * @description ID of the plan this subscription is for.
-                 */
-                planId: string;
-                /** @description Eager-loaded plan associated with this subscription. */
-                plan?: {
-                    /**
-                     * Format: uuid
-                     * @description Unique identifier for the plan.
-                     */
-                    id: string;
-                    /**
-                     * @description Display name of the plan.
-                     * @enum {string}
-                     */
-                    name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                    /**
-                     * @description Billing cadence for the plan (monthly, annually, or none).
-                     * @enum {string}
-                     */
-                    cadence: "none" | "monthly" | "annually";
-                    /**
-                     * @description Unit of consumption this plan charges against (e.g. user).
-                     * @enum {string}
-                     */
-                    unit: "user" | "free";
-                    /** @description Minimum number of units required for the plan. */
-                    minimumUnits: number;
-                    /** @description Price per unit of the plan. */
-                    pricePerUnit: number;
-                    /**
-                     * @description Currency in which the plan is priced.
-                     * @enum {string}
-                     */
-                    currency: "usd";
-                };
-                /** @description Number of units subscribed (eg number of users). */
-                quantity: number;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the subscription period started.
-                 */
-                startDate?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the current subscription period ends.
-                 */
-                endDate?: string;
-                /**
-                 * @description Current status of the subscription (e.g. active, past_due, canceled).
-                 * @enum {string}
-                 */
-                status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the subscription was created.
-                 */
-                createdAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the subscription was last updated.
-                 */
-                updatedAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the subscription was soft-deleted, if applicable.
-                 */
-                deletedAt?: string;
-                /** @description Billing ID of the subscription. The ID of the subscription in the external billing system (for example, Stripe). */
-                billingId: string;
-            }[];
-        };
-        /** @description Subscription entity schema. */
-        Subscription: {
-            /**
-             * Format: uuid
-             * @description Unique identifier for the subscription.
-             */
-            id: string;
-            /**
-             * Format: uuid
-             * @description ID of the organization that owns this subscription.
-             */
-            orgId: string;
-            /**
-             * Format: uuid
-             * @description ID of the plan this subscription is for.
-             */
-            planId: string;
-            /** @description Eager-loaded plan associated with this subscription. */
-            plan?: {
-                /**
-                 * Format: uuid
-                 * @description Unique identifier for the plan.
-                 */
-                id: string;
-                /**
-                 * @description Display name of the plan.
-                 * @enum {string}
-                 */
-                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                /**
-                 * @description Billing cadence for the plan (monthly, annually, or none).
-                 * @enum {string}
-                 */
-                cadence: "none" | "monthly" | "annually";
-                /**
-                 * @description Unit of consumption this plan charges against (e.g. user).
-                 * @enum {string}
-                 */
-                unit: "user" | "free";
-                /** @description Minimum number of units required for the plan. */
-                minimumUnits: number;
-                /** @description Price per unit of the plan. */
-                pricePerUnit: number;
-                /**
-                 * @description Currency in which the plan is priced.
-                 * @enum {string}
-                 */
-                currency: "usd";
-            };
-            /** @description Number of units subscribed (eg number of users). */
-            quantity: number;
-            /**
-             * Format: date-time
-             * @description Timestamp when the subscription period started.
-             */
-            startDate?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the current subscription period ends.
-             */
-            endDate?: string;
-            /**
-             * @description Current status of the subscription (e.g. active, past_due, canceled).
-             * @enum {string}
-             */
-            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
-            /**
-             * Format: date-time
-             * @description Timestamp when the subscription was created.
-             */
-            createdAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the subscription was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the subscription was soft-deleted, if applicable.
-             */
-            deletedAt?: string;
-            /** @description Billing ID of the subscription. The ID of the subscription in the external billing system (for example, Stripe). */
-            billingId: 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;
-            };
-        };
-        /** Result not found */
-        404: {
-            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: {
-            /** Subscriptions response */
-            200: {
-                content: {
-                    "application/json": {
-                        /** @description Current page number of the result set. */
-                        page: number;
-                        /** @description Number of items per page. */
-                        pageSize: number;
-                        /** @description Total number of items available. */
-                        totalCount: number;
-                        /** @description Subscriptions returned on the current page. */
-                        subscriptions: {
-                            /**
-                             * Format: uuid
-                             * @description Unique identifier for the subscription.
-                             */
-                            id: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the organization that owns this subscription.
-                             */
-                            orgId: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the plan this subscription is for.
-                             */
-                            planId: string;
-                            /** @description Eager-loaded plan associated with this subscription. */
-                            plan?: {
-                                /**
-                                 * Format: uuid
-                                 * @description Unique identifier for the plan.
-                                 */
-                                id: string;
-                                /**
-                                 * @description Display name of the plan.
-                                 * @enum {string}
-                                 */
-                                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                                /**
-                                 * @description Billing cadence for the plan (monthly, annually, or none).
-                                 * @enum {string}
-                                 */
-                                cadence: "none" | "monthly" | "annually";
-                                /**
-                                 * @description Unit of consumption this plan charges against (e.g. user).
-                                 * @enum {string}
-                                 */
-                                unit: "user" | "free";
-                                /** @description Minimum number of units required for the plan. */
-                                minimumUnits: number;
-                                /** @description Price per unit of the plan. */
-                                pricePerUnit: number;
-                                /**
-                                 * @description Currency in which the plan is priced.
-                                 * @enum {string}
-                                 */
-                                currency: "usd";
-                            };
-                            /** @description Number of units subscribed (eg number of users). */
-                            quantity: number;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription period started.
-                             */
-                            startDate?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the current subscription period ends.
-                             */
-                            endDate?: string;
-                            /**
-                             * @description Current status of the subscription (e.g. active, past_due, canceled).
-                             * @enum {string}
-                             */
-                            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was created.
-                             */
-                            createdAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was soft-deleted, if applicable.
-                             */
-                            deletedAt?: string;
-                            /** @description Billing ID of the subscription. The ID of the subscription in the external billing system (for example, Stripe). */
-                            billingId: 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;
-                };
-            };
-        };
-    };
-    cancelSubscription: {
-        parameters: {
-            path: {
-                /** Subscription ID */
-                subscriptionId: string;
-            };
-        };
-        responses: {
-            /** Subscription cancellation scheduled */
-            200: {
-                content: {
-                    "application/json": {
-                        /** @description Current page number of the result set. */
-                        page: number;
-                        /** @description Number of items per page. */
-                        pageSize: number;
-                        /** @description Total number of items available. */
-                        totalCount: number;
-                        /** @description Subscriptions returned on the current page. */
-                        subscriptions: {
-                            /**
-                             * Format: uuid
-                             * @description Unique identifier for the subscription.
-                             */
-                            id: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the organization that owns this subscription.
-                             */
-                            orgId: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the plan this subscription is for.
-                             */
-                            planId: string;
-                            /** @description Eager-loaded plan associated with this subscription. */
-                            plan?: {
-                                /**
-                                 * Format: uuid
-                                 * @description Unique identifier for the plan.
-                                 */
-                                id: string;
-                                /**
-                                 * @description Display name of the plan.
-                                 * @enum {string}
-                                 */
-                                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                                /**
-                                 * @description Billing cadence for the plan (monthly, annually, or none).
-                                 * @enum {string}
-                                 */
-                                cadence: "none" | "monthly" | "annually";
-                                /**
-                                 * @description Unit of consumption this plan charges against (e.g. user).
-                                 * @enum {string}
-                                 */
-                                unit: "user" | "free";
-                                /** @description Minimum number of units required for the plan. */
-                                minimumUnits: number;
-                                /** @description Price per unit of the plan. */
-                                pricePerUnit: number;
-                                /**
-                                 * @description Currency in which the plan is priced.
-                                 * @enum {string}
-                                 */
-                                currency: "usd";
-                            };
-                            /** @description Number of units subscribed (eg number of users). */
-                            quantity: number;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription period started.
-                             */
-                            startDate?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the current subscription period ends.
-                             */
-                            endDate?: string;
-                            /**
-                             * @description Current status of the subscription (e.g. active, past_due, canceled).
-                             * @enum {string}
-                             */
-                            status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was created.
-                             */
-                            createdAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the subscription was soft-deleted, if applicable.
-                             */
-                            deletedAt?: string;
-                            /** @description Billing ID of the subscription. The ID of the subscription in the external billing system (for example, Stripe). */
-                            billingId: string;
-                        }[];
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-    };
-    createSubscription: {
-        responses: {
-            /** A new subscription has been created */
-            201: {
-                content: {
-                    "application/json": {
-                        /** @description ID of the associated subscription in the payment processor. */
-                        subscriptionId?: string;
-                        /** @description Client secret returned by the payment processor for the subscription checkout flow. */
-                        clientSecret?: 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;
-                };
-            };
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uuid
-                     * @description ID of the organization subscribing.
-                     */
-                    orgId?: string;
-                    /** @description Price ID from the payment processor. */
-                    planId?: string;
-                    /** @description Coupon ID to apply. */
-                    couponId?: string;
-                    /** @description Number of users in the organization. */
-                    userCount?: number;
-                    /**
-                     * Format: email
-                     * @description Email of the customer.
-                     */
-                    email?: string;
-                    /**
-                     * @description Payment processor used to complete the subscription checkout.
-                     * @enum {string}
-                     */
-                    paymentProcessor?: "stripe" | "paypal" | "braintree";
-                };
-            };
-        };
-    };
-    upgradeSubscription: {
-        parameters: {
-            path: {
-                /** Subscription ID */
-                subscriptionId: string;
-            };
-        };
-        responses: {
-            /** Subscription upgraded */
-            200: {
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description Unique identifier for the subscription.
-                         */
-                        id: string;
-                        /**
-                         * Format: uuid
-                         * @description ID of the organization that owns this subscription.
-                         */
-                        orgId: string;
-                        /**
-                         * Format: uuid
-                         * @description ID of the plan this subscription is for.
-                         */
-                        planId: string;
-                        /** @description Eager-loaded plan associated with this subscription. */
-                        plan?: {
-                            /**
-                             * Format: uuid
-                             * @description Unique identifier for the plan.
-                             */
-                            id: string;
-                            /**
-                             * @description Display name of the plan.
-                             * @enum {string}
-                             */
-                            name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                            /**
-                             * @description Billing cadence for the plan (monthly, annually, or none).
-                             * @enum {string}
-                             */
-                            cadence: "none" | "monthly" | "annually";
-                            /**
-                             * @description Unit of consumption this plan charges against (e.g. user).
-                             * @enum {string}
-                             */
-                            unit: "user" | "free";
-                            /** @description Minimum number of units required for the plan. */
-                            minimumUnits: number;
-                            /** @description Price per unit of the plan. */
-                            pricePerUnit: number;
-                            /**
-                             * @description Currency in which the plan is priced.
-                             * @enum {string}
-                             */
-                            currency: "usd";
-                        };
-                        /** @description Number of units subscribed (eg number of users). */
-                        quantity: number;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the subscription period started.
-                         */
-                        startDate?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the current subscription period ends.
-                         */
-                        endDate?: string;
-                        /**
-                         * @description Current status of the subscription (e.g. active, past_due, canceled).
-                         * @enum {string}
-                         */
-                        status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid";
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the subscription was created.
-                         */
-                        createdAt?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the subscription was last updated.
-                         */
-                        updatedAt?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the subscription was soft-deleted, if applicable.
-                         */
-                        deletedAt?: string;
-                        /** @description Billing ID of the subscription. The ID of the subscription in the external billing system (for example, Stripe). */
-                        billingId: string;
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uuid
-                     * @description Plan ID that is being replaced.
-                     */
-                    oldPlanId?: string;
-                    /**
-                     * Format: uuid
-                     * @description Plan ID that replaces the old plan.
-                     */
-                    newPlanId?: string;
-                };
-            };
-        };
-    };
-    previewSubscriptionUpgrade: {
-        parameters: {
-            path: {
-                /** Subscription ID */
-                subscriptionId: string;
-            };
-        };
-        responses: {
-            /** Preview of the upgraded subscription invoice */
-            200: {
-                content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uuid
-                     * @description Plan ID that is being replaced.
-                     */
-                    oldPlanId?: string;
-                    /**
-                     * Format: uuid
-                     * @description Plan ID that replaces the old plan.
-                     */
-                    newPlanId?: string;
-                };
-            };
-        };
-    };
-    handleSubscriptionWebhook: {
-        responses: {
-            /** Webhook processed */
-            200: unknown;
-            /** 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;
-                };
-            };
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    [key: string]: unknown;
-                };
-            };
-        };
-    };
-}
-interface external {
-}
-
-export type { components, external, operations, paths };