@botpress/client 0.0.11 → 0.0.12

package/dist/gen/api.d.ts

@@ -104,6 +104,12 @@ export interface Bot {
      * @memberof Bot
      */
     'dev': boolean;
+    /**
+     * Id of the user that created the bot
+     * @type {string}
+     * @memberof Bot
+     */
+    'createdBy'?: string;
     /**
      * Media files associated with the [Bot](#schema_bot)
      * @type {Array<BotMediasInner>}
@@ -782,6 +788,30 @@ export interface CreateIntegrationBody {
      * @memberof CreateIntegrationBody
      */
     'dev'?: boolean;
+    /**
+     * Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
+     * @type {string}
+     * @memberof CreateIntegrationBody
+     */
+    'icon'?: string;
+    /**
+     * Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
+     * @type {string}
+     * @memberof CreateIntegrationBody
+     */
+    'readme'?: string;
+    /**
+     * Title of the integration. This is the name that will be displayed in the UI
+     * @type {string}
+     * @memberof CreateIntegrationBody
+     */
+    'title'?: string;
+    /**
+     * Description of the integration. This is the description that will be displayed in the UI
+     * @type {string}
+     * @memberof CreateIntegrationBody
+     */
+    'description'?: string;
 }
 /**
  *
@@ -1313,6 +1343,19 @@ export interface GetIntegrationByNameResponse {
      */
     'integration': Integration;
 }
+/**
+ *
+ * @export
+ * @interface GetIntegrationLogsResponse
+ */
+export interface GetIntegrationLogsResponse {
+    /**
+     *
+     * @type {Array<GetBotLogsResponseLogsInner>}
+     * @memberof GetIntegrationLogsResponse
+     */
+    'logs': Array<GetBotLogsResponseLogsInner>;
+}
 /**
  *
  * @export
@@ -1419,6 +1462,12 @@ export interface GetOrCreateMessageBody {
     'tags': {
         [key: string]: string;
     };
+    /**
+     *
+     * @type {CreateMessageBodySchedule}
+     * @memberof GetOrCreateMessageBody
+     */
+    'schedule'?: CreateMessageBodySchedule;
 }
 /**
  *
@@ -1519,6 +1568,61 @@ export interface GetUserResponse {
      */
     'user': User;
 }
+/**
+ *
+ * @export
+ * @interface GetWorkspaceResponse
+ */
+export interface GetWorkspaceResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'ownerId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'updatedAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetWorkspaceResponse
+     */
+    'accountType': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetWorkspaceResponse
+     */
+    'blocked': boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof GetWorkspaceResponse
+     */
+    'spendingLimit': number;
+}
 /**
  *
  * @export
@@ -1605,6 +1709,30 @@ export interface Integration {
      * @memberof Integration
      */
     'dev': boolean;
+    /**
+     * Title of the integration. This is the name that will be displayed in the UI
+     * @type {string}
+     * @memberof Integration
+     */
+    'title': string;
+    /**
+     * Description of the integration. This is the description that will be displayed in the UI
+     * @type {string}
+     * @memberof Integration
+     */
+    'description': string;
+    /**
+     * URL of the icon of the integration. This is the icon that will be displayed in the UI
+     * @type {string}
+     * @memberof Integration
+     */
+    'iconUrl': string;
+    /**
+     * URL of the readme of the integration. This is the readme that will be displayed in the UI
+     * @type {string}
+     * @memberof Integration
+     */
+    'readmeUrl': string;
 }
 /**
  *
@@ -1890,6 +2018,24 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
      * @memberof ListPublicIntegrationsResponseIntegrationsInner
      */
     'updatedAt': string;
+    /**
+     * Title of the integration. This is the name that will be displayed in the UI
+     * @type {string}
+     * @memberof ListPublicIntegrationsResponseIntegrationsInner
+     */
+    'title': string;
+    /**
+     * Description of the integration. This is the description that will be displayed in the UI
+     * @type {string}
+     * @memberof ListPublicIntegrationsResponseIntegrationsInner
+     */
+    'description': string;
+    /**
+     * URL of the icon of the integration. This is the icon that will be displayed in the UI
+     * @type {string}
+     * @memberof ListPublicIntegrationsResponseIntegrationsInner
+     */
+    'iconUrl': string;
 }
 /**
  *
@@ -2462,6 +2608,30 @@ export interface UpdateIntegrationBody {
      * @memberof UpdateIntegrationBody
      */
     'url'?: string;
+    /**
+     * Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
+     * @type {string}
+     * @memberof UpdateIntegrationBody
+     */
+    'icon'?: string;
+    /**
+     * Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
+     * @type {string}
+     * @memberof UpdateIntegrationBody
+     */
+    'readme'?: string;
+    /**
+     * Title of the integration. This is the name that will be displayed in the UI
+     * @type {string}
+     * @memberof UpdateIntegrationBody
+     */
+    'title'?: string;
+    /**
+     * Description of the integration. This is the description that will be displayed in the UI
+     * @type {string}
+     * @memberof UpdateIntegrationBody
+     */
+    'description'?: string;
 }
 /**
  *
@@ -2565,6 +2735,61 @@ export interface User {
         [key: string]: string;
     };
 }
+/**
+ *
+ * @export
+ * @interface Workspace
+ */
+export interface Workspace {
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'ownerId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'updatedAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'accountType': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Workspace
+     */
+    'blocked': boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Workspace
+     */
+    'spendingLimit': number;
+}
 /**
  * DefaultApi - axios parameter creator
  * @export
@@ -2749,6 +2974,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getIntegrationByName: (name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get integration logs
+     * @param {string} id Integration Id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegrationLogs: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves the [Message](#schema_message) object for a valid identifier.
      * @param {string} id Id of the Message
@@ -2808,6 +3040,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getUser: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get workspace details
+     * @param {string} id Workspace ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Introspect the API
      * @param {IntrospectBody} [introspectBody]
@@ -3148,6 +3387,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationByNameResponse>>;
+    /**
+     * Get integration logs
+     * @param {string} id Integration Id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegrationLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationLogsResponse>>;
     /**
      * Retrieves the [Message](#schema_message) object for a valid identifier.
      * @param {string} id Id of the Message
@@ -3207,6 +3453,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponse>>;
+    /**
+     * Get workspace details
+     * @param {string} id Workspace ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
     /**
      * Introspect the API
      * @param {IntrospectBody} [introspectBody]
@@ -3547,6 +3800,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getIntegrationByName(name: string, version: string, options?: any): AxiosPromise<GetIntegrationByNameResponse>;
+    /**
+     * Get integration logs
+     * @param {string} id Integration Id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegrationLogs(id: string, options?: any): AxiosPromise<GetIntegrationLogsResponse>;
     /**
      * Retrieves the [Message](#schema_message) object for a valid identifier.
      * @param {string} id Id of the Message
@@ -3606,6 +3866,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getUser(id: string, options?: any): AxiosPromise<GetUserResponse>;
+    /**
+     * Get workspace details
+     * @param {string} id Workspace ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkspace(id: string, options?: any): AxiosPromise<GetWorkspaceResponse>;
     /**
      * Introspect the API
      * @param {IntrospectBody} [introspectBody]
@@ -3972,6 +4239,14 @@ export interface DefaultApiInterface {
      * @memberof DefaultApiInterface
      */
     getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
+    /**
+     * Get integration logs
+     * @param {string} id Integration Id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getIntegrationLogs(id: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationLogsResponse>;
     /**
      * Retrieves the [Message](#schema_message) object for a valid identifier.
      * @param {string} id Id of the Message
@@ -4039,6 +4314,14 @@ export interface DefaultApiInterface {
      * @memberof DefaultApiInterface
      */
     getUser(id: string, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
+    /**
+     * Get workspace details
+     * @param {string} id Workspace ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getWorkspace(id: string, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
     /**
      * Introspect the API
      * @param {IntrospectBody} [introspectBody]
@@ -4562,6 +4845,19 @@ export interface DefaultApiGetIntegrationByNameRequest {
      */
     readonly version: string;
 }
+/**
+ * Request parameters for getIntegrationLogs operation in DefaultApi.
+ * @export
+ * @interface DefaultApiGetIntegrationLogsRequest
+ */
+export interface DefaultApiGetIntegrationLogsRequest {
+    /**
+     * Integration Id
+     * @type {string}
+     * @memberof DefaultApiGetIntegrationLogs
+     */
+    readonly id: string;
+}
 /**
  * Request parameters for getMessage operation in DefaultApi.
  * @export
@@ -4684,6 +4980,19 @@ export interface DefaultApiGetUserRequest {
      */
     readonly id: string;
 }
+/**
+ * Request parameters for getWorkspace operation in DefaultApi.
+ * @export
+ * @interface DefaultApiGetWorkspaceRequest
+ */
+export interface DefaultApiGetWorkspaceRequest {
+    /**
+     * Workspace ID
+     * @type {string}
+     * @memberof DefaultApiGetWorkspace
+     */
+    readonly id: string;
+}
 /**
  * Request parameters for introspect operation in DefaultApi.
  * @export
@@ -5269,6 +5578,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @memberof DefaultApi
      */
     getIntegrationByName(requestParameters: DefaultApiGetIntegrationByNameRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIntegrationByNameResponse, any>>;
+    /**
+     * Get integration logs
+     * @param {DefaultApiGetIntegrationLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getIntegrationLogs(requestParameters: DefaultApiGetIntegrationLogsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIntegrationLogsResponse, any>>;
     /**
      * Retrieves the [Message](#schema_message) object for a valid identifier.
      * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
@@ -5333,6 +5650,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @memberof DefaultApi
      */
     getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserResponse, any>>;
+    /**
+     * Get workspace details
+     * @param {DefaultApiGetWorkspaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
     /**
      * Introspect the API
      * @param {DefaultApiIntrospectRequest} requestParameters Request parameters.

package/dist/gen/client.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import type { Merge, Except } from 'type-fest';
-import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiListWorkspacesRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
+import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspacesRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
 export declare class ApiClient {
     private _innerClient;
     constructor(configuration?: Configuration, basePath?: string, axiosInstance?: AxiosInstance);
@@ -42,13 +42,15 @@ export declare class ApiClient {
     getBotLogs: (props: GetBotLogsProps) => Promise<import("./api").GetBotLogsResponse>;
     getBotWebchat: (props: GetBotWebchatProps) => Promise<import("./api").GetBotWebchatResponse>;
     getBotAnalytics: (props: GetBotAnalyticsProps) => Promise<import("./api").GetBotAnalyticsResponse>;
+    getWorkspace: (props: GetWorkspaceProps) => Promise<import("./api").GetWorkspaceResponse>;
+    listWorkspaces: (props: ListWorkspacesProps) => Promise<import("./api").ListWorkspacesResponse>;
     createIntegration: (createIntegrationBody: CreateIntegrationProps) => Promise<import("./api").CreateIntegrationResponse>;
     updateIntegration: ({ id, ...updateIntegrationBody }: UpdateIntegrationProps) => Promise<import("./api").UpdateIntegrationResponse>;
     listIntegrations: (props: ListIntegrationsProps) => Promise<import("./api").ListIntegrationsResponse>;
     getIntegration: (props: GetIntegrationProps) => Promise<import("./api").GetIntegrationResponse>;
+    getIntegrationLogs: (props: GetIntegrationLogsProps) => Promise<import("./api").GetIntegrationLogsResponse>;
     getIntegrationByName: (props: GetIntegrationByNameProps) => Promise<import("./api").GetIntegrationByNameResponse>;
     deleteIntegration: (props: DeleteIntegrationProps) => Promise<object>;
-    listWorkspaces: (props: ListWorkspacesProps) => Promise<import("./api").ListWorkspacesResponse>;
     introspect: (introspectBody: IntrospectProps) => Promise<import("./api").IntrospectResponse>;
     createFile: (createFileBody: CreateFileProps) => Promise<import("./api").CreateFileResponse>;
     getFile: (props: GetFileProps) => Promise<import("./api").GetFileResponse>;
@@ -94,13 +96,15 @@ export type DeleteBotProps = Merge<DefaultApiDeleteBotRequest, {}>;
 export type GetBotLogsProps = Merge<DefaultApiGetBotLogsRequest, {}>;
 export type GetBotWebchatProps = Merge<DefaultApiGetBotWebchatRequest, {}>;
 export type GetBotAnalyticsProps = Merge<DefaultApiGetBotAnalyticsRequest, {}>;
+export type GetWorkspaceProps = Merge<DefaultApiGetWorkspaceRequest, {}>;
+export type ListWorkspacesProps = Merge<DefaultApiListWorkspacesRequest, {}>;
 export type CreateIntegrationProps = Merge<Except<DefaultApiCreateIntegrationRequest, 'createIntegrationBody'>, NonNullable<DefaultApiCreateIntegrationRequest['createIntegrationBody']>>;
 export type UpdateIntegrationProps = Merge<Except<DefaultApiUpdateIntegrationRequest, 'updateIntegrationBody'>, NonNullable<DefaultApiUpdateIntegrationRequest['updateIntegrationBody']>>;
 export type ListIntegrationsProps = Merge<DefaultApiListIntegrationsRequest, {}>;
 export type GetIntegrationProps = Merge<DefaultApiGetIntegrationRequest, {}>;
+export type GetIntegrationLogsProps = Merge<DefaultApiGetIntegrationLogsRequest, {}>;
 export type GetIntegrationByNameProps = Merge<DefaultApiGetIntegrationByNameRequest, {}>;
 export type DeleteIntegrationProps = Merge<DefaultApiDeleteIntegrationRequest, {}>;
-export type ListWorkspacesProps = Merge<DefaultApiListWorkspacesRequest, {}>;
 export type IntrospectProps = Merge<Except<DefaultApiIntrospectRequest, 'introspectBody'>, NonNullable<DefaultApiIntrospectRequest['introspectBody']>>;
 export type CreateFileProps = Merge<Except<DefaultApiCreateFileRequest, 'createFileBody'>, NonNullable<DefaultApiCreateFileRequest['createFileBody']>>;
 export type GetFileProps = Merge<DefaultApiGetFileRequest, {}>;