@botpress/client 0.18.0 → 0.19.0

package/dist/gen/index.d.ts

@@ -1,4 +1,5 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { AxiosInstance } from 'axios';
+import { toAxiosRequest } from './to-axios';
 import * as createConversation from './operations/createConversation';
 import * as getConversation from './operations/getConversation';
 import * as listConversations from './operations/listConversations';
@@ -56,6 +57,7 @@ import * as deleteBot from './operations/deleteBot';
 import * as getBotLogs from './operations/getBotLogs';
 import * as getBotWebchat from './operations/getBotWebchat';
 import * as getBotAnalytics from './operations/getBotAnalytics';
+import * as getBotIssue from './operations/getBotIssue';
 import * as listBotIssues from './operations/listBotIssues';
 import * as deleteBotIssue from './operations/deleteBotIssue';
 import * as listBotIssueEvents from './operations/listBotIssueEvents';
@@ -174,6 +176,7 @@ export * as deleteBot from './operations/deleteBot';
 export * as getBotLogs from './operations/getBotLogs';
 export * as getBotWebchat from './operations/getBotWebchat';
 export * as getBotAnalytics from './operations/getBotAnalytics';
+export * as getBotIssue from './operations/getBotIssue';
 export * as listBotIssues from './operations/listBotIssues';
 export * as deleteBotIssue from './operations/deleteBotIssue';
 export * as listBotIssueEvents from './operations/listBotIssueEvents';
@@ -234,9 +237,13 @@ export * as createTableRows from './operations/createTableRows';
 export * as deleteTableRows from './operations/deleteTableRows';
 export * as updateTableRows from './operations/updateTableRows';
 export * as upsertTableRows from './operations/upsertTableRows';
+export type ClientProps = {
+    toAxiosRequest: typeof toAxiosRequest;
+};
 export declare class Client {
     private axiosInstance;
-    constructor(axiosInstance: AxiosInstance);
+    private props;
+    constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps>);
     readonly createConversation: (input: createConversation.CreateConversationInput) => Promise<createConversation.CreateConversationResponse>;
     readonly getConversation: (input: getConversation.GetConversationInput) => Promise<getConversation.GetConversationResponse>;
     readonly listConversations: (input: listConversations.ListConversationsInput) => Promise<listConversations.ListConversationsResponse>;
@@ -294,6 +301,7 @@ export declare class Client {
     readonly getBotLogs: (input: getBotLogs.GetBotLogsInput) => Promise<getBotLogs.GetBotLogsResponse>;
     readonly getBotWebchat: (input: getBotWebchat.GetBotWebchatInput) => Promise<getBotWebchat.GetBotWebchatResponse>;
     readonly getBotAnalytics: (input: getBotAnalytics.GetBotAnalyticsInput) => Promise<getBotAnalytics.GetBotAnalyticsResponse>;
+    readonly getBotIssue: (input: getBotIssue.GetBotIssueInput) => Promise<getBotIssue.GetBotIssueResponse>;
     readonly listBotIssues: (input: listBotIssues.ListBotIssuesInput) => Promise<listBotIssues.ListBotIssuesResponse>;
     readonly deleteBotIssue: (input: deleteBotIssue.DeleteBotIssueInput) => Promise<deleteBotIssue.DeleteBotIssueResponse>;
     readonly listBotIssueEvents: (input: listBotIssueEvents.ListBotIssueEventsInput) => Promise<listBotIssueEvents.ListBotIssueEventsResponse>;
@@ -355,18 +363,3 @@ export declare class Client {
     readonly updateTableRows: (input: updateTableRows.UpdateTableRowsInput) => Promise<updateTableRows.UpdateTableRowsResponse>;
     readonly upsertTableRows: (input: upsertTableRows.UpsertTableRowsInput) => Promise<upsertTableRows.UpsertTableRowsResponse>;
 }
-type Primitive = string | number | boolean;
-type Value<P extends Primitive> = P | P[] | Record<string, P>;
-type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
-type AnyQueryParams = Record<string, QueryValue>;
-type HeaderValue = string | undefined;
-type AnyHeaderParams = Record<string, HeaderValue>;
-type AnyBodyParams = Record<string, any>;
-type ParsedRequest = {
-    method: string;
-    path: string;
-    query: AnyQueryParams;
-    headers: AnyHeaderParams;
-    body: AnyBodyParams;
-};
-export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;

package/dist/gen/models.d.ts

@@ -566,7 +566,6 @@ export interface Workspace {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    accountType: "free" | "premium";
     billingVersion: "v1" | "v2";
     plan: "community" | "team" | "enterprise";
     blocked: boolean;
@@ -1144,17 +1143,17 @@ export interface File {
      */
     index: boolean;
     /**
-     * Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.
+     * Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.
      *
-     * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.
+     * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.
      *
-     * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).
+     * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).
      *
-     * Once the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.
+     * Once the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.
      */
-    status: "UPLOAD_PENDING" | "UPLOAD_FAILED" | "UPLOAD_COMPLETED" | "INDEXING_PENDING" | "INDEXING_FAILED" | "INDEXING_COMPLETED";
+    status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
     /**
-     * If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.
+     * If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.
      */
     failedStatusReason?: string;
 }

package/dist/gen/operations/createFile.d.ts

@@ -87,17 +87,17 @@ export interface CreateFileResponse {
          */
         index: boolean;
         /**
-         * Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.
+         * Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.
          *
-         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.
          *
-         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).
          *
-         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.
          */
-        status: "UPLOAD_PENDING" | "UPLOAD_FAILED" | "UPLOAD_COMPLETED" | "INDEXING_PENDING" | "INDEXING_FAILED" | "INDEXING_COMPLETED";
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
         /**
-         * If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.
+         * If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.
          */
         failedStatusReason?: string;
         /**

package/dist/gen/operations/createWorkspace.d.ts

@@ -24,7 +24,6 @@ export interface CreateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    accountType: "free" | "premium";
     billingVersion: "v1" | "v2";
     plan: "community" | "team" | "enterprise";
     blocked: boolean;

package/dist/gen/operations/getBotIssue.d.ts

@@ -0,0 +1,39 @@
+export interface GetBotIssueRequestHeaders {
+}
+export interface GetBotIssueRequestQuery {
+}
+export interface GetBotIssueRequestParams {
+    id: string;
+    issueId: string;
+}
+export interface GetBotIssueRequestBody {
+}
+export type GetBotIssueInput = GetBotIssueRequestBody & GetBotIssueRequestHeaders & GetBotIssueRequestQuery & GetBotIssueRequestParams;
+export type GetBotIssueRequest = {
+    headers: GetBotIssueRequestHeaders;
+    query: GetBotIssueRequestQuery;
+    params: GetBotIssueRequestParams;
+    body: GetBotIssueRequestBody;
+};
+export declare const parseReq: (input: GetBotIssueInput) => GetBotIssueRequest & {
+    path: string;
+};
+export interface GetBotIssueResponse {
+    issue: {
+        id: string;
+        code: string;
+        createdAt: string;
+        lastSeenAt: string;
+        title: string;
+        description: string;
+        groupedData: {
+            [k: string]: {
+                raw: string;
+                pretty?: string;
+            };
+        };
+        eventsCount: number;
+        category: "user_code" | "limits" | "configuration" | "other";
+        resolutionLink: string | null;
+    };
+}

package/dist/gen/operations/getFile.d.ts

@@ -68,17 +68,17 @@ export interface GetFileResponse {
          */
         index: boolean;
         /**
-         * Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.
+         * Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.
          *
-         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.
          *
-         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).
          *
-         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.
          */
-        status: "UPLOAD_PENDING" | "UPLOAD_FAILED" | "UPLOAD_COMPLETED" | "INDEXING_PENDING" | "INDEXING_FAILED" | "INDEXING_COMPLETED";
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
         /**
-         * If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.
+         * If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.
          */
         failedStatusReason?: string;
     };

package/dist/gen/operations/getWorkspace.d.ts

@@ -24,7 +24,6 @@ export interface GetWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    accountType: "free" | "premium";
     billingVersion: "v1" | "v2";
     plan: "community" | "team" | "enterprise";
     blocked: boolean;

package/dist/gen/operations/listFiles.d.ts

@@ -71,17 +71,17 @@ export interface ListFilesResponse {
          */
         index: boolean;
         /**
-         * Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.
+         * Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.
          *
-         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.
          *
-         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).
          *
-         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.
          */
-        status: "UPLOAD_PENDING" | "UPLOAD_FAILED" | "UPLOAD_COMPLETED" | "INDEXING_PENDING" | "INDEXING_FAILED" | "INDEXING_COMPLETED";
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
         /**
-         * If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.
+         * If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.
          */
         failedStatusReason?: string;
     }[];

package/dist/gen/operations/listWorkspaces.d.ts

@@ -33,7 +33,6 @@ export interface UpdateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    accountType: "free" | "premium";
     billingVersion: "v1" | "v2";
     plan: "community" | "team" | "enterprise";
     blocked: boolean;

package/dist/gen/operations/updateFile.d.ts

@@ -78,17 +78,17 @@ export interface UpdateFileResponse {
          */
         index: boolean;
         /**
-         * Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.
+         * Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.
          *
-         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.
          *
-         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).
          *
-         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.
          */
-        status: "UPLOAD_PENDING" | "UPLOAD_FAILED" | "UPLOAD_COMPLETED" | "INDEXING_PENDING" | "INDEXING_FAILED" | "INDEXING_COMPLETED";
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
         /**
-         * If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.
+         * If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.
          */
         failedStatusReason?: string;
     };

package/dist/gen/operations/updateWorkspace.d.ts

@@ -36,7 +36,6 @@ export interface UpdateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    accountType: "free" | "premium";
     billingVersion: "v1" | "v2";
     plan: "community" | "team" | "enterprise";
     blocked: boolean;

package/dist/gen/to-axios.d.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig } from "axios";
+export type Primitive = string | number | boolean;
+export type Value<P extends Primitive> = P | P[] | Record<string, P>;
+export type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
+export type AnyQueryParams = Record<string, QueryValue>;
+export type HeaderValue = string | undefined;
+export type AnyHeaderParams = Record<string, HeaderValue>;
+export type AnyBodyParams = Record<string, any>;
+export type ParsedRequest = {
+    method: string;
+    path: string;
+    query: AnyQueryParams;
+    headers: AnyHeaderParams;
+    body: AnyBodyParams;
+};
+export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;