@botpress/client 0.6.2 → 0.6.4

package/dist/gen/api.d.ts

@@ -2,7 +2,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.12.1
+ * The version of the OpenAPI document: 0.12.6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -229,6 +229,12 @@ export interface BotIntegrationsValue {
      * @memberof BotIntegrationsValue
      */
     'webhookId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BotIntegrationsValue
+     */
+    'identifier'?: string;
     /**
      *
      * @type {{ [key: string]: any; }}
@@ -250,7 +256,7 @@ export interface BotIntegrationsValue {
      */
     'statusReason': string | null;
     /**
-     * Id of the [Integration](#schema_integration)
+     * ID of the [Integration](#schema_integration)
      * @type {string}
      * @memberof BotIntegrationsValue
      */
@@ -950,6 +956,24 @@ export interface CreateEventBody {
      * @memberof CreateEventBody
      */
     'schedule'?: CreateEventBodySchedule;
+    /**
+     * ID of the [Conversation](#schema_conversation) to link the event to.
+     * @type {string}
+     * @memberof CreateEventBody
+     */
+    'conversationId'?: string;
+    /**
+     * ID of the [User](#schema_user) to link the event to.
+     * @type {string}
+     * @memberof CreateEventBody
+     */
+    'userId'?: string;
+    /**
+     * ID of the [Message](#schema_message) to link the event to.
+     * @type {string}
+     * @memberof CreateEventBody
+     */
+    'messageId'?: string;
 }
 /**
  * Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
@@ -1329,6 +1353,12 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
  * @interface CreateIntegrationBodyIdentifier
  */
 export interface CreateIntegrationBodyIdentifier {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateIntegrationBodyIdentifier
+     */
+    'fallbackHandlerScript'?: string;
     /**
      *
      * @type {string}
@@ -1572,6 +1602,18 @@ export interface CreateUserBody {
      * @memberof CreateUserBody
      */
     'integrationName'?: string;
+    /**
+     * Name of the user
+     * @type {string}
+     * @memberof CreateUserBody
+     */
+    'name'?: string;
+    /**
+     * URL of the user picture
+     * @type {string}
+     * @memberof CreateUserBody
+     */
+    'pictureUrl'?: string;
 }
 /**
  *
@@ -1777,6 +1819,24 @@ export interface Event {
     'payload': {
         [key: string]: any;
     };
+    /**
+     * ID of the [Conversation](#schema_conversation) to link the event to.
+     * @type {string}
+     * @memberof Event
+     */
+    'conversationId'?: string;
+    /**
+     * ID of the [User](#schema_user) to link the event to.
+     * @type {string}
+     * @memberof Event
+     */
+    'userId'?: string;
+    /**
+     * ID of the [Message](#schema_message) to link the event to.
+     * @type {string}
+     * @memberof Event
+     */
+    'messageId'?: string;
 }
 /**
  *
@@ -2275,6 +2335,18 @@ export interface GetOrCreateUserBody {
      * @memberof GetOrCreateUserBody
      */
     'integrationName'?: string;
+    /**
+     * Name of the user
+     * @type {string}
+     * @memberof GetOrCreateUserBody
+     */
+    'name'?: string;
+    /**
+     * URL of the user picture
+     * @type {string}
+     * @memberof GetOrCreateUserBody
+     */
+    'pictureUrl'?: string;
 }
 /**
  *
@@ -2610,7 +2682,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
  */
 export interface Integration {
     /**
-     * Id of the [Integration](#schema_integration)
+     * ID of the [Integration](#schema_integration)
      * @type {string}
      * @memberof Integration
      */
@@ -2826,6 +2898,12 @@ export interface IntegrationConfigurationIdentifier {
  * @interface IntegrationIdentifier
  */
 export interface IntegrationIdentifier {
+    /**
+     * VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn\'t have an identifier
+     * @type {string}
+     * @memberof IntegrationIdentifier
+     */
+    'fallbackHandlerScript'?: string;
     /**
      * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
      * @type {string}
@@ -2936,10 +3014,12 @@ export interface Issue {
     'description': string;
     /**
      *
-     * @type {object}
+     * @type {{ [key: string]: IssueGroupedDataValue; }}
      * @memberof Issue
      */
-    'groupedData': object;
+    'groupedData': {
+        [key: string]: IssueGroupedDataValue;
+    };
     /**
      *
      * @type {number}
@@ -2986,10 +3066,31 @@ export interface IssueEvent {
     'createdAt': string;
     /**
      *
-     * @type {object}
+     * @type {{ [key: string]: IssueGroupedDataValue; }}
      * @memberof IssueEvent
      */
-    'data': object;
+    'data': {
+        [key: string]: IssueGroupedDataValue;
+    };
+}
+/**
+ *
+ * @export
+ * @interface IssueGroupedDataValue
+ */
+export interface IssueGroupedDataValue {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueGroupedDataValue
+     */
+    'raw': string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueGroupedDataValue
+     */
+    'pretty'?: string;
 }
 /**
  *
@@ -3024,10 +3125,12 @@ export interface ListBotIssueEventsResponseIssueEventsInner {
     'createdAt': string;
     /**
      *
-     * @type {object}
+     * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
      * @memberof ListBotIssueEventsResponseIssueEventsInner
      */
-    'data': object;
+    'data': {
+        [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
+    };
 }
 /**
  *
@@ -3092,10 +3195,12 @@ export interface ListBotIssuesResponseIssuesInner {
     'description': string;
     /**
      *
-     * @type {object}
+     * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
      * @memberof ListBotIssuesResponseIssuesInner
      */
-    'groupedData': object;
+    'groupedData': {
+        [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
+    };
     /**
      *
      * @type {number}
@@ -3122,6 +3227,25 @@ export declare const ListBotIssuesResponseIssuesInnerCategoryEnum: {
     readonly Other: "other";
 };
 export type ListBotIssuesResponseIssuesInnerCategoryEnum = typeof ListBotIssuesResponseIssuesInnerCategoryEnum[keyof typeof ListBotIssuesResponseIssuesInnerCategoryEnum];
+/**
+ *
+ * @export
+ * @interface ListBotIssuesResponseIssuesInnerGroupedDataValue
+ */
+export interface ListBotIssuesResponseIssuesInnerGroupedDataValue {
+    /**
+     *
+     * @type {string}
+     * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
+     */
+    'raw': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
+     */
+    'pretty'?: string;
+}
 /**
  *
  * @export
@@ -3350,7 +3474,7 @@ export interface ListPublicIntegrationsResponse {
  */
 export interface ListPublicIntegrationsResponseIntegrationsInner {
     /**
-     * Id of the [Integration](#schema_integration)
+     * ID of the [Integration](#schema_integration)
      * @type {string}
      * @memberof ListPublicIntegrationsResponseIntegrationsInner
      */
@@ -4537,6 +4661,12 @@ export interface UpdateIntegrationBodyIdentifier {
      * @memberof UpdateIntegrationBodyIdentifier
      */
     'extractScript'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateIntegrationBodyIdentifier
+     */
+    'fallbackHandlerScript'?: string | null;
 }
 /**
  * State definition
@@ -4641,6 +4771,18 @@ export interface UpdateUserBody {
     'tags': {
         [key: string]: string;
     };
+    /**
+     * Name of the user
+     * @type {string}
+     * @memberof UpdateUserBody
+     */
+    'name'?: string | null;
+    /**
+     * URL of the user picture
+     * @type {string}
+     * @memberof UpdateUserBody
+     */
+    'pictureUrl'?: string | null;
 }
 /**
  *
@@ -4975,6 +5117,18 @@ export interface User {
     'tags': {
         [key: string]: string;
     };
+    /**
+     * Name of the [User](#schema_user)
+     * @type {string}
+     * @memberof User
+     */
+    'name'?: string;
+    /**
+     * Picture URL of the [User](#schema_user)
+     * @type {string}
+     * @memberof User
+     */
+    'pictureUrl'?: string;
 }
 /**
  *
@@ -5507,10 +5661,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
      * @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
      * @param {string} [type] Filter by event type
+     * @param {string} [conversationId] Filter by conversation id
+     * @param {string} [userId] Filter by user id
+     * @param {string} [messageId] Filter by message id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List Files
      * @param {string} botId Bot ID
@@ -6117,10 +6274,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
      * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
      * @param {string} [type] Filter by event type
+     * @param {string} [conversationId] Filter by conversation id
+     * @param {string} [userId] Filter by user id
+     * @param {string} [messageId] Filter by message id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
+    listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
     /**
      * List Files
      * @param {string} botId Bot ID
@@ -7723,6 +7883,24 @@ export interface DefaultApiListEventsRequest {
      * @memberof DefaultApiListEvents
      */
     readonly type?: string;
+    /**
+     * Filter by conversation id
+     * @type {string}
+     * @memberof DefaultApiListEvents
+     */
+    readonly conversationId?: string;
+    /**
+     * Filter by user id
+     * @type {string}
+     * @memberof DefaultApiListEvents
+     */
+    readonly userId?: string;
+    /**
+     * Filter by message id
+     * @type {string}
+     * @memberof DefaultApiListEvents
+     */
+    readonly messageId?: string;
 }
 /**
  * Request parameters for listFiles operation in DefaultApi.

package/dist/gen/base.d.ts

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

package/dist/gen/common.d.ts

@@ -3,7 +3,7 @@
  * Botpress API
  * API for Botpress Cloud
  *
- * The version of the OpenAPI document: 0.12.1
+ * The version of the OpenAPI document: 0.12.6
  *
  *
  * 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.12.1
+ * The version of the OpenAPI document: 0.12.6
  *
  *
  * 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.12.1
+ * The version of the OpenAPI document: 0.12.6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).