@meshery/schemas 1.2.15 → 1.2.16

package/dist/constructs/v1beta2/subscription/Subscription.d.ts

@@ -0,0 +1,785 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export 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"];
+  };
+}
+
+export interface components {
+  schemas: {
+    /**
+     * @description Supported payment processors
+     * @enum {string}
+     */
+    PaymentProcessor: "stripe" | "paypal" | "braintree";
+    CreateSubscriptionRequest: {
+      /**
+       * Format: uuid
+       * @description Organization ID
+       */
+      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 Supported payment processors
+       * @enum {string}
+       */
+      paymentProcessor?: "stripe" | "paypal" | "braintree";
+    };
+    UpgradeSubscriptionRequest: {
+      /**
+       * Format: uuid
+       * @description Old Plan id that is being changed
+       */
+      oldPlanId?: string;
+      /**
+       * Format: uuid
+       * @description New Plan id that is being changed to
+       */
+      newPlanId?: string;
+    };
+    CreateSubscriptionResponse: {
+      /** @description ID of the associated subscription. */
+      subscriptionId?: string;
+      /** @description Client secret returned by the payment processor for the subscription checkout flow. */
+      clientSecret?: string;
+    };
+    UpdateUsersRequest: {
+      /**
+       * @description Supported payment processors
+       * @enum {string}
+       */
+      paymentProcessor?: "stripe" | "paypal" | "braintree";
+    };
+    CancelSubscriptionRequest: {
+      /** @description Subscription ID from the payment processor */
+      subscriptionId?: string;
+      /**
+       * @description Supported payment processors
+       * @enum {string}
+       */
+      paymentProcessor?: "stripe" | "paypal" | "braintree";
+    };
+    /** @description Payload for webhook events from payment processors */
+    WebhookEvent: { [key: string]: unknown };
+    SubscriptionPage: {
+      /** @description Current page number of the result set. */
+      page: number;
+      /** @description Number of items per page. */
+      page_size: number;
+      /** @description Total number of items available. */
+      total_count: number;
+      /** @description Subscriptions returned in the current page of results. */
+      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;
+        /** @description Plan entity schema. */
+        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: "none" | "monthly" | "annually";
+          /** @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";
+        };
+        /** @description number of units subscribed (eg number of users) */
+        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 Subscription entity schema. */
+    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;
+      /** @description Plan entity schema. */
+      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: "none" | "monthly" | "annually";
+        /** @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";
+      };
+      /** @description number of units subscribed (eg number of users) */
+      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;
+      };
+    };
+    /** 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;
+  };
+}
+
+export 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": {
+            /** @description Current page number of the result set. */
+            page: number;
+            /** @description Number of items per page. */
+            page_size: number;
+            /** @description Total number of items available. */
+            total_count: number;
+            /** @description Subscriptions returned in the current page of results. */
+            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;
+              /** @description Plan entity schema. */
+              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: "none" | "monthly" | "annually";
+                /** @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";
+              };
+              /** @description number of units subscribed (eg number of users) */
+              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;
+        };
+      };
+    };
+  };
+  cancelSubscription: {
+    parameters: {
+      path: {
+        /** Subscription ID */
+        subscriptionId: string;
+      };
+    };
+    responses: {
+      200: {
+        content: {
+          "application/json": {
+            /** @description Current page number of the result set. */
+            page: number;
+            /** @description Number of items per page. */
+            page_size: number;
+            /** @description Total number of items available. */
+            total_count: number;
+            /** @description Subscriptions returned in the current page of results. */
+            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;
+              /** @description Plan entity schema. */
+              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: "none" | "monthly" | "annually";
+                /** @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";
+              };
+              /** @description number of units subscribed (eg number of users) */
+              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;
+        };
+      };
+      /** 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. */
+            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 Organization ID
+           */
+          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 Supported payment processors
+           * @enum {string}
+           */
+          paymentProcessor?: "stripe" | "paypal" | "braintree";
+        };
+      };
+    };
+  };
+  upgradeSubscription: {
+    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;
+            /** @description Plan entity schema. */
+            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: "none" | "monthly" | "annually";
+              /** @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";
+            };
+            /** @description number of units subscribed (eg number of users) */
+            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;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          /**
+           * Format: uuid
+           * @description Old Plan id that is being changed
+           */
+          oldPlanId?: string;
+          /**
+           * Format: uuid
+           * @description New Plan id that is being changed to
+           */
+          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 Old Plan id that is being changed
+           */
+          oldPlanId?: string;
+          /**
+           * Format: uuid
+           * @description New Plan id that is being changed to
+           */
+          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 };
+      };
+    };
+  };
+}
+
+export interface external {}