npm - @botpress/api - Versions diffs - 0.9.0 → 0.11.0 - Mend

@botpress/api 0.9.0 → 0.11.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 (7) hide show

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

@@ -2287,20 +2287,524 @@ export declare const state: {
                                         description: string;
                                     };
                                     returningUsers: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     newUsers: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     sessions: {
-                                        type: "number";
+                                        type: "integer";
                                     };
                                     messages: {
+                                        type: "integer";
+                                        description: string;
+                                    };
+                                    userMessages: {
+                                        type: "integer";
+                                    };
+                                    botMessages: {
+                                        type: "integer";
+                                    };
+                                    events: {
+                                        type: "integer";
+                                    };
+                                    eventTypes: {
+                                        type: "object";
+                                        additionalProperties: {
+                                            type: "number";
+                                        };
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listBotIssues: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        issues: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    code: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    lastSeenAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    title: {
+                                        type: "string";
+                                    };
+                                    description: {
+                                        type: "string";
+                                    };
+                                    groupedData: {
+                                        type: "object";
+                                        properties: {};
+                                    };
+                                    eventsCount: {
+                                        type: "number";
+                                    };
+                                    category: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
+                                    resolutionLink: {
+                                        type: "string";
+                                        nullable: true;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteBotIssue: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                issueId: {
+                    in: "path";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listBotIssueEvents: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                issueId: {
+                    in: "path";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        issueEvents: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    data: {
+                                        type: "object";
+                                        properties: {};
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        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[];
@@ -4359,6 +4863,8 @@ export declare const state: {
             createBotBody: true;
             updateBotBody: true;
             transferBotBody: true;
+            setWorkspacePaymentMethodBody: true;
+            chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
             changeWorkspacePlanBody: true;
@@ -4412,6 +4918,13 @@ export declare const state: {
             getBotLogsResponse: true;
             getBotWebchatResponse: true;
             getBotAnalyticsResponse: true;
+            listBotIssuesResponse: true;
+            deleteBotIssueResponse: true;
+            listBotIssueEventsResponse: true;
+            getWorkspaceBillingDetailsResponse: true;
+            setWorkspacePaymentMethodResponse: true;
+            listWorkspaceInvoicesResponse: true;
+            chargeWorkspaceUnpaidInvoicesResponse: true;
             createWorkspaceResponse: true;
             getWorkspaceResponse: true;
             listWorkspaceUsagesResponse: true;
@@ -4449,6 +4962,8 @@ export declare const state: {
             WorkspaceMember: true;
             Account: true;
             Usage: true;
+            Issue: true;
+            IssueEvent: true;
             User: true;
             Conversation: true;
             Event: true;
@@ -4501,6 +5016,9 @@ export declare const state: {
                                 webhookUrl: {
                                     type: "string";
                                 };
+                                webhookId: {
+                                    type: "string";
+                                };
                                 configuration: {
                                     type: "object";
                                     additionalProperties: true;
@@ -5199,6 +5717,72 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Issue: {
+            section: "bot";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    code: {
+                        type: "string";
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    lastSeenAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    title: {
+                        type: "string";
+                    };
+                    description: {
+                        type: "string";
+                    };
+                    groupedData: {
+                        type: "object";
+                        additionalProperties: false;
+                    };
+                    eventsCount: {
+                        type: "number";
+                    };
+                    category: {
+                        type: "string";
+                        enum: string[];
+                    };
+                    resolutionLink: {
+                        type: "string";
+                        nullable: true;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
+        IssueEvent: {
+            section: "bot";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    data: {
+                        type: "object";
+                        additionalProperties: false;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {

package/dist/index.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 export declare const api: {
-    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage">;
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
+    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage">;
+    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
     addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage", Path, "zod-schema">) => void;
     exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
     exportTypesBySection: (dir?: string | undefined) => Promise<void>;