npm - @botpress/api - Versions diffs - 0.10.0 → 0.12.0 - Mend

@botpress/api 0.10.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/gen/state.d.ts CHANGED Viewed

@@ -2287,16 +2287,32 @@ export declare const state: {
                                         description: string;
                                     };
                                     returningUsers: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     newUsers: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     sessions: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     messages: {
-                                        type: "number";
+                                        type: "integer";
+                                        description: string;
+                                    };
+                                    userMessages: {
+                                        type: "integer";
+                                    };
+                                    botMessages: {
+                                        type: "integer";
+                                    };
+                                    events: {
+                                        type: "integer";
+                                    };
+                                    eventTypes: {
+                                        type: "object";
+                                        additionalProperties: {
+                                            type: "number";
+                                        };
                                     };
                                 };
                                 required: string[];
@@ -2470,6 +2486,333 @@ export declare const state: {
                 };
             };
         };
+        getWorkspaceBillingDetails: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            section: "workspace";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        currentPeriod: {
+                            type: "object";
+                            properties: {
+                                start: {
+                                    type: "string";
+                                };
+                                end: {
+                                    type: "string";
+                                };
+                                usage: {
+                                    type: "object";
+                                    properties: {
+                                        userMessages: {
+                                            type: "object";
+                                            properties: {
+                                                status: {
+                                                    type: "string";
+                                                    enum: string[];
+                                                };
+                                                quantity: {
+                                                    type: "number";
+                                                };
+                                                price: {
+                                                    type: "number";
+                                                };
+                                                minimum: {
+                                                    type: "number";
+                                                };
+                                                maximum: {
+                                                    type: "number";
+                                                };
+                                            };
+                                            required: string[];
+                                            additionalProperties: false;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                        paymentMethod: {
+                            type: "object";
+                            properties: {
+                                type: {
+                                    type: "string";
+                                };
+                                lastDigits: {
+                                    type: "string";
+                                };
+                            };
+                            required: string[];
+                            nullable: true;
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        setWorkspacePaymentMethod: {
+            name: string;
+            description: string;
+            method: "put";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            section: "workspace";
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        stripePaymentMethodId: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        stripePaymentMethodId: {
+                            type: "string";
+                        };
+                        paymentMethod: {
+                            type: "object";
+                            properties: {
+                                type: {
+                                    type: "string";
+                                };
+                                lastDigits: {
+                                    type: "string";
+                                };
+                            };
+                            required: string[];
+                            nullable: true;
+                            additionalProperties: false;
+                        };
+                        status: {
+                            type: "string";
+                            enum: string[];
+                        };
+                        nextAction: {
+                            type: "object";
+                            properties: {
+                                redirectToUrl: {
+                                    type: "string";
+                                    format: string;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listWorkspaceInvoices: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            section: "workspace";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        invoices: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    period: {
+                                        type: "object";
+                                        properties: {
+                                            month: {
+                                                type: "number";
+                                            };
+                                            year: {
+                                                type: "number";
+                                            };
+                                        };
+                                        required: string[];
+                                    };
+                                    date: {
+                                        type: "string";
+                                        format: string;
+                                        description: string;
+                                    };
+                                    amount: {
+                                        type: "number";
+                                        description: string;
+                                    };
+                                    currency: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    paymentStatus: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
+                                    paymentAttemptCount: {
+                                        type: "number";
+                                        description: string;
+                                        nullable: true;
+                                    };
+                                    nextPaymentAttemptDate: {
+                                        type: "string";
+                                        format: string;
+                                        description: string;
+                                        nullable: true;
+                                    };
+                                    pdfUrl: {
+                                        type: "string";
+                                        format: string;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        chargeWorkspaceUnpaidInvoices: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            section: "workspace";
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        invoiceIds: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            minItems: number;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        chargedInvoices: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    amount: {
+                                        type: "number";
+                                    };
+                                };
+                                required: string[];
+                            };
+                            description: string;
+                        };
+                        failedInvoices: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    amount: {
+                                        type: "number";
+                                    };
+                                    failedReason: {
+                                        type: "string";
+                                    };
+                                };
+                                required: string[];
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         createWorkspace: {
             name: string;
             description: string;
@@ -2520,6 +2863,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        plan: {
+                            type: "string";
+                            enum: string[];
+                        };
                         blocked: {
                             type: "boolean";
                         };
@@ -2577,6 +2924,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        plan: {
+                            type: "string";
+                            enum: string[];
+                        };
                         blocked: {
                             type: "boolean";
                         };
@@ -2817,6 +3168,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        plan: {
+                            type: "string";
+                            enum: string[];
+                        };
                         blocked: {
                             type: "boolean";
                         };
@@ -2878,6 +3233,10 @@ export declare const state: {
                                         type: "string";
                                         enum: string[];
                                     };
+                                    plan: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
                                     blocked: {
                                         type: "boolean";
                                     };
@@ -2964,6 +3323,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        plan: {
+                            type: "string";
+                            enum: string[];
+                        };
                         blocked: {
                             type: "boolean";
                         };
@@ -3294,9 +3657,19 @@ export declare const state: {
                                     additionalProperties: true;
                                     description: string;
                                 };
+                                identifier: {
+                                    type: "object";
+                                    properties: {
+                                        required: {
+                                            type: "boolean";
+                                        };
+                                        linkTemplateScript: {
+                                            type: "string";
+                                        };
+                                    };
+                                    additionalProperties: false;
+                                };
                             };
-                            required: string[];
-                            description: string;
                             additionalProperties: false;
                         };
                         states: {
@@ -3388,6 +3761,15 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        identifier: {
+                            type: "object";
+                            properties: {
+                                extractScript: {
+                                    type: "string";
+                                };
+                            };
+                            additionalProperties: false;
+                        };
                         channels: {
                             type: "object";
                             additionalProperties: {
@@ -3618,9 +4000,20 @@ export declare const state: {
                                     additionalProperties: true;
                                     description: string;
                                 };
+                                identifier: {
+                                    type: "object";
+                                    properties: {
+                                        linkTemplateScript: {
+                                            type: "string";
+                                            nullable: true;
+                                        };
+                                        required: {
+                                            type: "boolean";
+                                        };
+                                    };
+                                    additionalProperties: false;
+                                };
                             };
-                            required: string[];
-                            description: string;
                             additionalProperties: false;
                         };
                         channels: {
@@ -3732,6 +4125,16 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        identifier: {
+                            type: "object";
+                            properties: {
+                                extractScript: {
+                                    type: "string";
+                                    nullable: true;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
                         actions: {
                             type: "object";
                             additionalProperties: {
@@ -4520,6 +4923,8 @@ export declare const state: {
             createBotBody: true;
             updateBotBody: true;
             transferBotBody: true;
+            setWorkspacePaymentMethodBody: true;
+            chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
             changeWorkspacePlanBody: true;
@@ -4576,6 +4981,10 @@ export declare const state: {
             listBotIssuesResponse: true;
             deleteBotIssueResponse: true;
             listBotIssueEventsResponse: true;
+            getWorkspaceBillingDetailsResponse: true;
+            setWorkspacePaymentMethodResponse: true;
+            listWorkspaceInvoicesResponse: true;
+            chargeWorkspaceUnpaidInvoicesResponse: true;
             createWorkspaceResponse: true;
             getWorkspaceResponse: true;
             listWorkspaceUsagesResponse: true;
@@ -4667,6 +5076,9 @@ export declare const state: {
                                 webhookUrl: {
                                     type: "string";
                                 };
+                                webhookId: {
+                                    type: "string";
+                                };
                                 configuration: {
                                     type: "object";
                                     additionalProperties: true;
@@ -4955,6 +5367,17 @@ export declare const state: {
                         format: string;
                         description: string;
                     };
+                    identifier: {
+                        type: "object";
+                        properties: {
+                            extractScript: {
+                                type: "string";
+                                description: string;
+                            };
+                        };
+                        description: string;
+                        additionalProperties: false;
+                    };
                     name: {
                         type: "string";
                         description: string;
@@ -4966,6 +5389,20 @@ export declare const state: {
                     configuration: {
                         type: "object";
                         properties: {
+                            identifier: {
+                                type: "object";
+                                properties: {
+                                    linkTemplateScript: {
+                                        type: "string";
+                                    };
+                                    required: {
+                                        type: "boolean";
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
                             schema: {
                                 type: "object";
                                 additionalProperties: true;
@@ -5278,6 +5715,10 @@ export declare const state: {
                         type: "string";
                         enum: string[];
                     };
+                    plan: {
+                        type: "string";
+                        enum: string[];
+                    };
                     blocked: {
                         type: "boolean";
                     };