@enbbox/api 1.0.0

package/dist/esm/api/billing-api.d.ts

@@ -0,0 +1,337 @@
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CheckoutSession } from '../models';
+import type { CreateCheckout } from '../models';
+import type { Entitlements } from '../models';
+import type { PlanLimitsResponse } from '../models';
+import type { PortalUrl } from '../models';
+import type { Prices } from '../models';
+import type { Subscription } from '../models';
+import type { Usage } from '../models';
+/**
+ * BillingApi - axios parameter creator
+ */
+export declare const BillingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a Stripe Checkout Session for upgrading a plan.
+     * @param {CreateCheckout} createCheckout
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCheckoutSession: (createCheckout: CreateCheckout, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get plan limits and current usage for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingLimits: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get the current subscription for the authed project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get active entitlements for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEntitlements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a Stripe Customer Portal URL for managing the subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortalUrl: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get available plan prices.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPrices: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get current usage data for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsage: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+     * @summary Handle Stripe webhook events.
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stripeWebhook: (body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BillingApi - functional programming interface
+ */
+export declare const BillingApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a Stripe Checkout Session for upgrading a plan.
+     * @param {CreateCheckout} createCheckout
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCheckoutSession(createCheckout: CreateCheckout, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckoutSession>>;
+    /**
+     *
+     * @summary Get plan limits and current usage for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingLimits(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanLimitsResponse>>;
+    /**
+     *
+     * @summary Get the current subscription for the authed project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Subscription>>;
+    /**
+     *
+     * @summary Get active entitlements for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEntitlements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entitlements>>;
+    /**
+     *
+     * @summary Get a Stripe Customer Portal URL for managing the subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortalUrl(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortalUrl>>;
+    /**
+     *
+     * @summary Get available plan prices.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPrices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Prices>>;
+    /**
+     *
+     * @summary Get current usage data for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Usage>>;
+    /**
+     * This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+     * @summary Handle Stripe webhook events.
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stripeWebhook(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * BillingApi - factory interface
+ */
+export declare const BillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create a Stripe Checkout Session for upgrading a plan.
+     * @param {CreateCheckout} createCheckout
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCheckoutSession(createCheckout: CreateCheckout, options?: RawAxiosRequestConfig): AxiosPromise<CheckoutSession>;
+    /**
+     *
+     * @summary Get plan limits and current usage for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingLimits(options?: RawAxiosRequestConfig): AxiosPromise<PlanLimitsResponse>;
+    /**
+     *
+     * @summary Get the current subscription for the authed project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(options?: RawAxiosRequestConfig): AxiosPromise<Subscription>;
+    /**
+     *
+     * @summary Get active entitlements for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Entitlements>;
+    /**
+     *
+     * @summary Get a Stripe Customer Portal URL for managing the subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortalUrl(options?: RawAxiosRequestConfig): AxiosPromise<PortalUrl>;
+    /**
+     *
+     * @summary Get available plan prices.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPrices(options?: RawAxiosRequestConfig): AxiosPromise<Prices>;
+    /**
+     *
+     * @summary Get current usage data for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsage(options?: RawAxiosRequestConfig): AxiosPromise<Usage>;
+    /**
+     * This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+     * @summary Handle Stripe webhook events.
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stripeWebhook(body: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * BillingApi - interface
+ */
+export interface BillingApiInterface {
+    /**
+     *
+     * @summary Create a Stripe Checkout Session for upgrading a plan.
+     * @param {CreateCheckout} createCheckout
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCheckoutSession(createCheckout: CreateCheckout, options?: RawAxiosRequestConfig): AxiosPromise<CheckoutSession>;
+    /**
+     *
+     * @summary Get plan limits and current usage for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingLimits(options?: RawAxiosRequestConfig): AxiosPromise<PlanLimitsResponse>;
+    /**
+     *
+     * @summary Get the current subscription for the authed project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(options?: RawAxiosRequestConfig): AxiosPromise<Subscription>;
+    /**
+     *
+     * @summary Get active entitlements for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Entitlements>;
+    /**
+     *
+     * @summary Get a Stripe Customer Portal URL for managing the subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortalUrl(options?: RawAxiosRequestConfig): AxiosPromise<PortalUrl>;
+    /**
+     *
+     * @summary Get available plan prices.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPrices(options?: RawAxiosRequestConfig): AxiosPromise<Prices>;
+    /**
+     *
+     * @summary Get current usage data for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsage(options?: RawAxiosRequestConfig): AxiosPromise<Usage>;
+    /**
+     * This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+     * @summary Handle Stripe webhook events.
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stripeWebhook(body: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+}
+/**
+ * BillingApi - object-oriented interface
+ */
+export declare class BillingApi extends BaseAPI implements BillingApiInterface {
+    /**
+     *
+     * @summary Create a Stripe Checkout Session for upgrading a plan.
+     * @param {CreateCheckout} createCheckout
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCheckoutSession(createCheckout: CreateCheckout, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutSession, any, {}>>;
+    /**
+     *
+     * @summary Get plan limits and current usage for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingLimits(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanLimitsResponse, any, {}>>;
+    /**
+     *
+     * @summary Get the current subscription for the authed project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Subscription, any, {}>>;
+    /**
+     *
+     * @summary Get active entitlements for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEntitlements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlements, any, {}>>;
+    /**
+     *
+     * @summary Get a Stripe Customer Portal URL for managing the subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortalUrl(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortalUrl, any, {}>>;
+    /**
+     *
+     * @summary Get available plan prices.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPrices(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Prices, any, {}>>;
+    /**
+     *
+     * @summary Get current usage data for the project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUsage(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Usage, any, {}>>;
+    /**
+     * This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+     * @summary Handle Stripe webhook events.
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stripeWebhook(body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}