@botpress/webchat 1.2.0 → 1.3.0

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.
Files changed (64) hide show
  1. package/dist/client/MessagingClient/client.d.ts +7 -4
  2. package/dist/client/PushpinClient/index.d.ts +4 -2
  3. package/dist/client/PushpinClient/inner-client/index.d.ts +2 -0
  4. package/dist/client/types.d.ts +4 -1
  5. package/dist/components/Avatar.d.ts +2 -3
  6. package/dist/components/Block.d.ts +3 -2
  7. package/dist/components/CloseWindow.d.ts +5 -0
  8. package/dist/components/Composer.d.ts +1 -1
  9. package/dist/components/renderers/Audio.d.ts +1 -1
  10. package/dist/components/renderers/Carousel.d.ts +1 -1
  11. package/dist/components/renderers/File.d.ts +1 -1
  12. package/dist/components/renderers/Image.d.ts +1 -1
  13. package/dist/components/renderers/Location.d.ts +1 -1
  14. package/dist/components/renderers/Video.d.ts +1 -1
  15. package/dist/contexts/WebchatContext.d.ts +3 -3
  16. package/dist/gen/client/api.d.ts +330 -12
  17. package/dist/gen/client/client.d.ts +5 -1
  18. package/dist/gen/client/errors.d.ts +9 -2
  19. package/dist/gen/models/index.d.ts +186 -23
  20. package/dist/gen/models/message.j.d.ts +107 -5
  21. package/dist/gen/models/message.t.d.ts +49 -0
  22. package/dist/gen/models/message.z.d.ts +79 -12
  23. package/dist/gen/models/user.j.d.ts +0 -3
  24. package/dist/gen/models/user.t.d.ts +0 -1
  25. package/dist/gen/models/user.z.d.ts +0 -3
  26. package/dist/gen/signals/index.d.ts +218 -23
  27. package/dist/gen/signals/messageCreatedSignal.j.d.ts +107 -5
  28. package/dist/gen/signals/messageCreatedSignal.t.d.ts +49 -0
  29. package/dist/gen/signals/messageCreatedSignal.z.d.ts +111 -18
  30. package/dist/get-client.d.ts +8 -0
  31. package/dist/hooks/useClient.d.ts +2 -2
  32. package/dist/hooks/useWebchatStore.d.ts +3 -0
  33. package/dist/index.d.ts +3 -4
  34. package/dist/index.js +33089 -40901
  35. package/dist/index.umd.cjs +96 -125
  36. package/dist/providers/WebchatProvider.d.ts +4 -3
  37. package/dist/schemas/configuration.d.ts +117 -0
  38. package/dist/schemas/index.d.ts +2 -0
  39. package/dist/schemas/init.d.ts +3844 -0
  40. package/dist/schemas/theme.d.ts +231 -232
  41. package/dist/types/block-type.d.ts +3 -6
  42. package/dist/types/configuration.d.ts +4 -16
  43. package/dist/types/index.d.ts +2 -0
  44. package/dist/types/init.d.ts +6 -0
  45. package/dist/types/theme.d.ts +7 -0
  46. package/dist/utils/index.d.ts +0 -2
  47. package/package.json +11 -37
  48. package/dist/App.d.ts +0 -11
  49. package/dist/components/dev-tools/DevTools.d.ts +0 -1
  50. package/dist/components/dev-tools/configuration.d.ts +0 -2
  51. package/dist/components/dev-tools/helpers.d.ts +0 -5
  52. package/dist/main.d.ts +0 -0
  53. package/dist/options.d.ts +0 -11
  54. package/dist/themes/base.d.ts +0 -3
  55. package/dist/themes/baseColors.d.ts +0 -736
  56. package/dist/themes/dawn.d.ts +0 -4
  57. package/dist/themes/eggplant.d.ts +0 -4
  58. package/dist/themes/index.d.ts +0 -3
  59. package/dist/themes/prism.d.ts +0 -4
  60. package/dist/themes/themeBuilder.d.ts +0 -27
  61. package/dist/twind.config.d.ts +0 -9
  62. package/dist/twind.d.ts +0 -16
  63. package/dist/utils/mergeThemes.d.ts +0 -2
  64. package/dist/utils/withBaseTheme.d.ts +0 -384
@@ -90,6 +90,92 @@ export interface CreateConversationResponse {
90
90
  */
91
91
  'conversation': Conversation;
92
92
  }
93
+ /**
94
+ *
95
+ * @export
96
+ * @interface CreateEventBody
97
+ */
98
+ export interface CreateEventBody {
99
+ /**
100
+ *
101
+ * @type {CreateEventBodyPayload}
102
+ * @memberof CreateEventBody
103
+ */
104
+ 'payload': CreateEventBodyPayload;
105
+ /**
106
+ * ID of the [Conversation](#schema_conversation)
107
+ * @type {string}
108
+ * @memberof CreateEventBody
109
+ */
110
+ 'conversationId': string;
111
+ }
112
+ /**
113
+ * @type CreateEventBodyPayload
114
+ * Payload is the content type of the event.
115
+ * @export
116
+ */
117
+ export type CreateEventBodyPayload = CreateEventBodyPayloadOneOf | CreateEventBodyPayloadOneOf1;
118
+ /**
119
+ *
120
+ * @export
121
+ * @interface CreateEventBodyPayloadOneOf
122
+ */
123
+ export interface CreateEventBodyPayloadOneOf {
124
+ /**
125
+ *
126
+ * @type {string}
127
+ * @memberof CreateEventBodyPayloadOneOf
128
+ */
129
+ 'type': CreateEventBodyPayloadOneOfTypeEnum;
130
+ /**
131
+ *
132
+ * @type {{ [key: string]: any | null; }}
133
+ * @memberof CreateEventBodyPayloadOneOf
134
+ */
135
+ 'data': {
136
+ [key: string]: any | null;
137
+ };
138
+ }
139
+ export declare const CreateEventBodyPayloadOneOfTypeEnum: {
140
+ readonly Custom: "custom";
141
+ };
142
+ export type CreateEventBodyPayloadOneOfTypeEnum = typeof CreateEventBodyPayloadOneOfTypeEnum[keyof typeof CreateEventBodyPayloadOneOfTypeEnum];
143
+ /**
144
+ *
145
+ * @export
146
+ * @interface CreateEventBodyPayloadOneOf1
147
+ */
148
+ export interface CreateEventBodyPayloadOneOf1 {
149
+ /**
150
+ *
151
+ * @type {string}
152
+ * @memberof CreateEventBodyPayloadOneOf1
153
+ */
154
+ 'type': CreateEventBodyPayloadOneOf1TypeEnum;
155
+ /**
156
+ *
157
+ * @type {object}
158
+ * @memberof CreateEventBodyPayloadOneOf1
159
+ */
160
+ 'data': object;
161
+ }
162
+ export declare const CreateEventBodyPayloadOneOf1TypeEnum: {
163
+ readonly ConversationStarted: "conversation_started";
164
+ };
165
+ export type CreateEventBodyPayloadOneOf1TypeEnum = typeof CreateEventBodyPayloadOneOf1TypeEnum[keyof typeof CreateEventBodyPayloadOneOf1TypeEnum];
166
+ /**
167
+ *
168
+ * @export
169
+ * @interface CreateEventResponse
170
+ */
171
+ export interface CreateEventResponse {
172
+ /**
173
+ *
174
+ * @type {Event}
175
+ * @memberof CreateEventResponse
176
+ */
177
+ 'event': Event;
178
+ }
93
179
  /**
94
180
  *
95
181
  * @export
@@ -127,6 +213,12 @@ export interface CreateMessageBodyPayloadOneOf {
127
213
  * @memberof CreateMessageBodyPayloadOneOf
128
214
  */
129
215
  'audioUrl': string;
216
+ /**
217
+ * CSS className to apply to the message
218
+ * @type {string}
219
+ * @memberof CreateMessageBodyPayloadOneOf
220
+ */
221
+ 'className'?: string;
130
222
  /**
131
223
  *
132
224
  * @type {string}
@@ -174,6 +266,12 @@ export interface CreateMessageBodyPayloadOneOf1 {
174
266
  * @memberof CreateMessageBodyPayloadOneOf1
175
267
  */
176
268
  'type': CreateMessageBodyPayloadOneOf1TypeEnum;
269
+ /**
270
+ * CSS className to apply to the message
271
+ * @type {string}
272
+ * @memberof CreateMessageBodyPayloadOneOf1
273
+ */
274
+ 'className'?: string;
177
275
  }
178
276
  export declare const CreateMessageBodyPayloadOneOf1TypeEnum: {
179
277
  readonly Card: "card";
@@ -191,6 +289,12 @@ export interface CreateMessageBodyPayloadOneOf10 {
191
289
  * @memberof CreateMessageBodyPayloadOneOf10
192
290
  */
193
291
  'videoUrl': string;
292
+ /**
293
+ * CSS className to apply to the message
294
+ * @type {string}
295
+ * @memberof CreateMessageBodyPayloadOneOf10
296
+ */
297
+ 'className'?: string;
194
298
  /**
195
299
  *
196
300
  * @type {string}
@@ -245,6 +349,12 @@ export interface CreateMessageBodyPayloadOneOf2 {
245
349
  * @memberof CreateMessageBodyPayloadOneOf2
246
350
  */
247
351
  'items': Array<CreateMessageBodyPayloadOneOf2ItemsInner>;
352
+ /**
353
+ * CSS className to apply to the message
354
+ * @type {string}
355
+ * @memberof CreateMessageBodyPayloadOneOf2
356
+ */
357
+ 'className'?: string;
248
358
  /**
249
359
  *
250
360
  * @type {string}
@@ -286,6 +396,12 @@ export interface CreateMessageBodyPayloadOneOf2ItemsInner {
286
396
  * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
287
397
  */
288
398
  'actions': Array<CreateMessageBodyPayloadOneOf1ActionsInner>;
399
+ /**
400
+ * CSS className to apply to the message
401
+ * @type {string}
402
+ * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
403
+ */
404
+ 'className'?: string;
289
405
  }
290
406
  /**
291
407
  *
@@ -305,12 +421,24 @@ export interface CreateMessageBodyPayloadOneOf3 {
305
421
  * @memberof CreateMessageBodyPayloadOneOf3
306
422
  */
307
423
  'options': Array<CreateMessageBodyPayloadOneOf3OptionsInner>;
424
+ /**
425
+ * CSS className to apply to the message
426
+ * @type {string}
427
+ * @memberof CreateMessageBodyPayloadOneOf3
428
+ */
429
+ 'className'?: string;
308
430
  /**
309
431
  *
310
432
  * @type {string}
311
433
  * @memberof CreateMessageBodyPayloadOneOf3
312
434
  */
313
435
  'type': CreateMessageBodyPayloadOneOf3TypeEnum;
436
+ /**
437
+ *
438
+ * @type {boolean}
439
+ * @memberof CreateMessageBodyPayloadOneOf3
440
+ */
441
+ 'disableFreeText'?: boolean;
314
442
  }
315
443
  export declare const CreateMessageBodyPayloadOneOf3TypeEnum: {
316
444
  readonly Choice: "choice";
@@ -353,6 +481,12 @@ export interface CreateMessageBodyPayloadOneOf4 {
353
481
  * @memberof CreateMessageBodyPayloadOneOf4
354
482
  */
355
483
  'options': Array<CreateMessageBodyPayloadOneOf3OptionsInner>;
484
+ /**
485
+ * CSS className to apply to the message
486
+ * @type {string}
487
+ * @memberof CreateMessageBodyPayloadOneOf4
488
+ */
489
+ 'className'?: string;
356
490
  /**
357
491
  *
358
492
  * @type {string}
@@ -382,6 +516,12 @@ export interface CreateMessageBodyPayloadOneOf5 {
382
516
  * @memberof CreateMessageBodyPayloadOneOf5
383
517
  */
384
518
  'title'?: string;
519
+ /**
520
+ * CSS className to apply to the message
521
+ * @type {string}
522
+ * @memberof CreateMessageBodyPayloadOneOf5
523
+ */
524
+ 'className'?: string;
385
525
  /**
386
526
  *
387
527
  * @type {string}
@@ -405,6 +545,12 @@ export interface CreateMessageBodyPayloadOneOf6 {
405
545
  * @memberof CreateMessageBodyPayloadOneOf6
406
546
  */
407
547
  'imageUrl': string;
548
+ /**
549
+ * CSS className to apply to the message
550
+ * @type {string}
551
+ * @memberof CreateMessageBodyPayloadOneOf6
552
+ */
553
+ 'className'?: string;
408
554
  /**
409
555
  *
410
556
  * @type {string}
@@ -446,6 +592,12 @@ export interface CreateMessageBodyPayloadOneOf7 {
446
592
  * @memberof CreateMessageBodyPayloadOneOf7
447
593
  */
448
594
  'title'?: string;
595
+ /**
596
+ * CSS className to apply to the message
597
+ * @type {string}
598
+ * @memberof CreateMessageBodyPayloadOneOf7
599
+ */
600
+ 'className'?: string;
449
601
  /**
450
602
  *
451
603
  * @type {string}
@@ -469,6 +621,12 @@ export interface CreateMessageBodyPayloadOneOf8 {
469
621
  * @memberof CreateMessageBodyPayloadOneOf8
470
622
  */
471
623
  'markdown': string;
624
+ /**
625
+ * CSS className to apply to the message
626
+ * @type {string}
627
+ * @memberof CreateMessageBodyPayloadOneOf8
628
+ */
629
+ 'className'?: string;
472
630
  /**
473
631
  *
474
632
  * @type {string}
@@ -492,6 +650,12 @@ export interface CreateMessageBodyPayloadOneOf9 {
492
650
  * @memberof CreateMessageBodyPayloadOneOf9
493
651
  */
494
652
  'text': string;
653
+ /**
654
+ * CSS className to apply to the message
655
+ * @type {string}
656
+ * @memberof CreateMessageBodyPayloadOneOf9
657
+ */
658
+ 'className'?: string;
495
659
  /**
496
660
  *
497
661
  * @type {string}
@@ -535,11 +699,13 @@ export interface CreateUserBody {
535
699
  */
536
700
  'pictureUrl'?: string;
537
701
  /**
538
- * Custom profile data of the [User](#schema_user) encoded as a string
539
- * @type {string}
702
+ * User data
703
+ * @type {{ [key: string]: any; }}
540
704
  * @memberof CreateUserBody
541
705
  */
542
- 'profile'?: string;
706
+ 'userData'?: {
707
+ [key: string]: any;
708
+ };
543
709
  }
544
710
  /**
545
711
  *
@@ -560,6 +726,49 @@ export interface CreateUserResponse {
560
726
  */
561
727
  'key': string;
562
728
  }
729
+ /**
730
+ *
731
+ * @export
732
+ * @interface Event
733
+ */
734
+ export interface Event {
735
+ /**
736
+ * ID of the [Event](#schema_event).
737
+ * @type {string}
738
+ * @memberof Event
739
+ */
740
+ 'id': string;
741
+ /**
742
+ * Creation date of the [Event](#schema_event) in ISO 8601 format
743
+ * @type {string}
744
+ * @memberof Event
745
+ */
746
+ 'createdAt': string;
747
+ /**
748
+ *
749
+ * @type {EventPayload}
750
+ * @memberof Event
751
+ */
752
+ 'payload': EventPayload;
753
+ /**
754
+ * ID of the [Conversation](#schema_conversation).
755
+ * @type {string}
756
+ * @memberof Event
757
+ */
758
+ 'conversationId': string;
759
+ /**
760
+ * ID of the [User](#schema_user).
761
+ * @type {string}
762
+ * @memberof Event
763
+ */
764
+ 'userId': string;
765
+ }
766
+ /**
767
+ * @type EventPayload
768
+ * Payload is the content of the event.
769
+ * @export
770
+ */
771
+ export type EventPayload = CreateEventBodyPayloadOneOf | CreateEventBodyPayloadOneOf1;
563
772
  /**
564
773
  *
565
774
  * @export
@@ -573,6 +782,19 @@ export interface GetConversationResponse {
573
782
  */
574
783
  'conversation': Conversation;
575
784
  }
785
+ /**
786
+ *
787
+ * @export
788
+ * @interface GetEventResponse
789
+ */
790
+ export interface GetEventResponse {
791
+ /**
792
+ *
793
+ * @type {Event}
794
+ * @memberof GetEventResponse
795
+ */
796
+ 'event': Event;
797
+ }
576
798
  /**
577
799
  *
578
800
  * @export
@@ -738,11 +960,13 @@ export interface UpdateUserBody {
738
960
  */
739
961
  'pictureUrl'?: string;
740
962
  /**
741
- * Custom profile data of the [User](#schema_user) encoded as a string
742
- * @type {string}
963
+ * User data
964
+ * @type {{ [key: string]: any; }}
743
965
  * @memberof UpdateUserBody
744
966
  */
745
- 'profile'?: string;
967
+ 'userData'?: {
968
+ [key: string]: any;
969
+ };
746
970
  }
747
971
  /**
748
972
  *
@@ -775,12 +999,6 @@ export interface User {
775
999
  * @memberof User
776
1000
  */
777
1001
  'pictureUrl'?: string;
778
- /**
779
- * Custom profile data of the [User](#schema_user) encoded as a string
780
- * @type {string}
781
- * @memberof User
782
- */
783
- 'profile'?: string;
784
1002
  /**
785
1003
  * Id of the [User](#schema_user)
786
1004
  * @type {string}
@@ -822,6 +1040,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
822
1040
  * @throws {RequiredError}
823
1041
  */
824
1042
  createConversation: (xUserKey: string, createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1043
+ /**
1044
+ * Creates a new [Event](#schema_event)
1045
+ * @param {string} xUserKey Authentication Key
1046
+ * @param {CreateEventBody} [createEventBody] Event data
1047
+ * @param {*} [options] Override http request option.
1048
+ * @throws {RequiredError}
1049
+ */
1050
+ createEvent: (xUserKey: string, createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
825
1051
  /**
826
1052
  * Creates a new [Message](#schema_message)
827
1053
  * @param {string} xUserKey Authentication Key
@@ -868,6 +1094,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
868
1094
  * @throws {RequiredError}
869
1095
  */
870
1096
  getConversation: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1097
+ /**
1098
+ * Retrieves the [Event](#schema_event) object for a valid identifier.
1099
+ * @param {string} xUserKey Authentication Key
1100
+ * @param {string} id Id of the Event
1101
+ * @param {*} [options] Override http request option.
1102
+ * @throws {RequiredError}
1103
+ */
1104
+ getEvent: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
871
1105
  /**
872
1106
  * Retrieves the [Message](#schema_message) object for a valid identifier.
873
1107
  * @param {string} xUserKey Authentication Key
@@ -966,6 +1200,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
966
1200
  * @throws {RequiredError}
967
1201
  */
968
1202
  createConversation(xUserKey: string, createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConversationResponse>>;
1203
+ /**
1204
+ * Creates a new [Event](#schema_event)
1205
+ * @param {string} xUserKey Authentication Key
1206
+ * @param {CreateEventBody} [createEventBody] Event data
1207
+ * @param {*} [options] Override http request option.
1208
+ * @throws {RequiredError}
1209
+ */
1210
+ createEvent(xUserKey: string, createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
969
1211
  /**
970
1212
  * Creates a new [Message](#schema_message)
971
1213
  * @param {string} xUserKey Authentication Key
@@ -1012,6 +1254,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1012
1254
  * @throws {RequiredError}
1013
1255
  */
1014
1256
  getConversation(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationResponse>>;
1257
+ /**
1258
+ * Retrieves the [Event](#schema_event) object for a valid identifier.
1259
+ * @param {string} xUserKey Authentication Key
1260
+ * @param {string} id Id of the Event
1261
+ * @param {*} [options] Override http request option.
1262
+ * @throws {RequiredError}
1263
+ */
1264
+ getEvent(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
1015
1265
  /**
1016
1266
  * Retrieves the [Message](#schema_message) object for a valid identifier.
1017
1267
  * @param {string} xUserKey Authentication Key
@@ -1107,6 +1357,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1107
1357
  * @throws {RequiredError}
1108
1358
  */
1109
1359
  createConversation(requestParameters: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
1360
+ /**
1361
+ * Creates a new [Event](#schema_event)
1362
+ * @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
1363
+ * @param {*} [options] Override http request option.
1364
+ * @throws {RequiredError}
1365
+ */
1366
+ createEvent(requestParameters: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
1110
1367
  /**
1111
1368
  * Creates a new [Message](#schema_message)
1112
1369
  * @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
@@ -1149,6 +1406,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1149
1406
  * @throws {RequiredError}
1150
1407
  */
1151
1408
  getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
1409
+ /**
1410
+ * Retrieves the [Event](#schema_event) object for a valid identifier.
1411
+ * @param {DefaultApiGetEventRequest} requestParameters Request parameters.
1412
+ * @param {*} [options] Override http request option.
1413
+ * @throws {RequiredError}
1414
+ */
1415
+ getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
1152
1416
  /**
1153
1417
  * Retrieves the [Message](#schema_message) object for a valid identifier.
1154
1418
  * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
@@ -1257,6 +1521,25 @@ export interface DefaultApiCreateConversationRequest {
1257
1521
  */
1258
1522
  readonly createConversationBody?: CreateConversationBody;
1259
1523
  }
1524
+ /**
1525
+ * Request parameters for createEvent operation in DefaultApi.
1526
+ * @export
1527
+ * @interface DefaultApiCreateEventRequest
1528
+ */
1529
+ export interface DefaultApiCreateEventRequest {
1530
+ /**
1531
+ * Authentication Key
1532
+ * @type {string}
1533
+ * @memberof DefaultApiCreateEvent
1534
+ */
1535
+ readonly xUserKey: string;
1536
+ /**
1537
+ * Event data
1538
+ * @type {CreateEventBody}
1539
+ * @memberof DefaultApiCreateEvent
1540
+ */
1541
+ readonly createEventBody?: CreateEventBody;
1542
+ }
1260
1543
  /**
1261
1544
  * Request parameters for createMessage operation in DefaultApi.
1262
1545
  * @export
@@ -1359,6 +1642,25 @@ export interface DefaultApiGetConversationRequest {
1359
1642
  */
1360
1643
  readonly id: string;
1361
1644
  }
1645
+ /**
1646
+ * Request parameters for getEvent operation in DefaultApi.
1647
+ * @export
1648
+ * @interface DefaultApiGetEventRequest
1649
+ */
1650
+ export interface DefaultApiGetEventRequest {
1651
+ /**
1652
+ * Authentication Key
1653
+ * @type {string}
1654
+ * @memberof DefaultApiGetEvent
1655
+ */
1656
+ readonly xUserKey: string;
1657
+ /**
1658
+ * Id of the Event
1659
+ * @type {string}
1660
+ * @memberof DefaultApiGetEvent
1661
+ */
1662
+ readonly id: string;
1663
+ }
1362
1664
  /**
1363
1665
  * Request parameters for getMessage operation in DefaultApi.
1364
1666
  * @export
@@ -1571,6 +1873,14 @@ export declare class DefaultApi extends BaseAPI {
1571
1873
  * @memberof DefaultApi
1572
1874
  */
1573
1875
  createConversation(requestParameters: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConversationResponse, any>>;
1876
+ /**
1877
+ * Creates a new [Event](#schema_event)
1878
+ * @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
1879
+ * @param {*} [options] Override http request option.
1880
+ * @throws {RequiredError}
1881
+ * @memberof DefaultApi
1882
+ */
1883
+ createEvent(requestParameters: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventResponse, any>>;
1574
1884
  /**
1575
1885
  * Creates a new [Message](#schema_message)
1576
1886
  * @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
@@ -1619,6 +1929,14 @@ export declare class DefaultApi extends BaseAPI {
1619
1929
  * @memberof DefaultApi
1620
1930
  */
1621
1931
  getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetConversationResponse, any>>;
1932
+ /**
1933
+ * Retrieves the [Event](#schema_event) object for a valid identifier.
1934
+ * @param {DefaultApiGetEventRequest} requestParameters Request parameters.
1935
+ * @param {*} [options] Override http request option.
1936
+ * @throws {RequiredError}
1937
+ * @memberof DefaultApi
1938
+ */
1939
+ getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
1622
1940
  /**
1623
1941
  * Retrieves the [Message](#schema_message) object for a valid identifier.
1624
1942
  * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
@@ -1,5 +1,5 @@
1
1
  import { AxiosInstance } from 'axios';
2
- import { Configuration, DefaultApiGetConversationRequest, DefaultApiCreateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiListConversationsRequest, DefaultApiListenConversationRequest, DefaultApiListConversationMessagesRequest, DefaultApiAddParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiListParticipantsRequest, DefaultApiGetMessageRequest, DefaultApiCreateMessageRequest, DefaultApiDeleteMessageRequest, DefaultApiGetUserRequest, DefaultApiCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest } from '.';
2
+ import { Configuration, DefaultApiGetConversationRequest, DefaultApiCreateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiListConversationsRequest, DefaultApiListenConversationRequest, DefaultApiListConversationMessagesRequest, DefaultApiAddParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiListParticipantsRequest, DefaultApiGetMessageRequest, DefaultApiCreateMessageRequest, DefaultApiDeleteMessageRequest, DefaultApiGetUserRequest, DefaultApiCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetEventRequest, DefaultApiCreateEventRequest } from '.';
3
3
  type SimplifyOptions = {
4
4
  deep?: boolean;
5
5
  };
@@ -36,6 +36,8 @@ export declare class ApiClient {
36
36
  createUser: (createUserBody: CreateUserProps) => Promise<import("./api").CreateUserResponse>;
37
37
  updateUser: ({ xUserKey, ...updateUserBody }: UpdateUserProps) => Promise<import("./api").UpdateUserResponse>;
38
38
  deleteUser: (props: DeleteUserProps) => Promise<object>;
39
+ getEvent: (props: GetEventProps) => Promise<import("./api").GetEventResponse>;
40
+ createEvent: ({ xUserKey, ...createEventBody }: CreateEventProps) => Promise<import("./api").CreateEventResponse>;
39
41
  }
40
42
  export type GetConversationProps = Merge<DefaultApiGetConversationRequest, {}>;
41
43
  export type CreateConversationProps = Merge<Except<DefaultApiCreateConversationRequest, 'createConversationBody'>, NonNullable<DefaultApiCreateConversationRequest['createConversationBody']>>;
@@ -54,4 +56,6 @@ export type GetUserProps = Merge<DefaultApiGetUserRequest, {}>;
54
56
  export type CreateUserProps = Merge<Except<DefaultApiCreateUserRequest, 'createUserBody'>, NonNullable<DefaultApiCreateUserRequest['createUserBody']>>;
55
57
  export type UpdateUserProps = Merge<Except<DefaultApiUpdateUserRequest, 'updateUserBody'>, NonNullable<DefaultApiUpdateUserRequest['updateUserBody']>>;
56
58
  export type DeleteUserProps = Merge<DefaultApiDeleteUserRequest, {}>;
59
+ export type GetEventProps = Merge<DefaultApiGetEventRequest, {}>;
60
+ export type CreateEventProps = Merge<Except<DefaultApiCreateEventRequest, 'createEventBody'>, NonNullable<DefaultApiCreateEventRequest['createEventBody']>>;
57
61
  export {};
@@ -191,7 +191,14 @@ type LimitExceededType = 'LimitExceeded';
191
191
  export declare class LimitExceededError extends BaseApiError<413, LimitExceededType, 'The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.'> {
192
192
  constructor(message: string, error?: Error, id?: string);
193
193
  }
194
- export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded';
195
- export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError;
194
+ type BreakingChangesType = 'BreakingChanges';
195
+ /**
196
+ * Request payload contains breaking changes which is not allowed for this resource without a version increment.
197
+ */
198
+ export declare class BreakingChangesError extends BaseApiError<400, BreakingChangesType, 'Request payload contains breaking changes which is not allowed for this resource without a version increment.'> {
199
+ constructor(message: string, error?: Error, id?: string);
200
+ }
201
+ export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
202
+ export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
196
203
  export declare const errorFrom: (err: unknown) => ApiError;
197
204
  export {};