@botpress/client 0.11.4 → 0.11.5

package/dist/gen/api.d.ts

@@ -2,7 +2,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2996,6 +2996,40 @@ export interface GetOrCreateUserResponse {
      */
     'user': User;
 }
+/**
+ *
+ * @export
+ * @interface GetOrSetStateBody
+ */
+export interface GetOrSetStateBody {
+    /**
+     * Payload is the content of the state defined by your bot.
+     * @type {{ [key: string]: any; }}
+     * @memberof GetOrSetStateBody
+     */
+    'payload': {
+        [key: string]: any;
+    };
+    /**
+     * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn\'t expire.
+     * @type {number}
+     * @memberof GetOrSetStateBody
+     */
+    'expiry'?: number;
+}
+/**
+ *
+ * @export
+ * @interface GetOrSetStateResponse
+ */
+export interface GetOrSetStateResponse {
+    /**
+     *
+     * @type {State}
+     * @memberof GetOrSetStateResponse
+     */
+    'state': State;
+}
 /**
  *
  * @export
@@ -7139,6 +7173,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getOrCreateUser: (getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state.
+     * @param {GetOrSetStateTypeEnum} type State type
+     * @param {string} id State id
+     * @param {string} name State name
+     * @param {GetOrSetStateBody} [getOrSetStateBody] State content
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrSetState: (type: GetOrSetStateTypeEnum, id: string, name: string, getOrSetStateBody?: GetOrSetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
      * @param {string} id Conversation id
@@ -7892,6 +7936,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateUserResponse>>;
+    /**
+     * Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state.
+     * @param {GetOrSetStateTypeEnum} type State type
+     * @param {string} id State id
+     * @param {string} name State name
+     * @param {GetOrSetStateBody} [getOrSetStateBody] State content
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrSetState(type: GetOrSetStateTypeEnum, id: string, name: string, getOrSetStateBody?: GetOrSetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrSetStateResponse>>;
     /**
      * Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
      * @param {string} id Conversation id
@@ -8628,6 +8682,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
+    /**
+     * Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state.
+     * @param {DefaultApiGetOrSetStateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrSetState(requestParameters: DefaultApiGetOrSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrSetStateResponse>;
     /**
      * Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
      * @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
@@ -9663,6 +9724,37 @@ export interface DefaultApiGetOrCreateUserRequest {
      */
     readonly getOrCreateUserBody?: GetOrCreateUserBody;
 }
+/**
+ * Request parameters for getOrSetState operation in DefaultApi.
+ * @export
+ * @interface DefaultApiGetOrSetStateRequest
+ */
+export interface DefaultApiGetOrSetStateRequest {
+    /**
+     * State type
+     * @type {'conversation' | 'user' | 'bot' | 'integration' | 'task'}
+     * @memberof DefaultApiGetOrSetState
+     */
+    readonly type: GetOrSetStateTypeEnum;
+    /**
+     * State id
+     * @type {string}
+     * @memberof DefaultApiGetOrSetState
+     */
+    readonly id: string;
+    /**
+     * State name
+     * @type {string}
+     * @memberof DefaultApiGetOrSetState
+     */
+    readonly name: string;
+    /**
+     * State content
+     * @type {GetOrSetStateBody}
+     * @memberof DefaultApiGetOrSetState
+     */
+    readonly getOrSetStateBody?: GetOrSetStateBody;
+}
 /**
  * Request parameters for getParticipant operation in DefaultApi.
  * @export
@@ -11003,6 +11095,14 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrCreateUserResponse, any>>;
+    /**
+     * Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state.
+     * @param {DefaultApiGetOrSetStateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getOrSetState(requestParameters: DefaultApiGetOrSetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrSetStateResponse, any>>;
     /**
      * Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
      * @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
@@ -11400,6 +11500,17 @@ export declare const GetBotWebchatTypeEnum: {
     readonly SharableUrl: "sharableUrl";
 };
 export type GetBotWebchatTypeEnum = typeof GetBotWebchatTypeEnum[keyof typeof GetBotWebchatTypeEnum];
+/**
+ * @export
+ */
+export declare const GetOrSetStateTypeEnum: {
+    readonly Conversation: "conversation";
+    readonly User: "user";
+    readonly Bot: "bot";
+    readonly Integration: "integration";
+    readonly Task: "task";
+};
+export type GetOrSetStateTypeEnum = typeof GetOrSetStateTypeEnum[keyof typeof GetOrSetStateTypeEnum];
 /**
  * @export
  */

package/dist/gen/base.d.ts

@@ -2,7 +2,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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, DefaultApiListParticipantsRequest, DefaultApiAddParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiGetTaskRequest, DefaultApiCreateTaskRequest, DefaultApiUpdateTaskRequest, DefaultApiDeleteTaskRequest, DefaultApiListTasksRequest, DefaultApiRunVrlRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiSetAccountPreferenceRequest, DefaultApiGetAccountPreferenceRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiBreakDownWorkspaceUsageByBotRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiCheckHandleAvailabilityRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiChangeAISpendQuotaRequest, DefaultApiListActivitiesRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
+import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiListParticipantsRequest, DefaultApiAddParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiGetOrSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiGetTaskRequest, DefaultApiCreateTaskRequest, DefaultApiUpdateTaskRequest, DefaultApiDeleteTaskRequest, DefaultApiListTasksRequest, DefaultApiRunVrlRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiSetAccountPreferenceRequest, DefaultApiGetAccountPreferenceRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiBreakDownWorkspaceUsageByBotRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiCheckHandleAvailabilityRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiChangeAISpendQuotaRequest, DefaultApiListActivitiesRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
 export declare class ApiClient {
     private _innerClient;
     constructor(configuration?: Configuration, basePath?: string, axiosInstance?: AxiosInstance);
@@ -31,6 +31,7 @@ export declare class ApiClient {
     deleteUser: (props: DeleteUserProps) => Promise<object>;
     getState: (props: GetStateProps) => Promise<import("./api").GetStateResponse>;
     setState: ({ type, id, name, ...setStateBody }: SetStateProps) => Promise<import("./api").SetStateResponse>;
+    getOrSetState: ({ type, id, name, ...getOrSetStateBody }: GetOrSetStateProps) => Promise<import("./api").GetOrSetStateResponse>;
     patchState: ({ type, id, name, ...patchStateBody }: PatchStateProps) => Promise<import("./api").PatchStateResponse>;
     callAction: (callActionBody: CallActionProps) => Promise<import("./api").CallActionResponse>;
     configureIntegration: (configureIntegrationBody: ConfigureIntegrationProps) => Promise<object>;
@@ -129,6 +130,7 @@ export type UpdateUserProps = Merge<Except<DefaultApiUpdateUserRequest, 'updateU
 export type DeleteUserProps = Merge<DefaultApiDeleteUserRequest, {}>;
 export type GetStateProps = Merge<DefaultApiGetStateRequest, {}>;
 export type SetStateProps = Merge<Except<DefaultApiSetStateRequest, 'setStateBody'>, NonNullable<DefaultApiSetStateRequest['setStateBody']>>;
+export type GetOrSetStateProps = Merge<Except<DefaultApiGetOrSetStateRequest, 'getOrSetStateBody'>, NonNullable<DefaultApiGetOrSetStateRequest['getOrSetStateBody']>>;
 export type PatchStateProps = Merge<Except<DefaultApiPatchStateRequest, 'patchStateBody'>, NonNullable<DefaultApiPatchStateRequest['patchStateBody']>>;
 export type CallActionProps = Merge<Except<DefaultApiCallActionRequest, 'callActionBody'>, NonNullable<DefaultApiCallActionRequest['callActionBody']>>;
 export type ConfigureIntegrationProps = Merge<Except<DefaultApiConfigureIntegrationRequest, 'configureIntegrationBody'>, NonNullable<DefaultApiConfigureIntegrationRequest['configureIntegrationBody']>>;

package/dist/gen/common.d.ts

@@ -3,7 +3,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/gen/configuration.d.ts

@@ -2,7 +2,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/gen/index.d.ts

@@ -2,7 +2,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).