@botpress/client 2.4.0 → 2.6.0

package/dist/index.d.ts

@@ -8592,6 +8592,27 @@ interface ChargeWorkspaceUnpaidInvoicesResponse$1 {
     }[];
 }
 
+interface SaveWorkspaceCancellationReasonsRequestHeaders$1 {
+}
+interface SaveWorkspaceCancellationReasonsRequestQuery$1 {
+}
+interface SaveWorkspaceCancellationReasonsRequestParams$1 {
+    id: string;
+}
+interface SaveWorkspaceCancellationReasonsRequestBody$1 {
+    /**
+     * Reasons for canceling the subscription
+     */
+    reasons: ("too_expensive" | "not_using_enough" | "missing_feature" | "switched_tool" | "technical_issues" | "support_expectations" | "temporary_need")[];
+    /**
+     * Additional comment on the cancellation
+     */
+    comment?: string;
+}
+type SaveWorkspaceCancellationReasonsInput$1 = SaveWorkspaceCancellationReasonsRequestBody$1 & SaveWorkspaceCancellationReasonsRequestHeaders$1 & SaveWorkspaceCancellationReasonsRequestQuery$1 & SaveWorkspaceCancellationReasonsRequestParams$1;
+interface SaveWorkspaceCancellationReasonsResponse$1 {
+}
+
 interface CreateWorkspaceRequestHeaders$1 {
 }
 interface CreateWorkspaceRequestQuery$1 {
@@ -8600,7 +8621,7 @@ interface CreateWorkspaceRequestParams$1 {
 }
 interface CreateWorkspaceRequestBody$1 {
     name: string;
-    billingVersion?: "v4";
+    billingVersion?: "v4" | "v5";
 }
 type CreateWorkspaceInput$1 = CreateWorkspaceRequestBody$1 & CreateWorkspaceRequestHeaders$1 & CreateWorkspaceRequestQuery$1 & CreateWorkspaceRequestParams$1;
 interface CreateWorkspaceResponse$1 {
@@ -15432,6 +15453,7 @@ declare class Client$9 {
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput$1) => Promise<ListWorkspaceInvoicesResponse$1>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput$1) => Promise<GetUpcomingInvoiceResponse$1>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput$1) => Promise<ChargeWorkspaceUnpaidInvoicesResponse$1>;
+    readonly saveWorkspaceCancellationReasons: (input: SaveWorkspaceCancellationReasonsInput$1) => Promise<SaveWorkspaceCancellationReasonsResponse$1>;
     readonly createWorkspace: (input: CreateWorkspaceInput$1) => Promise<CreateWorkspaceResponse$1>;
     readonly getPublicWorkspace: (input: GetPublicWorkspaceInput$1) => Promise<GetPublicWorkspaceResponse$3>;
     readonly getWorkspace: (input: GetWorkspaceInput$1) => Promise<GetWorkspaceResponse$1>;
@@ -16059,6 +16081,18 @@ interface GetSubscriptionResponse {
         start: string;
         end: string | null;
     }[];
+    /**
+     * A plan/addon change awaiting payment confirmation, if any
+     */
+    pendingUpgrade: {
+        planId: string | null;
+        interval: ("month" | "year") | null;
+        addons: {
+            [k: string]: number;
+        };
+        invoiceId: string;
+        expiresAt: string;
+    } | null;
 }
 
 interface PreviewSubscriptionUpdateRequestHeaders {
@@ -16252,6 +16286,18 @@ interface SetPlanResponse {
         start: string;
         end: string | null;
     }[];
+    /**
+     * A plan/addon change awaiting payment confirmation, if any
+     */
+    pendingUpgrade: {
+        planId: string | null;
+        interval: ("month" | "year") | null;
+        addons: {
+            [k: string]: number;
+        };
+        invoiceId: string;
+        expiresAt: string;
+    } | null;
 }
 
 interface SetAddonsRequestHeaders {
@@ -16327,6 +16373,18 @@ interface SetAddonsResponse {
         start: string;
         end: string | null;
     }[];
+    /**
+     * A plan/addon change awaiting payment confirmation, if any
+     */
+    pendingUpgrade: {
+        planId: string | null;
+        interval: ("month" | "year") | null;
+        addons: {
+            [k: string]: number;
+        };
+        invoiceId: string;
+        expiresAt: string;
+    } | null;
 }
 
 interface SetCancelAtPeriodEndRequestHeaders {
@@ -16392,6 +16450,95 @@ interface SetCancelAtPeriodEndResponse {
         start: string;
         end: string | null;
     }[];
+    /**
+     * A plan/addon change awaiting payment confirmation, if any
+     */
+    pendingUpgrade: {
+        planId: string | null;
+        interval: ("month" | "year") | null;
+        addons: {
+            [k: string]: number;
+        };
+        invoiceId: string;
+        expiresAt: string;
+    } | null;
+}
+
+interface CancelPendingSubscriptionUpgradeRequestHeaders {
+}
+interface CancelPendingSubscriptionUpgradeRequestQuery {
+}
+interface CancelPendingSubscriptionUpgradeRequestParams {
+}
+interface CancelPendingSubscriptionUpgradeRequestBody {
+}
+type CancelPendingSubscriptionUpgradeInput = CancelPendingSubscriptionUpgradeRequestBody & CancelPendingSubscriptionUpgradeRequestHeaders & CancelPendingSubscriptionUpgradeRequestQuery & CancelPendingSubscriptionUpgradeRequestParams;
+/**
+ * Subscription details including current plan, addons, and costs
+ */
+interface CancelPendingSubscriptionUpgradeResponse {
+    plan: {
+        current: {
+            status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "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;
+        };
+    };
+    /**
+     * Active discounts applied to the subscription
+     */
+    discounts: {
+        id: string;
+        couponId: string;
+        promotionCode: string | null;
+        name: string | null;
+        percentOff: number | null;
+        /**
+         * Discount amount in dollars, or null if percent-based
+         */
+        amountOff: number | null;
+        currency: string | null;
+        duration: "forever" | "once" | "repeating";
+        durationInMonths: number | null;
+        start: string;
+        end: string | null;
+    }[];
+    /**
+     * A plan/addon change awaiting payment confirmation, if any
+     */
+    pendingUpgrade: {
+        planId: string | null;
+        interval: ("month" | "year") | null;
+        addons: {
+            [k: string]: number;
+        };
+        invoiceId: string;
+        expiresAt: string;
+    } | null;
 }
 
 interface GetAutoRechargeSettingsRequestHeaders {
@@ -16763,6 +16910,7 @@ declare class Client$7 {
     readonly setPlan: (input: SetPlanInput) => Promise<SetPlanResponse>;
     readonly setAddons: (input: SetAddonsInput) => Promise<SetAddonsResponse>;
     readonly setCancelAtPeriodEnd: (input: SetCancelAtPeriodEndInput) => Promise<SetCancelAtPeriodEndResponse>;
+    readonly cancelPendingSubscriptionUpgrade: (input: CancelPendingSubscriptionUpgradeInput) => Promise<CancelPendingSubscriptionUpgradeResponse>;
     readonly getAutoRechargeSettings: (input: GetAutoRechargeSettingsInput) => Promise<GetAutoRechargeSettingsResponse>;
     readonly setAutoRechargeSettings: (input: SetAutoRechargeSettingsInput) => Promise<SetAutoRechargeSettingsResponse>;
     readonly getTrials: (input: GetTrialsInput) => Promise<GetTrialsResponse>;
@@ -17085,9 +17233,9 @@ interface UpsertFileResponse$1 {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -17217,9 +17365,9 @@ interface ListFilesResponse$1 {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     }[];
     meta: {
         /**
@@ -17329,9 +17477,9 @@ interface GetFileResponse$1 {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -17455,9 +17603,9 @@ interface UpdateFileMetadataResponse$1 {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -17569,9 +17717,9 @@ interface CopyFileResponse$1 {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -18040,7 +18188,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
                 name?: string;
                 alias?: string;
             };
-            indexingStack?: "v1" | "v2";
+            indexingStack?: "v1" | "v2" | "v3";
         }>;
         filePassages: (props: {
             id: string;
@@ -28085,6 +28233,27 @@ interface ChargeWorkspaceUnpaidInvoicesResponse {
     }[];
 }
 
+interface SaveWorkspaceCancellationReasonsRequestHeaders {
+}
+interface SaveWorkspaceCancellationReasonsRequestQuery {
+}
+interface SaveWorkspaceCancellationReasonsRequestParams {
+    id: string;
+}
+interface SaveWorkspaceCancellationReasonsRequestBody {
+    /**
+     * Reasons for canceling the subscription
+     */
+    reasons: ("too_expensive" | "not_using_enough" | "missing_feature" | "switched_tool" | "technical_issues" | "support_expectations" | "temporary_need")[];
+    /**
+     * Additional comment on the cancellation
+     */
+    comment?: string;
+}
+type SaveWorkspaceCancellationReasonsInput = SaveWorkspaceCancellationReasonsRequestBody & SaveWorkspaceCancellationReasonsRequestHeaders & SaveWorkspaceCancellationReasonsRequestQuery & SaveWorkspaceCancellationReasonsRequestParams;
+interface SaveWorkspaceCancellationReasonsResponse {
+}
+
 interface CreateWorkspaceRequestHeaders {
 }
 interface CreateWorkspaceRequestQuery {
@@ -28093,7 +28262,7 @@ interface CreateWorkspaceRequestParams {
 }
 interface CreateWorkspaceRequestBody {
     name: string;
-    billingVersion?: "v4";
+    billingVersion?: "v4" | "v5";
 }
 type CreateWorkspaceInput = CreateWorkspaceRequestBody & CreateWorkspaceRequestHeaders & CreateWorkspaceRequestQuery & CreateWorkspaceRequestParams;
 interface CreateWorkspaceResponse {
@@ -35101,9 +35270,9 @@ interface UpsertFileResponse {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -35233,9 +35402,9 @@ interface ListFilesResponse {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     }[];
     meta: {
         /**
@@ -35345,9 +35514,9 @@ interface GetFileResponse {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -35471,9 +35640,9 @@ interface UpdateFileMetadataResponse {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -35585,9 +35754,9 @@ interface CopyFileResponse {
             alias?: string;
         };
         /**
-         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
          */
-        indexingStack?: "v1" | "v2";
+        indexingStack?: "v1" | "v2" | "v3";
     };
 }
 
@@ -39588,9 +39757,9 @@ interface File {
         alias?: string;
     };
     /**
-     * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+     * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed.
      */
-    indexingStack?: "v1" | "v2";
+    indexingStack?: "v1" | "v2" | "v3";
 }
 
 type HttpResponse<T> = {
@@ -39714,6 +39883,7 @@ declare class Client$1 {
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
+    readonly saveWorkspaceCancellationReasons: (input: SaveWorkspaceCancellationReasonsInput) => Promise<SaveWorkspaceCancellationReasonsResponse>;
     readonly createWorkspace: (input: CreateWorkspaceInput) => Promise<CreateWorkspaceResponse>;
     readonly getPublicWorkspace: (input: GetPublicWorkspaceInput) => Promise<GetPublicWorkspaceResponse$1>;
     readonly getWorkspace: (input: GetWorkspaceInput) => Promise<GetWorkspaceResponse>;
@@ -40197,7 +40367,7 @@ declare class Client extends Client$1 implements IClient {
                 name?: string;
                 alias?: string;
             };
-            indexingStack?: "v1" | "v2";
+            indexingStack?: "v1" | "v2" | "v3";
         }>;
         filePassages: (props: {
             id: string;