@botpress/client 0.6.2 → 0.6.3

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.
package/dist/gen/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.12.1
5
+ * The version of the OpenAPI document: 0.12.5
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -229,6 +229,12 @@ export interface BotIntegrationsValue {
229
229
  * @memberof BotIntegrationsValue
230
230
  */
231
231
  'webhookId': string;
232
+ /**
233
+ *
234
+ * @type {string}
235
+ * @memberof BotIntegrationsValue
236
+ */
237
+ 'identifier'?: string;
232
238
  /**
233
239
  *
234
240
  * @type {{ [key: string]: any; }}
@@ -950,6 +956,24 @@ export interface CreateEventBody {
950
956
  * @memberof CreateEventBody
951
957
  */
952
958
  'schedule'?: CreateEventBodySchedule;
959
+ /**
960
+ * ID of the [Conversation](#schema_conversation) to link the event to.
961
+ * @type {string}
962
+ * @memberof CreateEventBody
963
+ */
964
+ 'conversationId'?: string;
965
+ /**
966
+ * ID of the [User](#schema_user) to link the event to.
967
+ * @type {string}
968
+ * @memberof CreateEventBody
969
+ */
970
+ 'userId'?: string;
971
+ /**
972
+ * ID of the [Message](#schema_message) to link the event to.
973
+ * @type {string}
974
+ * @memberof CreateEventBody
975
+ */
976
+ 'messageId'?: string;
953
977
  }
954
978
  /**
955
979
  * Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
@@ -1572,6 +1596,18 @@ export interface CreateUserBody {
1572
1596
  * @memberof CreateUserBody
1573
1597
  */
1574
1598
  'integrationName'?: string;
1599
+ /**
1600
+ * Name of the user
1601
+ * @type {string}
1602
+ * @memberof CreateUserBody
1603
+ */
1604
+ 'name'?: string;
1605
+ /**
1606
+ * URL of the user picture
1607
+ * @type {string}
1608
+ * @memberof CreateUserBody
1609
+ */
1610
+ 'pictureUrl'?: string;
1575
1611
  }
1576
1612
  /**
1577
1613
  *
@@ -1777,6 +1813,24 @@ export interface Event {
1777
1813
  'payload': {
1778
1814
  [key: string]: any;
1779
1815
  };
1816
+ /**
1817
+ * ID of the [Conversation](#schema_conversation) to link the event to.
1818
+ * @type {string}
1819
+ * @memberof Event
1820
+ */
1821
+ 'conversationId'?: string;
1822
+ /**
1823
+ * ID of the [User](#schema_user) to link the event to.
1824
+ * @type {string}
1825
+ * @memberof Event
1826
+ */
1827
+ 'userId'?: string;
1828
+ /**
1829
+ * ID of the [Message](#schema_message) to link the event to.
1830
+ * @type {string}
1831
+ * @memberof Event
1832
+ */
1833
+ 'messageId'?: string;
1780
1834
  }
1781
1835
  /**
1782
1836
  *
@@ -2275,6 +2329,18 @@ export interface GetOrCreateUserBody {
2275
2329
  * @memberof GetOrCreateUserBody
2276
2330
  */
2277
2331
  'integrationName'?: string;
2332
+ /**
2333
+ * Name of the user
2334
+ * @type {string}
2335
+ * @memberof GetOrCreateUserBody
2336
+ */
2337
+ 'name'?: string;
2338
+ /**
2339
+ * URL of the user picture
2340
+ * @type {string}
2341
+ * @memberof GetOrCreateUserBody
2342
+ */
2343
+ 'pictureUrl'?: string;
2278
2344
  }
2279
2345
  /**
2280
2346
  *
@@ -2936,10 +3002,12 @@ export interface Issue {
2936
3002
  'description': string;
2937
3003
  /**
2938
3004
  *
2939
- * @type {object}
3005
+ * @type {{ [key: string]: IssueGroupedDataValue; }}
2940
3006
  * @memberof Issue
2941
3007
  */
2942
- 'groupedData': object;
3008
+ 'groupedData': {
3009
+ [key: string]: IssueGroupedDataValue;
3010
+ };
2943
3011
  /**
2944
3012
  *
2945
3013
  * @type {number}
@@ -2986,10 +3054,31 @@ export interface IssueEvent {
2986
3054
  'createdAt': string;
2987
3055
  /**
2988
3056
  *
2989
- * @type {object}
3057
+ * @type {{ [key: string]: IssueGroupedDataValue; }}
2990
3058
  * @memberof IssueEvent
2991
3059
  */
2992
- 'data': object;
3060
+ 'data': {
3061
+ [key: string]: IssueGroupedDataValue;
3062
+ };
3063
+ }
3064
+ /**
3065
+ *
3066
+ * @export
3067
+ * @interface IssueGroupedDataValue
3068
+ */
3069
+ export interface IssueGroupedDataValue {
3070
+ /**
3071
+ *
3072
+ * @type {string}
3073
+ * @memberof IssueGroupedDataValue
3074
+ */
3075
+ 'raw': string;
3076
+ /**
3077
+ *
3078
+ * @type {string}
3079
+ * @memberof IssueGroupedDataValue
3080
+ */
3081
+ 'pretty'?: string;
2993
3082
  }
2994
3083
  /**
2995
3084
  *
@@ -3024,10 +3113,12 @@ export interface ListBotIssueEventsResponseIssueEventsInner {
3024
3113
  'createdAt': string;
3025
3114
  /**
3026
3115
  *
3027
- * @type {object}
3116
+ * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
3028
3117
  * @memberof ListBotIssueEventsResponseIssueEventsInner
3029
3118
  */
3030
- 'data': object;
3119
+ 'data': {
3120
+ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
3121
+ };
3031
3122
  }
3032
3123
  /**
3033
3124
  *
@@ -3092,10 +3183,12 @@ export interface ListBotIssuesResponseIssuesInner {
3092
3183
  'description': string;
3093
3184
  /**
3094
3185
  *
3095
- * @type {object}
3186
+ * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
3096
3187
  * @memberof ListBotIssuesResponseIssuesInner
3097
3188
  */
3098
- 'groupedData': object;
3189
+ 'groupedData': {
3190
+ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
3191
+ };
3099
3192
  /**
3100
3193
  *
3101
3194
  * @type {number}
@@ -3122,6 +3215,25 @@ export declare const ListBotIssuesResponseIssuesInnerCategoryEnum: {
3122
3215
  readonly Other: "other";
3123
3216
  };
3124
3217
  export type ListBotIssuesResponseIssuesInnerCategoryEnum = typeof ListBotIssuesResponseIssuesInnerCategoryEnum[keyof typeof ListBotIssuesResponseIssuesInnerCategoryEnum];
3218
+ /**
3219
+ *
3220
+ * @export
3221
+ * @interface ListBotIssuesResponseIssuesInnerGroupedDataValue
3222
+ */
3223
+ export interface ListBotIssuesResponseIssuesInnerGroupedDataValue {
3224
+ /**
3225
+ *
3226
+ * @type {string}
3227
+ * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
3228
+ */
3229
+ 'raw': string;
3230
+ /**
3231
+ *
3232
+ * @type {string}
3233
+ * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
3234
+ */
3235
+ 'pretty'?: string;
3236
+ }
3125
3237
  /**
3126
3238
  *
3127
3239
  * @export
@@ -4641,6 +4753,18 @@ export interface UpdateUserBody {
4641
4753
  'tags': {
4642
4754
  [key: string]: string;
4643
4755
  };
4756
+ /**
4757
+ * Name of the user
4758
+ * @type {string}
4759
+ * @memberof UpdateUserBody
4760
+ */
4761
+ 'name'?: string | null;
4762
+ /**
4763
+ * URL of the user picture
4764
+ * @type {string}
4765
+ * @memberof UpdateUserBody
4766
+ */
4767
+ 'pictureUrl'?: string | null;
4644
4768
  }
4645
4769
  /**
4646
4770
  *
@@ -4975,6 +5099,18 @@ export interface User {
4975
5099
  'tags': {
4976
5100
  [key: string]: string;
4977
5101
  };
5102
+ /**
5103
+ * Name of the [User](#schema_user)
5104
+ * @type {string}
5105
+ * @memberof User
5106
+ */
5107
+ 'name'?: string;
5108
+ /**
5109
+ * Picture URL of the [User](#schema_user)
5110
+ * @type {string}
5111
+ * @memberof User
5112
+ */
5113
+ 'pictureUrl'?: string;
4978
5114
  }
4979
5115
  /**
4980
5116
  *
@@ -5507,10 +5643,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
5507
5643
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
5508
5644
  * @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
5509
5645
  * @param {string} [type] Filter by event type
5646
+ * @param {string} [conversationId] Filter by conversation id
5647
+ * @param {string} [userId] Filter by user id
5648
+ * @param {string} [messageId] Filter by message id
5510
5649
  * @param {*} [options] Override http request option.
5511
5650
  * @throws {RequiredError}
5512
5651
  */
5513
- listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5652
+ listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5514
5653
  /**
5515
5654
  * List Files
5516
5655
  * @param {string} botId Bot ID
@@ -6117,10 +6256,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
6117
6256
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
6118
6257
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
6119
6258
  * @param {string} [type] Filter by event type
6259
+ * @param {string} [conversationId] Filter by conversation id
6260
+ * @param {string} [userId] Filter by user id
6261
+ * @param {string} [messageId] Filter by message id
6120
6262
  * @param {*} [options] Override http request option.
6121
6263
  * @throws {RequiredError}
6122
6264
  */
6123
- listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
6265
+ listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
6124
6266
  /**
6125
6267
  * List Files
6126
6268
  * @param {string} botId Bot ID
@@ -7723,6 +7865,24 @@ export interface DefaultApiListEventsRequest {
7723
7865
  * @memberof DefaultApiListEvents
7724
7866
  */
7725
7867
  readonly type?: string;
7868
+ /**
7869
+ * Filter by conversation id
7870
+ * @type {string}
7871
+ * @memberof DefaultApiListEvents
7872
+ */
7873
+ readonly conversationId?: string;
7874
+ /**
7875
+ * Filter by user id
7876
+ * @type {string}
7877
+ * @memberof DefaultApiListEvents
7878
+ */
7879
+ readonly userId?: string;
7880
+ /**
7881
+ * Filter by message id
7882
+ * @type {string}
7883
+ * @memberof DefaultApiListEvents
7884
+ */
7885
+ readonly messageId?: string;
7726
7886
  }
7727
7887
  /**
7728
7888
  * Request parameters for listFiles operation in DefaultApi.
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.12.1
5
+ * The version of the OpenAPI document: 0.12.5
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Botpress API
4
4
  * API for Botpress Cloud
5
5
  *
6
- * The version of the OpenAPI document: 0.12.1
6
+ * The version of the OpenAPI document: 0.12.5
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.12.1
5
+ * The version of the OpenAPI document: 0.12.5
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.12.1
5
+ * The version of the OpenAPI document: 0.12.5
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).