@botpress/client 1.32.0 → 1.33.0

package/dist/index.d.ts

@@ -15113,24 +15113,22 @@ interface GetPlanRequestParams {
 interface GetPlanRequestBody {
 }
 type GetPlanInput = GetPlanRequestBody & GetPlanRequestHeaders & GetPlanRequestQuery & GetPlanRequestParams;
-interface GetPlanResponse {
+interface GetPlanResponse$1 {
     id: string;
     name: string;
     description: string;
-    providerProductId: string;
     prices: {
-        [k: string]: {
-            providerPriceId: string;
+        month?: {
             amount: number;
-            currency: "usd";
-            interval: "month" | "year";
-            metadata?: {
-                [k: string]: string;
-            };
+            currency: string;
+        };
+        year?: {
+            amount: number;
+            currency: string;
         };
     };
     features: {
-        [k: string]: any;
+        [k: string]: number;
     };
     metadata?: {
         [k: string]: string;
@@ -15146,29 +15144,28 @@ interface ListPlansRequestParams {
 interface ListPlansRequestBody {
 }
 type ListPlansInput = ListPlansRequestBody & ListPlansRequestHeaders & ListPlansRequestQuery & ListPlansRequestParams;
-type ListPlansResponse = {
+type ListPlansResponse = GetPlanResponse[];
+interface GetPlanResponse {
     id: string;
     name: string;
     description: string;
-    providerProductId: string;
     prices: {
-        [k: string]: {
-            providerPriceId: string;
+        month?: {
             amount: number;
-            currency: "usd";
-            interval: "month" | "year";
-            metadata?: {
-                [k: string]: string;
-            };
+            currency: string;
+        };
+        year?: {
+            amount: number;
+            currency: string;
         };
     };
     features: {
-        [k: string]: any | null;
+        [k: string]: number;
     };
     metadata?: {
         [k: string]: string;
     };
-}[];
+}
 
 interface GetAddonRequestHeaders {
 }
@@ -15180,22 +15177,11 @@ interface GetAddonRequestParams {
 interface GetAddonRequestBody {
 }
 type GetAddonInput = GetAddonRequestBody & GetAddonRequestHeaders & GetAddonRequestQuery & GetAddonRequestParams;
-interface GetAddonResponse {
+interface GetAddonResponse$1 {
     id: string;
     name: string;
     description: string;
-    providerProductId: string;
-    prices: {
-        [k: string]: {
-            providerPriceId: string;
-            amount: number;
-            currency: "usd";
-            interval: "month" | "year";
-            metadata?: {
-                [k: string]: string;
-            };
-        };
-    };
+    price: number;
     feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
     increment: number;
     metadata?: {
@@ -15212,28 +15198,307 @@ interface ListAddonsRequestParams {
 interface ListAddonsRequestBody {
 }
 type ListAddonsInput = ListAddonsRequestBody & ListAddonsRequestHeaders & ListAddonsRequestQuery & ListAddonsRequestParams;
-type ListAddonsResponse = {
+type ListAddonsResponse = GetAddonResponse[];
+interface GetAddonResponse {
     id: string;
     name: string;
     description: string;
-    providerProductId: string;
-    prices: {
+    price: number;
+    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
+    increment: number;
+    metadata?: {
+        [k: string]: string;
+    };
+}
+
+interface GetCurrentSubscriptionRequestHeaders {
+}
+interface GetCurrentSubscriptionRequestQuery {
+}
+interface GetCurrentSubscriptionRequestParams {
+}
+interface GetCurrentSubscriptionRequestBody {
+}
+type GetCurrentSubscriptionInput = GetCurrentSubscriptionRequestBody & GetCurrentSubscriptionRequestHeaders & GetCurrentSubscriptionRequestQuery & GetCurrentSubscriptionRequestParams;
+interface GetCurrentSubscriptionResponse {
+    plan: {
+        current: {
+            status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
+            planId: string;
+            interval: "month" | "year";
+            price: number;
+            proratedPrice?: number;
+            cancelAtPeriodEnd: boolean;
+            periodEnd: string;
+        };
+        next: {
+            planId: string;
+            interval: "month" | "year";
+            price: number | null;
+            effectiveDate: string;
+        } | null;
+    };
+    addons: {
         [k: string]: {
-            providerPriceId: string;
-            amount: number;
-            currency: "usd";
+            current: {
+                quantity: number;
+                price: number;
+                proratedPrice?: number;
+            };
+            next: {
+                quantity: number;
+                price: number;
+                effectiveDate: string;
+            } | null;
+        };
+    };
+    yearlyTotal: number;
+    monthlyTotal: number;
+    proratedTotal: number;
+}
+
+interface GetNextSubscriptionRequestHeaders {
+}
+interface GetNextSubscriptionRequestQuery {
+}
+interface GetNextSubscriptionRequestParams {
+}
+interface GetNextSubscriptionRequestBody {
+}
+type GetNextSubscriptionInput = GetNextSubscriptionRequestBody & GetNextSubscriptionRequestHeaders & GetNextSubscriptionRequestQuery & GetNextSubscriptionRequestParams;
+interface GetNextSubscriptionResponse {
+    plan: {
+        current: {
+            status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
+            planId: string;
             interval: "month" | "year";
-            metadata?: {
-                [k: string]: string;
+            price: number;
+            proratedPrice?: number;
+            cancelAtPeriodEnd: boolean;
+            periodEnd: string;
+        };
+        next: {
+            planId: string;
+            interval: "month" | "year";
+            price: number | null;
+            effectiveDate: string;
+        } | null;
+    };
+    addons: {
+        [k: string]: {
+            current: {
+                quantity: number;
+                price: number;
+                proratedPrice?: number;
+            };
+            next: {
+                quantity: number;
+                price: number;
+                effectiveDate: string;
+            } | null;
+        };
+    };
+    yearlyTotal: number;
+    monthlyTotal: number;
+    proratedTotal: number;
+}
+
+interface PreviewSubscriptionUpdateRequestHeaders {
+}
+interface PreviewSubscriptionUpdateRequestQuery {
+}
+interface PreviewSubscriptionUpdateRequestParams {
+}
+interface PreviewSubscriptionUpdateRequestBody {
+    plan: {
+        /**
+         * New plan ID (optional)
+         */
+        planId: string;
+        /**
+         * New billing interval (optional)
+         */
+        interval: "month" | "year";
+    };
+    /**
+     * Map of addon IDs to quantities (optional). Set quantity to 0 to remove addon.
+     */
+    addons?: {
+        [k: string]: number;
+    };
+}
+type PreviewSubscriptionUpdateInput = PreviewSubscriptionUpdateRequestBody & PreviewSubscriptionUpdateRequestHeaders & PreviewSubscriptionUpdateRequestQuery & PreviewSubscriptionUpdateRequestParams;
+/**
+ * Preview of subscription update costs
+ */
+interface PreviewSubscriptionUpdateResponse {
+    subscription: {
+        plan: {
+            planId: string;
+            interval: "month" | "year";
+            effectiveDate: string;
+        };
+        addons: {
+            [k: string]: {
+                quantity: number;
+                effectiveDate: string;
             };
         };
     };
-    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
-    increment: number;
-    metadata?: {
-        [k: string]: string;
+    changeType: "upgrade" | "downgrade" | "same";
+    costs: {
+        /**
+         * Prorated charges due immediately (0 for downgrades)
+         */
+        immediate: {
+            total: number;
+            lineItems: {
+                type: "plan" | "addon" | "proration_credit";
+                id: string;
+                description: string;
+                amount: number;
+                quantity?: number;
+            }[];
+        };
+        /**
+         * Monthly recurring cost (addons, or plan if monthly interval)
+         */
+        monthly: {
+            total: number;
+            lineItems: {
+                type: "plan" | "addon" | "proration_credit";
+                id: string;
+                description: string;
+                amount: number;
+                quantity?: number;
+            }[];
+        };
+        /**
+         * Yearly recurring cost (plan if yearly interval)
+         */
+        yearly: {
+            total: number;
+            lineItems: {
+                type: "plan" | "addon" | "proration_credit";
+                id: string;
+                description: string;
+                amount: number;
+                quantity?: number;
+            }[];
+        };
+    };
+    currentPeriodEnd: string;
+}
+
+interface SetPlanRequestHeaders {
+}
+interface SetPlanRequestQuery {
+}
+interface SetPlanRequestParams {
+}
+/**
+ * Plan update parameters
+ */
+interface SetPlanRequestBody {
+    planId: string;
+    interval: "month" | "year";
+    testReferenceTime?: number;
+}
+type SetPlanInput = SetPlanRequestBody & SetPlanRequestHeaders & SetPlanRequestQuery & SetPlanRequestParams;
+/**
+ * Subscription details including current plan, addons, and costs
+ */
+interface SetPlanResponse {
+    plan: {
+        current: {
+            status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
+            planId: string;
+            interval: "month" | "year";
+            price: number;
+            proratedPrice?: number;
+            cancelAtPeriodEnd: boolean;
+            periodEnd: string;
+        };
+        next: {
+            planId: string;
+            interval: "month" | "year";
+            price: number | null;
+            effectiveDate: string;
+        } | null;
+    };
+    addons: {
+        [k: string]: {
+            current: {
+                quantity: number;
+                price: number;
+                proratedPrice?: number;
+            };
+            next: {
+                quantity: number;
+                price: number;
+                effectiveDate: string;
+            } | null;
+        };
     };
-}[];
+    yearlyTotal: number;
+    monthlyTotal: number;
+    proratedTotal: number;
+}
+
+interface SetAddonsRequestHeaders {
+}
+interface SetAddonsRequestQuery {
+}
+interface SetAddonsRequestParams {
+}
+/**
+ * Addons update parameters. Set quantity to 0 to remove an addon.
+ */
+interface SetAddonsRequestBody {
+    addons: {
+        [k: string]: number;
+    };
+}
+type SetAddonsInput = SetAddonsRequestBody & SetAddonsRequestHeaders & SetAddonsRequestQuery & SetAddonsRequestParams;
+/**
+ * Subscription details including current plan, addons, and costs
+ */
+interface SetAddonsResponse {
+    plan: {
+        current: {
+            status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
+            planId: string;
+            interval: "month" | "year";
+            price: number;
+            proratedPrice?: number;
+            cancelAtPeriodEnd: boolean;
+            periodEnd: string;
+        };
+        next: {
+            planId: string;
+            interval: "month" | "year";
+            price: number | null;
+            effectiveDate: string;
+        } | null;
+    };
+    addons: {
+        [k: string]: {
+            current: {
+                quantity: number;
+                price: number;
+                proratedPrice?: number;
+            };
+            next: {
+                quantity: number;
+                price: number;
+                effectiveDate: string;
+            } | null;
+        };
+    };
+    yearlyTotal: number;
+    monthlyTotal: number;
+    proratedTotal: number;
+}
 
 interface ListInvoicesRequestHeaders {
 }
@@ -15245,9 +15510,6 @@ interface ListInvoicesRequestParams {
 interface ListInvoicesRequestBody {
 }
 type ListInvoicesInput = ListInvoicesRequestBody & ListInvoicesRequestHeaders & ListInvoicesRequestQuery & ListInvoicesRequestParams;
-/**
- * List of invoices with pagination.
- */
 interface ListInvoicesResponse {
     invoices: {
         id: string;
@@ -15350,6 +15612,19 @@ interface CreatePaymentMethodIntentResponse {
     clientSecret: string;
 }
 
+interface GetQuotasRequestHeaders {
+}
+interface GetQuotasRequestQuery {
+}
+interface GetQuotasRequestParams {
+}
+interface GetQuotasRequestBody {
+}
+type GetQuotasInput = GetQuotasRequestBody & GetQuotasRequestHeaders & GetQuotasRequestQuery & GetQuotasRequestParams;
+interface GetQuotasResponse {
+    [k: string]: number;
+}
+
 type ClientProps$7 = {
     toAxiosRequest: typeof toAxiosRequest$3;
     toApiError: typeof toApiError$3;
@@ -15359,15 +15634,21 @@ declare class Client$7 {
     private props;
     constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps$7>);
     readonly getBillingReadonly: (input: GetBillingReadonlyInput) => Promise<GetBillingReadonlyResponse>;
-    readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse>;
+    readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse$1>;
     readonly listPlans: (input: ListPlansInput) => Promise<ListPlansResponse>;
-    readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse>;
+    readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse$1>;
     readonly listAddons: (input: ListAddonsInput) => Promise<ListAddonsResponse>;
+    readonly getCurrentSubscription: (input: GetCurrentSubscriptionInput) => Promise<GetCurrentSubscriptionResponse>;
+    readonly getNextSubscription: (input: GetNextSubscriptionInput) => Promise<GetNextSubscriptionResponse>;
+    readonly previewSubscriptionUpdate: (input: PreviewSubscriptionUpdateInput) => Promise<PreviewSubscriptionUpdateResponse>;
+    readonly setPlan: (input: SetPlanInput) => Promise<SetPlanResponse>;
+    readonly setAddons: (input: SetAddonsInput) => Promise<SetAddonsResponse>;
     readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
     readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
     readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
     readonly setPaymentMethod: (input: SetPaymentMethodInput) => Promise<SetPaymentMethodResponse>;
     readonly createPaymentMethodIntent: (input: CreatePaymentMethodIntentInput) => Promise<CreatePaymentMethodIntentResponse>;
+    readonly getQuotas: (input: GetQuotasInput) => Promise<GetQuotasResponse>;
 }
 declare function toApiError$3(err: unknown): Error;