@botpress/client 0.0.13 → 0.1.1

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.2.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -51,6 +51,24 @@ export interface Bot {
51
51
  'integrations': {
52
52
  [key: string]: BotIntegrationsValue;
53
53
  };
54
+ /**
55
+ *
56
+ * @type {BotUser}
57
+ * @memberof Bot
58
+ */
59
+ 'user': BotUser;
60
+ /**
61
+ *
62
+ * @type {BotConversation}
63
+ * @memberof Bot
64
+ */
65
+ 'conversation': BotConversation;
66
+ /**
67
+ *
68
+ * @type {BotMessage}
69
+ * @memberof Bot
70
+ */
71
+ 'message': BotMessage;
54
72
  /**
55
73
  * A mapping of states to their definition
56
74
  * @type {{ [key: string]: CreateBotBodyStatesValue; }}
@@ -59,12 +77,6 @@ export interface Bot {
59
77
  'states': {
60
78
  [key: string]: CreateBotBodyStatesValue;
61
79
  };
62
- /**
63
- *
64
- * @type {CreateBotBodyTags}
65
- * @memberof Bot
66
- */
67
- 'tags': CreateBotBodyTags;
68
80
  /**
69
81
  *
70
82
  * @type {BotConfiguration}
@@ -141,6 +153,21 @@ export interface BotConfiguration {
141
153
  [key: string]: any;
142
154
  };
143
155
  }
156
+ /**
157
+ * Conversation object configuration
158
+ * @export
159
+ * @interface BotConversation
160
+ */
161
+ export interface BotConversation {
162
+ /**
163
+ *
164
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
165
+ * @memberof BotConversation
166
+ */
167
+ 'tags': {
168
+ [key: string]: CreateBotBodyUserTagsValue;
169
+ };
170
+ }
144
171
  /**
145
172
  *
146
173
  * @export
@@ -214,6 +241,36 @@ export interface BotMediasInner {
214
241
  */
215
242
  'name': string;
216
243
  }
244
+ /**
245
+ * Message object configuration
246
+ * @export
247
+ * @interface BotMessage
248
+ */
249
+ export interface BotMessage {
250
+ /**
251
+ *
252
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
253
+ * @memberof BotMessage
254
+ */
255
+ 'tags': {
256
+ [key: string]: CreateBotBodyUserTagsValue;
257
+ };
258
+ }
259
+ /**
260
+ * User object configuration
261
+ * @export
262
+ * @interface BotUser
263
+ */
264
+ export interface BotUser {
265
+ /**
266
+ *
267
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
268
+ * @memberof BotUser
269
+ */
270
+ 'tags': {
271
+ [key: string]: CreateBotBodyUserTagsValue;
272
+ };
273
+ }
217
274
  /**
218
275
  *
219
276
  * @export
@@ -322,12 +379,6 @@ export interface CreateBotBody {
322
379
  'states'?: {
323
380
  [key: string]: CreateBotBodyStatesValue;
324
381
  };
325
- /**
326
- *
327
- * @type {CreateBotBodyTags}
328
- * @memberof CreateBotBody
329
- */
330
- 'tags'?: CreateBotBodyTags;
331
382
  /**
332
383
  * Events definition
333
384
  * @type {{ [key: string]: CreateBotBodyEventsValue; }}
@@ -350,6 +401,24 @@ export interface CreateBotBody {
350
401
  * @memberof CreateBotBody
351
402
  */
352
403
  'configuration'?: CreateBotBodyConfiguration;
404
+ /**
405
+ *
406
+ * @type {CreateBotBodyUser}
407
+ * @memberof CreateBotBody
408
+ */
409
+ 'user'?: CreateBotBodyUser;
410
+ /**
411
+ *
412
+ * @type {CreateBotBodyUser}
413
+ * @memberof CreateBotBody
414
+ */
415
+ 'conversation'?: CreateBotBodyUser;
416
+ /**
417
+ *
418
+ * @type {CreateBotBodyUser}
419
+ * @memberof CreateBotBody
420
+ */
421
+ 'message'?: CreateBotBodyUser;
353
422
  /**
354
423
  * JavaScript code of the bot
355
424
  * @type {string}
@@ -405,7 +474,7 @@ export interface CreateBotBodyConfiguration {
405
474
  };
406
475
  }
407
476
  /**
408
- * Event schema
477
+ * Event Definition
409
478
  * @export
410
479
  * @interface CreateBotBodyEventsValue
411
480
  */
@@ -512,29 +581,38 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
512
581
  };
513
582
  export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
514
583
  /**
515
- * Tags of the bot
584
+ *
516
585
  * @export
517
- * @interface CreateBotBodyTags
586
+ * @interface CreateBotBodyUser
518
587
  */
519
- export interface CreateBotBodyTags {
588
+ export interface CreateBotBodyUser {
520
589
  /**
521
590
  *
522
- * @type {Array<string>}
523
- * @memberof CreateBotBodyTags
591
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
592
+ * @memberof CreateBotBodyUser
524
593
  */
525
- 'messages'?: Array<string>;
594
+ 'tags'?: {
595
+ [key: string]: CreateBotBodyUserTagsValue;
596
+ };
597
+ }
598
+ /**
599
+ * Definition of a tag that can be provided on the object
600
+ * @export
601
+ * @interface CreateBotBodyUserTagsValue
602
+ */
603
+ export interface CreateBotBodyUserTagsValue {
526
604
  /**
527
- *
528
- * @type {Array<string>}
529
- * @memberof CreateBotBodyTags
605
+ * Title of the tag
606
+ * @type {string}
607
+ * @memberof CreateBotBodyUserTagsValue
530
608
  */
531
- 'conversations'?: Array<string>;
609
+ 'title'?: string;
532
610
  /**
533
- *
534
- * @type {Array<string>}
535
- * @memberof CreateBotBodyTags
611
+ * Description of the tag
612
+ * @type {string}
613
+ * @memberof CreateBotBodyUserTagsValue
536
614
  */
537
- 'users'?: Array<string>;
615
+ 'description'?: string;
538
616
  }
539
617
  /**
540
618
  *
@@ -717,20 +795,12 @@ export interface CreateIntegrationBody {
717
795
  'version': string;
718
796
  /**
719
797
  *
720
- * @type {CreateIntegrationBodyTags}
721
- * @memberof CreateIntegrationBody
722
- */
723
- 'tags'?: CreateIntegrationBodyTags;
724
- /**
725
- * Channels definition
726
- * @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
798
+ * @type {CreateIntegrationBodyConfiguration}
727
799
  * @memberof CreateIntegrationBody
728
800
  */
729
- 'channels'?: {
730
- [key: string]: CreateIntegrationBodyChannelsValue;
731
- };
801
+ 'configuration'?: CreateIntegrationBodyConfiguration;
732
802
  /**
733
- * States definition
803
+ *
734
804
  * @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
735
805
  * @memberof CreateIntegrationBody
736
806
  */
@@ -739,12 +809,6 @@ export interface CreateIntegrationBody {
739
809
  };
740
810
  /**
741
811
  *
742
- * @type {CreateIntegrationBodyConfiguration}
743
- * @memberof CreateIntegrationBody
744
- */
745
- 'configuration'?: CreateIntegrationBodyConfiguration;
746
- /**
747
- * Events definition
748
812
  * @type {{ [key: string]: CreateBotBodyEventsValue; }}
749
813
  * @memberof CreateIntegrationBody
750
814
  */
@@ -752,13 +816,21 @@ export interface CreateIntegrationBody {
752
816
  [key: string]: CreateBotBodyEventsValue;
753
817
  };
754
818
  /**
755
- * Action definition
819
+ *
756
820
  * @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
757
821
  * @memberof CreateIntegrationBody
758
822
  */
759
823
  'actions'?: {
760
824
  [key: string]: CreateIntegrationBodyActionsValue;
761
825
  };
826
+ /**
827
+ *
828
+ * @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
829
+ * @memberof CreateIntegrationBody
830
+ */
831
+ 'channels'?: {
832
+ [key: string]: CreateIntegrationBodyChannelsValue;
833
+ };
762
834
  /**
763
835
  *
764
836
  * @type {CreateIntegrationBodyUser}
@@ -771,12 +843,6 @@ export interface CreateIntegrationBody {
771
843
  * @memberof CreateIntegrationBody
772
844
  */
773
845
  'code'?: string;
774
- /**
775
- * Whether the integration is public
776
- * @type {boolean}
777
- * @memberof CreateIntegrationBody
778
- */
779
- 'public'?: boolean;
780
846
  /**
781
847
  * URL of the integration; Only available for dev integrations
782
848
  * @type {string}
@@ -815,36 +881,45 @@ export interface CreateIntegrationBody {
815
881
  'description'?: string;
816
882
  }
817
883
  /**
818
- *
884
+ * Action definition
819
885
  * @export
820
886
  * @interface CreateIntegrationBodyActionsValue
821
887
  */
822
888
  export interface CreateIntegrationBodyActionsValue {
823
889
  /**
824
890
  *
825
- * @type {CreateIntegrationBodyChannelsValueMessagesValue}
891
+ * @type {CreateIntegrationBodyActionsValueInput}
826
892
  * @memberof CreateIntegrationBodyActionsValue
827
893
  */
828
- 'input': CreateIntegrationBodyChannelsValueMessagesValue;
894
+ 'input': CreateIntegrationBodyActionsValueInput;
829
895
  /**
830
896
  *
831
- * @type {CreateIntegrationBodyChannelsValueMessagesValue}
897
+ * @type {CreateIntegrationBodyActionsValueInput}
832
898
  * @memberof CreateIntegrationBodyActionsValue
833
899
  */
834
- 'output': CreateIntegrationBodyChannelsValueMessagesValue;
900
+ 'output': CreateIntegrationBodyActionsValueInput;
835
901
  }
836
902
  /**
837
903
  *
838
904
  * @export
839
- * @interface CreateIntegrationBodyChannelsValue
905
+ * @interface CreateIntegrationBodyActionsValueInput
840
906
  */
841
- export interface CreateIntegrationBodyChannelsValue {
907
+ export interface CreateIntegrationBodyActionsValueInput {
842
908
  /**
843
909
  *
844
- * @type {CreateIntegrationBodyChannelsValueTags}
845
- * @memberof CreateIntegrationBodyChannelsValue
910
+ * @type {{ [key: string]: any; }}
911
+ * @memberof CreateIntegrationBodyActionsValueInput
846
912
  */
847
- 'tags'?: CreateIntegrationBodyChannelsValueTags;
913
+ 'schema': {
914
+ [key: string]: any;
915
+ };
916
+ }
917
+ /**
918
+ *
919
+ * @export
920
+ * @interface CreateIntegrationBodyChannelsValue
921
+ */
922
+ export interface CreateIntegrationBodyChannelsValue {
848
923
  /**
849
924
  *
850
925
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
@@ -859,6 +934,12 @@ export interface CreateIntegrationBodyChannelsValue {
859
934
  * @memberof CreateIntegrationBodyChannelsValue
860
935
  */
861
936
  'conversation'?: CreateIntegrationBodyChannelsValueConversation;
937
+ /**
938
+ *
939
+ * @type {CreateBotBodyUser}
940
+ * @memberof CreateIntegrationBodyChannelsValue
941
+ */
942
+ 'message'?: CreateBotBodyUser;
862
943
  }
863
944
  /**
864
945
  *
@@ -871,7 +952,15 @@ export interface CreateIntegrationBodyChannelsValueConversation {
871
952
  * @type {CreateIntegrationBodyChannelsValueConversationCreation}
872
953
  * @memberof CreateIntegrationBodyChannelsValueConversation
873
954
  */
874
- 'creation': CreateIntegrationBodyChannelsValueConversationCreation;
955
+ 'creation'?: CreateIntegrationBodyChannelsValueConversationCreation;
956
+ /**
957
+ *
958
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
959
+ * @memberof CreateIntegrationBodyChannelsValueConversation
960
+ */
961
+ 'tags'?: {
962
+ [key: string]: CreateBotBodyUserTagsValue;
963
+ };
875
964
  }
876
965
  /**
877
966
  * The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
@@ -893,7 +982,7 @@ export interface CreateIntegrationBodyChannelsValueConversationCreation {
893
982
  'requiredTags': Array<string>;
894
983
  }
895
984
  /**
896
- *
985
+ * Message definition
897
986
  * @export
898
987
  * @interface CreateIntegrationBodyChannelsValueMessagesValue
899
988
  */
@@ -907,25 +996,6 @@ export interface CreateIntegrationBodyChannelsValueMessagesValue {
907
996
  [key: string]: any;
908
997
  };
909
998
  }
910
- /**
911
- *
912
- * @export
913
- * @interface CreateIntegrationBodyChannelsValueTags
914
- */
915
- export interface CreateIntegrationBodyChannelsValueTags {
916
- /**
917
- *
918
- * @type {Array<string>}
919
- * @memberof CreateIntegrationBodyChannelsValueTags
920
- */
921
- 'messages'?: Array<string>;
922
- /**
923
- *
924
- * @type {Array<string>}
925
- * @memberof CreateIntegrationBodyChannelsValueTags
926
- */
927
- 'conversations'?: Array<string>;
928
- }
929
999
  /**
930
1000
  * Configuration definition
931
1001
  * @export
@@ -933,7 +1003,7 @@ export interface CreateIntegrationBodyChannelsValueTags {
933
1003
  */
934
1004
  export interface CreateIntegrationBodyConfiguration {
935
1005
  /**
936
- * Schema for the configuration
1006
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
937
1007
  * @type {{ [key: string]: any; }}
938
1008
  * @memberof CreateIntegrationBodyConfiguration
939
1009
  */
@@ -942,7 +1012,7 @@ export interface CreateIntegrationBodyConfiguration {
942
1012
  };
943
1013
  }
944
1014
  /**
945
- *
1015
+ * State definition
946
1016
  * @export
947
1017
  * @interface CreateIntegrationBodyStatesValue
948
1018
  */
@@ -968,19 +1038,6 @@ export declare const CreateIntegrationBodyStatesValueTypeEnum: {
968
1038
  readonly Integration: "integration";
969
1039
  };
970
1040
  export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationBodyStatesValueTypeEnum[keyof typeof CreateIntegrationBodyStatesValueTypeEnum];
971
- /**
972
- * Tags of the [Integration](#schema_integration)
973
- * @export
974
- * @interface CreateIntegrationBodyTags
975
- */
976
- export interface CreateIntegrationBodyTags {
977
- /**
978
- *
979
- * @type {Array<string>}
980
- * @memberof CreateIntegrationBodyTags
981
- */
982
- 'users'?: Array<string>;
983
- }
984
1041
  /**
985
1042
  *
986
1043
  * @export
@@ -992,7 +1049,15 @@ export interface CreateIntegrationBodyUser {
992
1049
  * @type {CreateIntegrationBodyUserCreation}
993
1050
  * @memberof CreateIntegrationBodyUser
994
1051
  */
995
- 'creation': CreateIntegrationBodyUserCreation;
1052
+ 'creation'?: CreateIntegrationBodyUserCreation;
1053
+ /**
1054
+ *
1055
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
1056
+ * @memberof CreateIntegrationBodyUser
1057
+ */
1058
+ 'tags'?: {
1059
+ [key: string]: CreateBotBodyUserTagsValue;
1060
+ };
996
1061
  }
997
1062
  /**
998
1063
  * The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
@@ -1139,6 +1204,74 @@ export interface CreateUserResponse {
1139
1204
  */
1140
1205
  'user': User;
1141
1206
  }
1207
+ /**
1208
+ *
1209
+ * @export
1210
+ * @interface CreateWorkspaceMemberBody
1211
+ */
1212
+ export interface CreateWorkspaceMemberBody {
1213
+ /**
1214
+ *
1215
+ * @type {string}
1216
+ * @memberof CreateWorkspaceMemberBody
1217
+ */
1218
+ 'email': string;
1219
+ /**
1220
+ *
1221
+ * @type {string}
1222
+ * @memberof CreateWorkspaceMemberBody
1223
+ */
1224
+ 'role': CreateWorkspaceMemberBodyRoleEnum;
1225
+ }
1226
+ export declare const CreateWorkspaceMemberBodyRoleEnum: {
1227
+ readonly Viewer: "viewer";
1228
+ readonly Billing: "billing";
1229
+ readonly Developer: "developer";
1230
+ readonly Manager: "manager";
1231
+ readonly Administrator: "administrator";
1232
+ readonly Owner: "owner";
1233
+ };
1234
+ export type CreateWorkspaceMemberBodyRoleEnum = typeof CreateWorkspaceMemberBodyRoleEnum[keyof typeof CreateWorkspaceMemberBodyRoleEnum];
1235
+ /**
1236
+ *
1237
+ * @export
1238
+ * @interface CreateWorkspaceMemberResponse
1239
+ */
1240
+ export interface CreateWorkspaceMemberResponse {
1241
+ /**
1242
+ *
1243
+ * @type {string}
1244
+ * @memberof CreateWorkspaceMemberResponse
1245
+ */
1246
+ 'id': string;
1247
+ /**
1248
+ *
1249
+ * @type {string}
1250
+ * @memberof CreateWorkspaceMemberResponse
1251
+ */
1252
+ 'userId'?: string;
1253
+ /**
1254
+ *
1255
+ * @type {string}
1256
+ * @memberof CreateWorkspaceMemberResponse
1257
+ */
1258
+ 'email': string;
1259
+ /**
1260
+ *
1261
+ * @type {string}
1262
+ * @memberof CreateWorkspaceMemberResponse
1263
+ */
1264
+ 'role': CreateWorkspaceMemberResponseRoleEnum;
1265
+ }
1266
+ export declare const CreateWorkspaceMemberResponseRoleEnum: {
1267
+ readonly Viewer: "viewer";
1268
+ readonly Billing: "billing";
1269
+ readonly Developer: "developer";
1270
+ readonly Manager: "manager";
1271
+ readonly Administrator: "administrator";
1272
+ readonly Owner: "owner";
1273
+ };
1274
+ export type CreateWorkspaceMemberResponseRoleEnum = typeof CreateWorkspaceMemberResponseRoleEnum[keyof typeof CreateWorkspaceMemberResponseRoleEnum];
1142
1275
  /**
1143
1276
  * The event object represents an action or an occurrence.
1144
1277
  * @export
@@ -1605,12 +1738,18 @@ export interface GetWorkspaceResponse {
1605
1738
  * @memberof GetWorkspaceResponse
1606
1739
  */
1607
1740
  'updatedAt': string;
1741
+ /**
1742
+ *
1743
+ * @type {number}
1744
+ * @memberof GetWorkspaceResponse
1745
+ */
1746
+ 'botCount': number;
1608
1747
  /**
1609
1748
  *
1610
1749
  * @type {string}
1611
1750
  * @memberof GetWorkspaceResponse
1612
1751
  */
1613
- 'accountType': string;
1752
+ 'accountType': GetWorkspaceResponseAccountTypeEnum;
1614
1753
  /**
1615
1754
  *
1616
1755
  * @type {boolean}
@@ -1624,6 +1763,11 @@ export interface GetWorkspaceResponse {
1624
1763
  */
1625
1764
  'spendingLimit': number;
1626
1765
  }
1766
+ export declare const GetWorkspaceResponseAccountTypeEnum: {
1767
+ readonly Free: "free";
1768
+ readonly Premium: "premium";
1769
+ };
1770
+ export type GetWorkspaceResponseAccountTypeEnum = typeof GetWorkspaceResponseAccountTypeEnum[keyof typeof GetWorkspaceResponseAccountTypeEnum];
1627
1771
  /**
1628
1772
  *
1629
1773
  * @export
@@ -1661,7 +1805,13 @@ export interface Integration {
1661
1805
  */
1662
1806
  'version': string;
1663
1807
  /**
1664
- * Channels definition
1808
+ *
1809
+ * @type {CreateIntegrationBodyConfiguration}
1810
+ * @memberof Integration
1811
+ */
1812
+ 'configuration': CreateIntegrationBodyConfiguration;
1813
+ /**
1814
+ *
1665
1815
  * @type {{ [key: string]: IntegrationChannelsValue; }}
1666
1816
  * @memberof Integration
1667
1817
  */
@@ -1669,21 +1819,15 @@ export interface Integration {
1669
1819
  [key: string]: IntegrationChannelsValue;
1670
1820
  };
1671
1821
  /**
1672
- * States definition
1822
+ *
1673
1823
  * @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
1674
1824
  * @memberof Integration
1675
1825
  */
1676
- 'states'?: {
1826
+ 'states': {
1677
1827
  [key: string]: CreateIntegrationBodyStatesValue;
1678
1828
  };
1679
1829
  /**
1680
1830
  *
1681
- * @type {CreateIntegrationBodyConfiguration}
1682
- * @memberof Integration
1683
- */
1684
- 'configuration': CreateIntegrationBodyConfiguration;
1685
- /**
1686
- * Events definition
1687
1831
  * @type {{ [key: string]: CreateBotBodyEventsValue; }}
1688
1832
  * @memberof Integration
1689
1833
  */
@@ -1691,7 +1835,7 @@ export interface Integration {
1691
1835
  [key: string]: CreateBotBodyEventsValue;
1692
1836
  };
1693
1837
  /**
1694
- * Action definition
1838
+ *
1695
1839
  * @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
1696
1840
  * @memberof Integration
1697
1841
  */
@@ -1700,10 +1844,10 @@ export interface Integration {
1700
1844
  };
1701
1845
  /**
1702
1846
  *
1703
- * @type {CreateIntegrationBodyUser}
1847
+ * @type {IntegrationUser}
1704
1848
  * @memberof Integration
1705
1849
  */
1706
- 'user': CreateIntegrationBodyUser;
1850
+ 'user': IntegrationUser;
1707
1851
  /**
1708
1852
  * Indicates if the integration is a development integration; Dev integrations run locally
1709
1853
  * @type {boolean}
@@ -1736,17 +1880,11 @@ export interface Integration {
1736
1880
  'readmeUrl': string;
1737
1881
  }
1738
1882
  /**
1739
- *
1883
+ * Channel definition
1740
1884
  * @export
1741
1885
  * @interface IntegrationChannelsValue
1742
1886
  */
1743
1887
  export interface IntegrationChannelsValue {
1744
- /**
1745
- *
1746
- * @type {CreateIntegrationBodyChannelsValueTags}
1747
- * @memberof IntegrationChannelsValue
1748
- */
1749
- 'tags': CreateIntegrationBodyChannelsValueTags;
1750
1888
  /**
1751
1889
  *
1752
1890
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
@@ -1757,43 +1895,91 @@ export interface IntegrationChannelsValue {
1757
1895
  };
1758
1896
  /**
1759
1897
  *
1760
- * @type {CreateIntegrationBodyChannelsValueConversation}
1898
+ * @type {IntegrationChannelsValueConversation}
1899
+ * @memberof IntegrationChannelsValue
1900
+ */
1901
+ 'conversation': IntegrationChannelsValueConversation;
1902
+ /**
1903
+ *
1904
+ * @type {BotMessage}
1761
1905
  * @memberof IntegrationChannelsValue
1762
1906
  */
1763
- 'conversation': CreateIntegrationBodyChannelsValueConversation;
1907
+ 'message': BotMessage;
1764
1908
  }
1765
1909
  /**
1766
- *
1910
+ * Conversation object configuration
1767
1911
  * @export
1768
- * @interface IntrospectBody
1912
+ * @interface IntegrationChannelsValueConversation
1769
1913
  */
1770
- export interface IntrospectBody {
1914
+ export interface IntegrationChannelsValueConversation {
1771
1915
  /**
1772
1916
  *
1773
- * @type {string}
1774
- * @memberof IntrospectBody
1917
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
1918
+ * @memberof IntegrationChannelsValueConversation
1775
1919
  */
1776
- 'botId': string;
1920
+ 'tags': {
1921
+ [key: string]: CreateBotBodyUserTagsValue;
1922
+ };
1923
+ /**
1924
+ *
1925
+ * @type {CreateIntegrationBodyChannelsValueConversationCreation}
1926
+ * @memberof IntegrationChannelsValueConversation
1927
+ */
1928
+ 'creation': CreateIntegrationBodyChannelsValueConversationCreation;
1777
1929
  }
1778
1930
  /**
1779
- *
1931
+ * User object configuration
1780
1932
  * @export
1781
- * @interface IntrospectResponse
1933
+ * @interface IntegrationUser
1782
1934
  */
1783
- export interface IntrospectResponse {
1935
+ export interface IntegrationUser {
1784
1936
  /**
1785
1937
  *
1786
- * @type {string}
1787
- * @memberof IntrospectResponse
1938
+ * @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
1939
+ * @memberof IntegrationUser
1788
1940
  */
1789
- 'workspaceId': string;
1941
+ 'tags': {
1942
+ [key: string]: CreateBotBodyUserTagsValue;
1943
+ };
1790
1944
  /**
1791
1945
  *
1792
- * @type {string}
1793
- * @memberof IntrospectResponse
1946
+ * @type {CreateIntegrationBodyUserCreation}
1947
+ * @memberof IntegrationUser
1794
1948
  */
1795
- 'botId': string;
1796
- /**
1949
+ 'creation': CreateIntegrationBodyUserCreation;
1950
+ }
1951
+ /**
1952
+ *
1953
+ * @export
1954
+ * @interface IntrospectBody
1955
+ */
1956
+ export interface IntrospectBody {
1957
+ /**
1958
+ *
1959
+ * @type {string}
1960
+ * @memberof IntrospectBody
1961
+ */
1962
+ 'botId': string;
1963
+ }
1964
+ /**
1965
+ *
1966
+ * @export
1967
+ * @interface IntrospectResponse
1968
+ */
1969
+ export interface IntrospectResponse {
1970
+ /**
1971
+ *
1972
+ * @type {string}
1973
+ * @memberof IntrospectResponse
1974
+ */
1975
+ 'workspaceId': string;
1976
+ /**
1977
+ *
1978
+ * @type {string}
1979
+ * @memberof IntrospectResponse
1980
+ */
1981
+ 'botId': string;
1982
+ /**
1797
1983
  *
1798
1984
  * @type {string}
1799
1985
  * @memberof IntrospectResponse
@@ -2057,6 +2243,65 @@ export interface ListUsersResponse {
2057
2243
  */
2058
2244
  'meta': ListConversationsResponseMeta;
2059
2245
  }
2246
+ /**
2247
+ *
2248
+ * @export
2249
+ * @interface ListWorkspaceMembersResponse
2250
+ */
2251
+ export interface ListWorkspaceMembersResponse {
2252
+ /**
2253
+ *
2254
+ * @type {Array<ListWorkspaceMembersResponseMembersInner>}
2255
+ * @memberof ListWorkspaceMembersResponse
2256
+ */
2257
+ 'members': Array<ListWorkspaceMembersResponseMembersInner>;
2258
+ /**
2259
+ *
2260
+ * @type {ListConversationsResponseMeta}
2261
+ * @memberof ListWorkspaceMembersResponse
2262
+ */
2263
+ 'meta': ListConversationsResponseMeta;
2264
+ }
2265
+ /**
2266
+ *
2267
+ * @export
2268
+ * @interface ListWorkspaceMembersResponseMembersInner
2269
+ */
2270
+ export interface ListWorkspaceMembersResponseMembersInner {
2271
+ /**
2272
+ *
2273
+ * @type {string}
2274
+ * @memberof ListWorkspaceMembersResponseMembersInner
2275
+ */
2276
+ 'id': string;
2277
+ /**
2278
+ *
2279
+ * @type {string}
2280
+ * @memberof ListWorkspaceMembersResponseMembersInner
2281
+ */
2282
+ 'userId'?: string;
2283
+ /**
2284
+ *
2285
+ * @type {string}
2286
+ * @memberof ListWorkspaceMembersResponseMembersInner
2287
+ */
2288
+ 'email': string;
2289
+ /**
2290
+ *
2291
+ * @type {string}
2292
+ * @memberof ListWorkspaceMembersResponseMembersInner
2293
+ */
2294
+ 'role': ListWorkspaceMembersResponseMembersInnerRoleEnum;
2295
+ }
2296
+ export declare const ListWorkspaceMembersResponseMembersInnerRoleEnum: {
2297
+ readonly Viewer: "viewer";
2298
+ readonly Billing: "billing";
2299
+ readonly Developer: "developer";
2300
+ readonly Manager: "manager";
2301
+ readonly Administrator: "administrator";
2302
+ readonly Owner: "owner";
2303
+ };
2304
+ export type ListWorkspaceMembersResponseMembersInnerRoleEnum = typeof ListWorkspaceMembersResponseMembersInnerRoleEnum[keyof typeof ListWorkspaceMembersResponseMembersInnerRoleEnum];
2060
2305
  /**
2061
2306
  *
2062
2307
  * @export
@@ -2112,7 +2357,24 @@ export interface ListWorkspacesResponseWorkspacesInner {
2112
2357
  * @memberof ListWorkspacesResponseWorkspacesInner
2113
2358
  */
2114
2359
  'updatedAt': string;
2360
+ /**
2361
+ *
2362
+ * @type {number}
2363
+ * @memberof ListWorkspacesResponseWorkspacesInner
2364
+ */
2365
+ 'botCount': number;
2366
+ /**
2367
+ *
2368
+ * @type {string}
2369
+ * @memberof ListWorkspacesResponseWorkspacesInner
2370
+ */
2371
+ 'accountType': ListWorkspacesResponseWorkspacesInnerAccountTypeEnum;
2115
2372
  }
2373
+ export declare const ListWorkspacesResponseWorkspacesInnerAccountTypeEnum: {
2374
+ readonly Free: "free";
2375
+ readonly Premium: "premium";
2376
+ };
2377
+ export type ListWorkspacesResponseWorkspacesInnerAccountTypeEnum = typeof ListWorkspacesResponseWorkspacesInnerAccountTypeEnum[keyof typeof ListWorkspacesResponseWorkspacesInnerAccountTypeEnum];
2116
2378
  /**
2117
2379
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
2118
2380
  * @export
@@ -2395,54 +2657,66 @@ export interface UpdateBotBody {
2395
2657
  */
2396
2658
  'authentication'?: UpdateBotBodyAuthenticationEnum;
2397
2659
  /**
2398
- * A mapping of states to their definition
2399
- * @type {{ [key: string]: CreateBotBodyStatesValue; }}
2660
+ *
2661
+ * @type {CreateBotBodyConfiguration}
2400
2662
  * @memberof UpdateBotBody
2401
2663
  */
2402
- 'states'?: {
2403
- [key: string]: CreateBotBodyStatesValue;
2404
- };
2664
+ 'configuration'?: CreateBotBodyConfiguration;
2405
2665
  /**
2406
2666
  *
2407
- * @type {CreateBotBodyTags}
2667
+ * @type {boolean}
2408
2668
  * @memberof UpdateBotBody
2409
2669
  */
2410
- 'tags'?: CreateBotBodyTags;
2670
+ 'blocked'?: boolean;
2411
2671
  /**
2412
- * Events definition
2413
- * @type {{ [key: string]: CreateBotBodyEventsValue; }}
2672
+ *
2673
+ * @type {UpdateBotBodyUser}
2414
2674
  * @memberof UpdateBotBody
2415
2675
  */
2416
- 'events'?: {
2417
- [key: string]: CreateBotBodyEventsValue;
2418
- };
2676
+ 'user'?: UpdateBotBodyUser;
2419
2677
  /**
2420
- * Recurring events
2421
- * @type {{ [key: string]: CreateBotBodyRecurringEventsValue; }}
2678
+ *
2679
+ * @type {UpdateBotBodyUser}
2422
2680
  * @memberof UpdateBotBody
2423
2681
  */
2424
- 'recurringEvents'?: {
2425
- [key: string]: CreateBotBodyRecurringEventsValue;
2682
+ 'message'?: UpdateBotBodyUser;
2683
+ /**
2684
+ *
2685
+ * @type {UpdateBotBodyUser}
2686
+ * @memberof UpdateBotBody
2687
+ */
2688
+ 'conversation'?: UpdateBotBodyUser;
2689
+ /**
2690
+ *
2691
+ * @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
2692
+ * @memberof UpdateBotBody
2693
+ */
2694
+ 'events'?: {
2695
+ [key: string]: UpdateBotBodyEventsValue | null;
2426
2696
  };
2427
2697
  /**
2428
2698
  *
2429
- * @type {CreateBotBodyConfiguration}
2699
+ * @type {{ [key: string]: UpdateBotBodyStatesValue | null; }}
2430
2700
  * @memberof UpdateBotBody
2431
2701
  */
2432
- 'configuration'?: CreateBotBodyConfiguration;
2702
+ 'states'?: {
2703
+ [key: string]: UpdateBotBodyStatesValue | null;
2704
+ };
2433
2705
  /**
2434
2706
  *
2435
- * @type {boolean}
2707
+ * @type {{ [key: string]: UpdateBotBodyRecurringEventsValue | null; }}
2436
2708
  * @memberof UpdateBotBody
2437
2709
  */
2438
- 'blocked'?: boolean;
2710
+ 'recurringEvents'?: {
2711
+ [key: string]: UpdateBotBodyRecurringEventsValue | null;
2712
+ };
2439
2713
  /**
2440
2714
  *
2441
- * @type {{ [key: string]: UpdateBotBodyIntegrationsValue; }}
2715
+ * @type {{ [key: string]: UpdateBotBodyIntegrationsValue | null; }}
2442
2716
  * @memberof UpdateBotBody
2443
2717
  */
2444
2718
  'integrations'?: {
2445
- [key: string]: UpdateBotBodyIntegrationsValue;
2719
+ [key: string]: UpdateBotBodyIntegrationsValue | null;
2446
2720
  };
2447
2721
  /**
2448
2722
  * JavaScript code of the bot
@@ -2467,6 +2741,21 @@ export declare const UpdateBotBodyAuthenticationEnum: {
2467
2741
  readonly Iam: "iam";
2468
2742
  };
2469
2743
  export type UpdateBotBodyAuthenticationEnum = typeof UpdateBotBodyAuthenticationEnum[keyof typeof UpdateBotBodyAuthenticationEnum];
2744
+ /**
2745
+ * Event Definition
2746
+ * @export
2747
+ * @interface UpdateBotBodyEventsValue
2748
+ */
2749
+ export interface UpdateBotBodyEventsValue {
2750
+ /**
2751
+ *
2752
+ * @type {{ [key: string]: any; }}
2753
+ * @memberof UpdateBotBodyEventsValue
2754
+ */
2755
+ 'schema': {
2756
+ [key: string]: any;
2757
+ };
2758
+ }
2470
2759
  /**
2471
2760
  *
2472
2761
  * @export
@@ -2488,6 +2777,100 @@ export interface UpdateBotBodyIntegrationsValue {
2488
2777
  [key: string]: any;
2489
2778
  };
2490
2779
  }
2780
+ /**
2781
+ *
2782
+ * @export
2783
+ * @interface UpdateBotBodyRecurringEventsValue
2784
+ */
2785
+ export interface UpdateBotBodyRecurringEventsValue {
2786
+ /**
2787
+ *
2788
+ * @type {CreateBotBodyRecurringEventsValueSchedule}
2789
+ * @memberof UpdateBotBodyRecurringEventsValue
2790
+ */
2791
+ 'schedule': CreateBotBodyRecurringEventsValueSchedule;
2792
+ /**
2793
+ *
2794
+ * @type {string}
2795
+ * @memberof UpdateBotBodyRecurringEventsValue
2796
+ */
2797
+ 'type': string;
2798
+ /**
2799
+ *
2800
+ * @type {{ [key: string]: any; }}
2801
+ * @memberof UpdateBotBodyRecurringEventsValue
2802
+ */
2803
+ 'payload': {
2804
+ [key: string]: any;
2805
+ };
2806
+ }
2807
+ /**
2808
+ *
2809
+ * @export
2810
+ * @interface UpdateBotBodyStatesValue
2811
+ */
2812
+ export interface UpdateBotBodyStatesValue {
2813
+ /**
2814
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
2815
+ * @type {string}
2816
+ * @memberof UpdateBotBodyStatesValue
2817
+ */
2818
+ 'type': UpdateBotBodyStatesValueTypeEnum;
2819
+ /**
2820
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
2821
+ * @type {{ [key: string]: any; }}
2822
+ * @memberof UpdateBotBodyStatesValue
2823
+ */
2824
+ 'schema': {
2825
+ [key: string]: any;
2826
+ };
2827
+ /**
2828
+ * 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.
2829
+ * @type {number}
2830
+ * @memberof UpdateBotBodyStatesValue
2831
+ */
2832
+ 'expiry'?: number;
2833
+ }
2834
+ export declare const UpdateBotBodyStatesValueTypeEnum: {
2835
+ readonly Conversation: "conversation";
2836
+ readonly User: "user";
2837
+ readonly Bot: "bot";
2838
+ };
2839
+ export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTypeEnum[keyof typeof UpdateBotBodyStatesValueTypeEnum];
2840
+ /**
2841
+ *
2842
+ * @export
2843
+ * @interface UpdateBotBodyUser
2844
+ */
2845
+ export interface UpdateBotBodyUser {
2846
+ /**
2847
+ *
2848
+ * @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
2849
+ * @memberof UpdateBotBodyUser
2850
+ */
2851
+ 'tags'?: {
2852
+ [key: string]: UpdateBotBodyUserTagsValue | null;
2853
+ };
2854
+ }
2855
+ /**
2856
+ * Definition of a tag that can be provided on the object
2857
+ * @export
2858
+ * @interface UpdateBotBodyUserTagsValue
2859
+ */
2860
+ export interface UpdateBotBodyUserTagsValue {
2861
+ /**
2862
+ * Title of the tag
2863
+ * @type {string}
2864
+ * @memberof UpdateBotBodyUserTagsValue
2865
+ */
2866
+ 'title'?: string;
2867
+ /**
2868
+ * Description of the tag
2869
+ * @type {string}
2870
+ * @memberof UpdateBotBodyUserTagsValue
2871
+ */
2872
+ 'description'?: string;
2873
+ }
2491
2874
  /**
2492
2875
  *
2493
2876
  * @export
@@ -2543,72 +2926,54 @@ export interface UpdateConversationResponse {
2543
2926
  export interface UpdateIntegrationBody {
2544
2927
  /**
2545
2928
  *
2546
- * @type {CreateIntegrationBodyTags}
2929
+ * @type {CreateIntegrationBodyConfiguration}
2547
2930
  * @memberof UpdateIntegrationBody
2548
2931
  */
2549
- 'tags'?: CreateIntegrationBodyTags;
2932
+ 'configuration'?: CreateIntegrationBodyConfiguration;
2550
2933
  /**
2551
- * Channels definition
2552
- * @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
2934
+ *
2935
+ * @type {{ [key: string]: UpdateIntegrationBodyChannelsValue; }}
2553
2936
  * @memberof UpdateIntegrationBody
2554
2937
  */
2555
2938
  'channels'?: {
2556
- [key: string]: CreateIntegrationBodyChannelsValue;
2939
+ [key: string]: UpdateIntegrationBodyChannelsValue;
2557
2940
  };
2558
2941
  /**
2559
- * States definition
2560
- * @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
2942
+ *
2943
+ * @type {{ [key: string]: UpdateIntegrationBodyActionsValue | null; }}
2561
2944
  * @memberof UpdateIntegrationBody
2562
2945
  */
2563
- 'states'?: {
2564
- [key: string]: CreateIntegrationBodyStatesValue;
2946
+ 'actions'?: {
2947
+ [key: string]: UpdateIntegrationBodyActionsValue | null;
2565
2948
  };
2566
2949
  /**
2567
2950
  *
2568
- * @type {CreateIntegrationBodyConfiguration}
2569
- * @memberof UpdateIntegrationBody
2570
- */
2571
- 'configuration'?: CreateIntegrationBodyConfiguration;
2572
- /**
2573
- * Events definition
2574
- * @type {{ [key: string]: CreateBotBodyEventsValue; }}
2951
+ * @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
2575
2952
  * @memberof UpdateIntegrationBody
2576
2953
  */
2577
2954
  'events'?: {
2578
- [key: string]: CreateBotBodyEventsValue;
2955
+ [key: string]: UpdateBotBodyEventsValue | null;
2579
2956
  };
2580
2957
  /**
2581
- * Action definition
2582
- * @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
2958
+ *
2959
+ * @type {{ [key: string]: UpdateIntegrationBodyStatesValue | null; }}
2583
2960
  * @memberof UpdateIntegrationBody
2584
2961
  */
2585
- 'actions'?: {
2586
- [key: string]: CreateIntegrationBodyActionsValue;
2962
+ 'states'?: {
2963
+ [key: string]: UpdateIntegrationBodyStatesValue | null;
2587
2964
  };
2588
2965
  /**
2589
2966
  *
2590
- * @type {CreateIntegrationBodyUser}
2967
+ * @type {UpdateIntegrationBodyUser}
2591
2968
  * @memberof UpdateIntegrationBody
2592
2969
  */
2593
- 'user'?: CreateIntegrationBodyUser;
2970
+ 'user'?: UpdateIntegrationBodyUser;
2594
2971
  /**
2595
2972
  * JavaScript code of the integration
2596
2973
  * @type {string}
2597
2974
  * @memberof UpdateIntegrationBody
2598
2975
  */
2599
2976
  'code'?: string;
2600
- /**
2601
- * Whether the integration is public
2602
- * @type {boolean}
2603
- * @memberof UpdateIntegrationBody
2604
- */
2605
- 'public'?: boolean;
2606
- /**
2607
- * URL of the integration; Only available for dev integrations
2608
- * @type {string}
2609
- * @memberof UpdateIntegrationBody
2610
- */
2611
- 'url'?: string;
2612
2977
  /**
2613
2978
  * Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
2614
2979
  * @type {string}
@@ -2633,6 +2998,142 @@ export interface UpdateIntegrationBody {
2633
2998
  * @memberof UpdateIntegrationBody
2634
2999
  */
2635
3000
  'description'?: string;
3001
+ /**
3002
+ * URL of the integration; Only available for dev integrations
3003
+ * @type {string}
3004
+ * @memberof UpdateIntegrationBody
3005
+ */
3006
+ 'url'?: string;
3007
+ }
3008
+ /**
3009
+ * Action definition
3010
+ * @export
3011
+ * @interface UpdateIntegrationBodyActionsValue
3012
+ */
3013
+ export interface UpdateIntegrationBodyActionsValue {
3014
+ /**
3015
+ *
3016
+ * @type {CreateIntegrationBodyActionsValueInput}
3017
+ * @memberof UpdateIntegrationBodyActionsValue
3018
+ */
3019
+ 'input': CreateIntegrationBodyActionsValueInput;
3020
+ /**
3021
+ *
3022
+ * @type {CreateIntegrationBodyActionsValueInput}
3023
+ * @memberof UpdateIntegrationBodyActionsValue
3024
+ */
3025
+ 'output': CreateIntegrationBodyActionsValueInput;
3026
+ }
3027
+ /**
3028
+ *
3029
+ * @export
3030
+ * @interface UpdateIntegrationBodyChannelsValue
3031
+ */
3032
+ export interface UpdateIntegrationBodyChannelsValue {
3033
+ /**
3034
+ *
3035
+ * @type {{ [key: string]: UpdateIntegrationBodyChannelsValueMessagesValue | null; }}
3036
+ * @memberof UpdateIntegrationBodyChannelsValue
3037
+ */
3038
+ 'messages'?: {
3039
+ [key: string]: UpdateIntegrationBodyChannelsValueMessagesValue | null;
3040
+ };
3041
+ /**
3042
+ *
3043
+ * @type {UpdateIntegrationBodyChannelsValueConversation}
3044
+ * @memberof UpdateIntegrationBodyChannelsValue
3045
+ */
3046
+ 'conversation'?: UpdateIntegrationBodyChannelsValueConversation;
3047
+ /**
3048
+ *
3049
+ * @type {UpdateBotBodyUser}
3050
+ * @memberof UpdateIntegrationBodyChannelsValue
3051
+ */
3052
+ 'message'?: UpdateBotBodyUser;
3053
+ }
3054
+ /**
3055
+ *
3056
+ * @export
3057
+ * @interface UpdateIntegrationBodyChannelsValueConversation
3058
+ */
3059
+ export interface UpdateIntegrationBodyChannelsValueConversation {
3060
+ /**
3061
+ *
3062
+ * @type {CreateIntegrationBodyChannelsValueConversationCreation}
3063
+ * @memberof UpdateIntegrationBodyChannelsValueConversation
3064
+ */
3065
+ 'creation'?: CreateIntegrationBodyChannelsValueConversationCreation;
3066
+ /**
3067
+ *
3068
+ * @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
3069
+ * @memberof UpdateIntegrationBodyChannelsValueConversation
3070
+ */
3071
+ 'tags'?: {
3072
+ [key: string]: UpdateBotBodyUserTagsValue | null;
3073
+ };
3074
+ }
3075
+ /**
3076
+ * Message definition
3077
+ * @export
3078
+ * @interface UpdateIntegrationBodyChannelsValueMessagesValue
3079
+ */
3080
+ export interface UpdateIntegrationBodyChannelsValueMessagesValue {
3081
+ /**
3082
+ *
3083
+ * @type {{ [key: string]: any; }}
3084
+ * @memberof UpdateIntegrationBodyChannelsValueMessagesValue
3085
+ */
3086
+ 'schema': {
3087
+ [key: string]: any;
3088
+ };
3089
+ }
3090
+ /**
3091
+ * State definition
3092
+ * @export
3093
+ * @interface UpdateIntegrationBodyStatesValue
3094
+ */
3095
+ export interface UpdateIntegrationBodyStatesValue {
3096
+ /**
3097
+ * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
3098
+ * @type {string}
3099
+ * @memberof UpdateIntegrationBodyStatesValue
3100
+ */
3101
+ 'type': UpdateIntegrationBodyStatesValueTypeEnum;
3102
+ /**
3103
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
3104
+ * @type {{ [key: string]: any; }}
3105
+ * @memberof UpdateIntegrationBodyStatesValue
3106
+ */
3107
+ 'schema': {
3108
+ [key: string]: any;
3109
+ };
3110
+ }
3111
+ export declare const UpdateIntegrationBodyStatesValueTypeEnum: {
3112
+ readonly Conversation: "conversation";
3113
+ readonly User: "user";
3114
+ readonly Integration: "integration";
3115
+ };
3116
+ export type UpdateIntegrationBodyStatesValueTypeEnum = typeof UpdateIntegrationBodyStatesValueTypeEnum[keyof typeof UpdateIntegrationBodyStatesValueTypeEnum];
3117
+ /**
3118
+ *
3119
+ * @export
3120
+ * @interface UpdateIntegrationBodyUser
3121
+ */
3122
+ export interface UpdateIntegrationBodyUser {
3123
+ /**
3124
+ *
3125
+ * @type {CreateIntegrationBodyUserCreation}
3126
+ * @memberof UpdateIntegrationBodyUser
3127
+ */
3128
+ 'creation'?: CreateIntegrationBodyUserCreation;
3129
+ /**
3130
+ *
3131
+ * @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
3132
+ * @memberof UpdateIntegrationBodyUser
3133
+ */
3134
+ 'tags'?: {
3135
+ [key: string]: UpdateBotBodyUserTagsValue | null;
3136
+ };
2636
3137
  }
2637
3138
  /**
2638
3139
  *
@@ -2654,55 +3155,213 @@ export interface UpdateIntegrationResponse {
2654
3155
  */
2655
3156
  export interface UpdateMessageBody {
2656
3157
  /**
2657
- * Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
2658
- * @type {{ [key: string]: string; }}
2659
- * @memberof UpdateMessageBody
3158
+ * Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
3159
+ * @type {{ [key: string]: string; }}
3160
+ * @memberof UpdateMessageBody
3161
+ */
3162
+ 'tags': {
3163
+ [key: string]: string;
3164
+ };
3165
+ }
3166
+ /**
3167
+ *
3168
+ * @export
3169
+ * @interface UpdateMessageResponse
3170
+ */
3171
+ export interface UpdateMessageResponse {
3172
+ /**
3173
+ *
3174
+ * @type {Message}
3175
+ * @memberof UpdateMessageResponse
3176
+ */
3177
+ 'message': Message;
3178
+ }
3179
+ /**
3180
+ *
3181
+ * @export
3182
+ * @interface UpdateUserBody
3183
+ */
3184
+ export interface UpdateUserBody {
3185
+ /**
3186
+ * Tags for the [User](#schema_user)
3187
+ * @type {{ [key: string]: string; }}
3188
+ * @memberof UpdateUserBody
3189
+ */
3190
+ 'tags': {
3191
+ [key: string]: string;
3192
+ };
3193
+ }
3194
+ /**
3195
+ *
3196
+ * @export
3197
+ * @interface UpdateUserResponse
3198
+ */
3199
+ export interface UpdateUserResponse {
3200
+ /**
3201
+ *
3202
+ * @type {User}
3203
+ * @memberof UpdateUserResponse
3204
+ */
3205
+ 'user': User;
3206
+ }
3207
+ /**
3208
+ *
3209
+ * @export
3210
+ * @interface UpdateWorkspaceBody
3211
+ */
3212
+ export interface UpdateWorkspaceBody {
3213
+ /**
3214
+ *
3215
+ * @type {string}
3216
+ * @memberof UpdateWorkspaceBody
3217
+ */
3218
+ 'name'?: string;
3219
+ /**
3220
+ *
3221
+ * @type {string}
3222
+ * @memberof UpdateWorkspaceBody
3223
+ */
3224
+ 'accountType'?: UpdateWorkspaceBodyAccountTypeEnum;
3225
+ /**
3226
+ *
3227
+ * @type {number}
3228
+ * @memberof UpdateWorkspaceBody
2660
3229
  */
2661
- 'tags': {
2662
- [key: string]: string;
2663
- };
3230
+ 'spendingLimit'?: number;
2664
3231
  }
3232
+ export declare const UpdateWorkspaceBodyAccountTypeEnum: {
3233
+ readonly Free: "free";
3234
+ readonly Premium: "premium";
3235
+ };
3236
+ export type UpdateWorkspaceBodyAccountTypeEnum = typeof UpdateWorkspaceBodyAccountTypeEnum[keyof typeof UpdateWorkspaceBodyAccountTypeEnum];
2665
3237
  /**
2666
3238
  *
2667
3239
  * @export
2668
- * @interface UpdateMessageResponse
3240
+ * @interface UpdateWorkspaceMemberBody
2669
3241
  */
2670
- export interface UpdateMessageResponse {
3242
+ export interface UpdateWorkspaceMemberBody {
2671
3243
  /**
2672
3244
  *
2673
- * @type {Message}
2674
- * @memberof UpdateMessageResponse
3245
+ * @type {string}
3246
+ * @memberof UpdateWorkspaceMemberBody
2675
3247
  */
2676
- 'message': Message;
3248
+ 'role'?: UpdateWorkspaceMemberBodyRoleEnum;
2677
3249
  }
3250
+ export declare const UpdateWorkspaceMemberBodyRoleEnum: {
3251
+ readonly Viewer: "viewer";
3252
+ readonly Billing: "billing";
3253
+ readonly Developer: "developer";
3254
+ readonly Manager: "manager";
3255
+ readonly Administrator: "administrator";
3256
+ readonly Owner: "owner";
3257
+ };
3258
+ export type UpdateWorkspaceMemberBodyRoleEnum = typeof UpdateWorkspaceMemberBodyRoleEnum[keyof typeof UpdateWorkspaceMemberBodyRoleEnum];
2678
3259
  /**
2679
3260
  *
2680
3261
  * @export
2681
- * @interface UpdateUserBody
3262
+ * @interface UpdateWorkspaceMemberResponse
2682
3263
  */
2683
- export interface UpdateUserBody {
3264
+ export interface UpdateWorkspaceMemberResponse {
2684
3265
  /**
2685
- * Tags for the [User](#schema_user)
2686
- * @type {{ [key: string]: string; }}
2687
- * @memberof UpdateUserBody
3266
+ *
3267
+ * @type {string}
3268
+ * @memberof UpdateWorkspaceMemberResponse
2688
3269
  */
2689
- 'tags': {
2690
- [key: string]: string;
2691
- };
3270
+ 'id': string;
3271
+ /**
3272
+ *
3273
+ * @type {string}
3274
+ * @memberof UpdateWorkspaceMemberResponse
3275
+ */
3276
+ 'userId'?: string;
3277
+ /**
3278
+ *
3279
+ * @type {string}
3280
+ * @memberof UpdateWorkspaceMemberResponse
3281
+ */
3282
+ 'email': string;
3283
+ /**
3284
+ *
3285
+ * @type {string}
3286
+ * @memberof UpdateWorkspaceMemberResponse
3287
+ */
3288
+ 'role': UpdateWorkspaceMemberResponseRoleEnum;
2692
3289
  }
3290
+ export declare const UpdateWorkspaceMemberResponseRoleEnum: {
3291
+ readonly Viewer: "viewer";
3292
+ readonly Billing: "billing";
3293
+ readonly Developer: "developer";
3294
+ readonly Manager: "manager";
3295
+ readonly Administrator: "administrator";
3296
+ readonly Owner: "owner";
3297
+ };
3298
+ export type UpdateWorkspaceMemberResponseRoleEnum = typeof UpdateWorkspaceMemberResponseRoleEnum[keyof typeof UpdateWorkspaceMemberResponseRoleEnum];
2693
3299
  /**
2694
3300
  *
2695
3301
  * @export
2696
- * @interface UpdateUserResponse
3302
+ * @interface UpdateWorkspaceResponse
2697
3303
  */
2698
- export interface UpdateUserResponse {
3304
+ export interface UpdateWorkspaceResponse {
2699
3305
  /**
2700
3306
  *
2701
- * @type {User}
2702
- * @memberof UpdateUserResponse
3307
+ * @type {string}
3308
+ * @memberof UpdateWorkspaceResponse
2703
3309
  */
2704
- 'user': User;
3310
+ 'id': string;
3311
+ /**
3312
+ *
3313
+ * @type {string}
3314
+ * @memberof UpdateWorkspaceResponse
3315
+ */
3316
+ 'name': string;
3317
+ /**
3318
+ *
3319
+ * @type {string}
3320
+ * @memberof UpdateWorkspaceResponse
3321
+ */
3322
+ 'ownerId': string;
3323
+ /**
3324
+ *
3325
+ * @type {string}
3326
+ * @memberof UpdateWorkspaceResponse
3327
+ */
3328
+ 'createdAt': string;
3329
+ /**
3330
+ *
3331
+ * @type {string}
3332
+ * @memberof UpdateWorkspaceResponse
3333
+ */
3334
+ 'updatedAt': string;
3335
+ /**
3336
+ *
3337
+ * @type {number}
3338
+ * @memberof UpdateWorkspaceResponse
3339
+ */
3340
+ 'botCount': number;
3341
+ /**
3342
+ *
3343
+ * @type {string}
3344
+ * @memberof UpdateWorkspaceResponse
3345
+ */
3346
+ 'accountType': UpdateWorkspaceResponseAccountTypeEnum;
3347
+ /**
3348
+ *
3349
+ * @type {boolean}
3350
+ * @memberof UpdateWorkspaceResponse
3351
+ */
3352
+ 'blocked': boolean;
3353
+ /**
3354
+ *
3355
+ * @type {number}
3356
+ * @memberof UpdateWorkspaceResponse
3357
+ */
3358
+ 'spendingLimit': number;
2705
3359
  }
3360
+ export declare const UpdateWorkspaceResponseAccountTypeEnum: {
3361
+ readonly Free: "free";
3362
+ readonly Premium: "premium";
3363
+ };
3364
+ export type UpdateWorkspaceResponseAccountTypeEnum = typeof UpdateWorkspaceResponseAccountTypeEnum[keyof typeof UpdateWorkspaceResponseAccountTypeEnum];
2706
3365
  /**
2707
3366
  * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
2708
3367
  * @export
@@ -2772,12 +3431,18 @@ export interface Workspace {
2772
3431
  * @memberof Workspace
2773
3432
  */
2774
3433
  'updatedAt': string;
3434
+ /**
3435
+ *
3436
+ * @type {number}
3437
+ * @memberof Workspace
3438
+ */
3439
+ 'botCount': number;
2775
3440
  /**
2776
3441
  *
2777
3442
  * @type {string}
2778
3443
  * @memberof Workspace
2779
3444
  */
2780
- 'accountType': string;
3445
+ 'accountType': WorkspaceAccountTypeEnum;
2781
3446
  /**
2782
3447
  *
2783
3448
  * @type {boolean}
@@ -2791,6 +3456,11 @@ export interface Workspace {
2791
3456
  */
2792
3457
  'spendingLimit': number;
2793
3458
  }
3459
+ export declare const WorkspaceAccountTypeEnum: {
3460
+ readonly Free: "free";
3461
+ readonly Premium: "premium";
3462
+ };
3463
+ export type WorkspaceAccountTypeEnum = typeof WorkspaceAccountTypeEnum[keyof typeof WorkspaceAccountTypeEnum];
2794
3464
  /**
2795
3465
  * DefaultApi - axios parameter creator
2796
3466
  * @export
@@ -2859,6 +3529,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
2859
3529
  * @throws {RequiredError}
2860
3530
  */
2861
3531
  createUser: (createUserBody?: CreateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3532
+ /**
3533
+ * Add a member to the workspace
3534
+ * @param {CreateWorkspaceMemberBody} [createWorkspaceMemberBody] Workspace member metadata
3535
+ * @param {*} [options] Override http request option.
3536
+ * @throws {RequiredError}
3537
+ */
3538
+ createWorkspaceMember: (createWorkspaceMemberBody?: CreateWorkspaceMemberBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2862
3539
  /**
2863
3540
  * Delete bot
2864
3541
  * @param {string} id Bot ID
@@ -2901,6 +3578,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
2901
3578
  * @throws {RequiredError}
2902
3579
  */
2903
3580
  deleteUser: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3581
+ /**
3582
+ * Remove a member of a workspace
3583
+ * @param {string} id Workspace member ID
3584
+ * @param {*} [options] Override http request option.
3585
+ * @throws {RequiredError}
3586
+ */
3587
+ deleteWorkspaceMember: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2904
3588
  /**
2905
3589
  * Download File
2906
3590
  * @param {string} id File ID
@@ -2934,11 +3618,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
2934
3618
  /**
2935
3619
  * Get the webchat code/URL for a bot
2936
3620
  * @param {string} id Bot ID
2937
- * @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
3621
+ * @param {GetBotWebchatTypeEnum} type type of script to get
2938
3622
  * @param {*} [options] Override http request option.
2939
3623
  * @throws {RequiredError}
2940
3624
  */
2941
- getBotWebchat: (id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: AxiosRequestConfig) => Promise<RequestArgs>;
3625
+ getBotWebchat: (id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2942
3626
  /**
2943
3627
  * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
2944
3628
  * @param {string} id Conversation id
@@ -3027,13 +3711,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3027
3711
  getPublicIntegrationById: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3028
3712
  /**
3029
3713
  * Retrieves the [State](#schema_state) object for a valid identifiers.
3030
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3714
+ * @param {GetStateTypeEnum} type State type
3031
3715
  * @param {string} id State id
3032
3716
  * @param {string} name State name
3033
3717
  * @param {*} [options] Override http request option.
3034
3718
  * @throws {RequiredError}
3035
3719
  */
3036
- getState: (type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3720
+ getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3037
3721
  /**
3038
3722
  * Retrieves the [User](#schema_user) object for a valid identifier.
3039
3723
  * @param {string} id User ID
@@ -3129,6 +3813,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3129
3813
  listUsers: (nextToken?: string, conversationId?: string, tags?: {
3130
3814
  [key: string]: string;
3131
3815
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3816
+ /**
3817
+ * Lists all the members in a workspace
3818
+ * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3819
+ * @param {*} [options] Override http request option.
3820
+ * @throws {RequiredError}
3821
+ */
3822
+ listWorkspaceMembers: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3132
3823
  /**
3133
3824
  * List workspaces the user has access to
3134
3825
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -3138,24 +3829,24 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3138
3829
  listWorkspaces: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3139
3830
  /**
3140
3831
  * Updates the [State](#schema_state) object by setting the values of the parameters passed.
3141
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3832
+ * @param {PatchStateTypeEnum} type State type
3142
3833
  * @param {string} id State id
3143
3834
  * @param {string} name State name
3144
3835
  * @param {PatchStateBody} [patchStateBody] State content
3145
3836
  * @param {*} [options] Override http request option.
3146
3837
  * @throws {RequiredError}
3147
3838
  */
3148
- patchState: (type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3839
+ patchState: (type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3149
3840
  /**
3150
3841
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
3151
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3842
+ * @param {SetStateTypeEnum} type State type
3152
3843
  * @param {string} id State id
3153
3844
  * @param {string} name State name
3154
3845
  * @param {SetStateBody} [setStateBody] State content
3155
3846
  * @param {*} [options] Override http request option.
3156
3847
  * @throws {RequiredError}
3157
3848
  */
3158
- setState: (type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3849
+ setState: (type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3159
3850
  /**
3160
3851
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
3161
3852
  * @param {string} id Bot ID
@@ -3204,6 +3895,22 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3204
3895
  * @throws {RequiredError}
3205
3896
  */
3206
3897
  updateUser: (id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3898
+ /**
3899
+ * Update workspace
3900
+ * @param {string} id Workspace ID
3901
+ * @param {UpdateWorkspaceBody} [updateWorkspaceBody] Workspace metadata
3902
+ * @param {*} [options] Override http request option.
3903
+ * @throws {RequiredError}
3904
+ */
3905
+ updateWorkspace: (id: string, updateWorkspaceBody?: UpdateWorkspaceBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3906
+ /**
3907
+ * Update the member of a workspace
3908
+ * @param {string} id Workspace member ID
3909
+ * @param {UpdateWorkspaceMemberBody} [updateWorkspaceMemberBody] Workspace member metadata
3910
+ * @param {*} [options] Override http request option.
3911
+ * @throws {RequiredError}
3912
+ */
3913
+ updateWorkspaceMember: (id: string, updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3207
3914
  };
3208
3915
  /**
3209
3916
  * DefaultApi - functional programming interface
@@ -3273,6 +3980,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3273
3980
  * @throws {RequiredError}
3274
3981
  */
3275
3982
  createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponse>>;
3983
+ /**
3984
+ * Add a member to the workspace
3985
+ * @param {CreateWorkspaceMemberBody} [createWorkspaceMemberBody] Workspace member metadata
3986
+ * @param {*} [options] Override http request option.
3987
+ * @throws {RequiredError}
3988
+ */
3989
+ createWorkspaceMember(createWorkspaceMemberBody?: CreateWorkspaceMemberBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkspaceMemberResponse>>;
3276
3990
  /**
3277
3991
  * Delete bot
3278
3992
  * @param {string} id Bot ID
@@ -3315,6 +4029,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3315
4029
  * @throws {RequiredError}
3316
4030
  */
3317
4031
  deleteUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
4032
+ /**
4033
+ * Remove a member of a workspace
4034
+ * @param {string} id Workspace member ID
4035
+ * @param {*} [options] Override http request option.
4036
+ * @throws {RequiredError}
4037
+ */
4038
+ deleteWorkspaceMember(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
3318
4039
  /**
3319
4040
  * Download File
3320
4041
  * @param {string} id File ID
@@ -3348,11 +4069,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3348
4069
  /**
3349
4070
  * Get the webchat code/URL for a bot
3350
4071
  * @param {string} id Bot ID
3351
- * @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
4072
+ * @param {GetBotWebchatTypeEnum} type type of script to get
3352
4073
  * @param {*} [options] Override http request option.
3353
4074
  * @throws {RequiredError}
3354
4075
  */
3355
- getBotWebchat(id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotWebchatResponse>>;
4076
+ getBotWebchat(id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotWebchatResponse>>;
3356
4077
  /**
3357
4078
  * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
3358
4079
  * @param {string} id Conversation id
@@ -3441,13 +4162,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3441
4162
  getPublicIntegrationById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationByIdResponse>>;
3442
4163
  /**
3443
4164
  * Retrieves the [State](#schema_state) object for a valid identifiers.
3444
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4165
+ * @param {GetStateTypeEnum} type State type
3445
4166
  * @param {string} id State id
3446
4167
  * @param {string} name State name
3447
4168
  * @param {*} [options] Override http request option.
3448
4169
  * @throws {RequiredError}
3449
4170
  */
3450
- getState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
4171
+ getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
3451
4172
  /**
3452
4173
  * Retrieves the [User](#schema_user) object for a valid identifier.
3453
4174
  * @param {string} id User ID
@@ -3543,6 +4264,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3543
4264
  listUsers(nextToken?: string, conversationId?: string, tags?: {
3544
4265
  [key: string]: string;
3545
4266
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
4267
+ /**
4268
+ * Lists all the members in a workspace
4269
+ * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4270
+ * @param {*} [options] Override http request option.
4271
+ * @throws {RequiredError}
4272
+ */
4273
+ listWorkspaceMembers(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceMembersResponse>>;
3546
4274
  /**
3547
4275
  * List workspaces the user has access to
3548
4276
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -3552,24 +4280,24 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3552
4280
  listWorkspaces(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspacesResponse>>;
3553
4281
  /**
3554
4282
  * Updates the [State](#schema_state) object by setting the values of the parameters passed.
3555
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4283
+ * @param {PatchStateTypeEnum} type State type
3556
4284
  * @param {string} id State id
3557
4285
  * @param {string} name State name
3558
4286
  * @param {PatchStateBody} [patchStateBody] State content
3559
4287
  * @param {*} [options] Override http request option.
3560
4288
  * @throws {RequiredError}
3561
4289
  */
3562
- patchState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStateResponse>>;
4290
+ patchState(type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStateResponse>>;
3563
4291
  /**
3564
4292
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
3565
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4293
+ * @param {SetStateTypeEnum} type State type
3566
4294
  * @param {string} id State id
3567
4295
  * @param {string} name State name
3568
4296
  * @param {SetStateBody} [setStateBody] State content
3569
4297
  * @param {*} [options] Override http request option.
3570
4298
  * @throws {RequiredError}
3571
4299
  */
3572
- setState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
4300
+ setState(type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
3573
4301
  /**
3574
4302
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
3575
4303
  * @param {string} id Bot ID
@@ -3618,6 +4346,22 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3618
4346
  * @throws {RequiredError}
3619
4347
  */
3620
4348
  updateUser(id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponse>>;
4349
+ /**
4350
+ * Update workspace
4351
+ * @param {string} id Workspace ID
4352
+ * @param {UpdateWorkspaceBody} [updateWorkspaceBody] Workspace metadata
4353
+ * @param {*} [options] Override http request option.
4354
+ * @throws {RequiredError}
4355
+ */
4356
+ updateWorkspace(id: string, updateWorkspaceBody?: UpdateWorkspaceBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkspaceResponse>>;
4357
+ /**
4358
+ * Update the member of a workspace
4359
+ * @param {string} id Workspace member ID
4360
+ * @param {UpdateWorkspaceMemberBody} [updateWorkspaceMemberBody] Workspace member metadata
4361
+ * @param {*} [options] Override http request option.
4362
+ * @throws {RequiredError}
4363
+ */
4364
+ updateWorkspaceMember(id: string, updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkspaceMemberResponse>>;
3621
4365
  };
3622
4366
  /**
3623
4367
  * DefaultApi - factory interface
@@ -3687,6 +4431,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3687
4431
  * @throws {RequiredError}
3688
4432
  */
3689
4433
  createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
4434
+ /**
4435
+ * Add a member to the workspace
4436
+ * @param {DefaultApiCreateWorkspaceMemberRequest} requestParameters Request parameters.
4437
+ * @param {*} [options] Override http request option.
4438
+ * @throws {RequiredError}
4439
+ */
4440
+ createWorkspaceMember(requestParameters?: DefaultApiCreateWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<CreateWorkspaceMemberResponse>;
3690
4441
  /**
3691
4442
  * Delete bot
3692
4443
  * @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
@@ -3729,6 +4480,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3729
4480
  * @throws {RequiredError}
3730
4481
  */
3731
4482
  deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
4483
+ /**
4484
+ * Remove a member of a workspace
4485
+ * @param {DefaultApiDeleteWorkspaceMemberRequest} requestParameters Request parameters.
4486
+ * @param {*} [options] Override http request option.
4487
+ * @throws {RequiredError}
4488
+ */
4489
+ deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3732
4490
  /**
3733
4491
  * Download File
3734
4492
  * @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
@@ -3932,6 +4690,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3932
4690
  * @throws {RequiredError}
3933
4691
  */
3934
4692
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
4693
+ /**
4694
+ * Lists all the members in a workspace
4695
+ * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
4696
+ * @param {*} [options] Override http request option.
4697
+ * @throws {RequiredError}
4698
+ */
4699
+ listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceMembersResponse>;
3935
4700
  /**
3936
4701
  * List workspaces the user has access to
3937
4702
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -3995,6 +4760,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3995
4760
  * @throws {RequiredError}
3996
4761
  */
3997
4762
  updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
4763
+ /**
4764
+ * Update workspace
4765
+ * @param {DefaultApiUpdateWorkspaceRequest} requestParameters Request parameters.
4766
+ * @param {*} [options] Override http request option.
4767
+ * @throws {RequiredError}
4768
+ */
4769
+ updateWorkspace(requestParameters: DefaultApiUpdateWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateWorkspaceResponse>;
4770
+ /**
4771
+ * Update the member of a workspace
4772
+ * @param {DefaultApiUpdateWorkspaceMemberRequest} requestParameters Request parameters.
4773
+ * @param {*} [options] Override http request option.
4774
+ * @throws {RequiredError}
4775
+ */
4776
+ updateWorkspaceMember(requestParameters: DefaultApiUpdateWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateWorkspaceMemberResponse>;
3998
4777
  };
3999
4778
  /**
4000
4779
  * Request parameters for callAction operation in DefaultApi.
@@ -4113,6 +4892,19 @@ export interface DefaultApiCreateUserRequest {
4113
4892
  */
4114
4893
  readonly createUserBody?: CreateUserBody;
4115
4894
  }
4895
+ /**
4896
+ * Request parameters for createWorkspaceMember operation in DefaultApi.
4897
+ * @export
4898
+ * @interface DefaultApiCreateWorkspaceMemberRequest
4899
+ */
4900
+ export interface DefaultApiCreateWorkspaceMemberRequest {
4901
+ /**
4902
+ * Workspace member metadata
4903
+ * @type {CreateWorkspaceMemberBody}
4904
+ * @memberof DefaultApiCreateWorkspaceMember
4905
+ */
4906
+ readonly createWorkspaceMemberBody?: CreateWorkspaceMemberBody;
4907
+ }
4116
4908
  /**
4117
4909
  * Request parameters for deleteBot operation in DefaultApi.
4118
4910
  * @export
@@ -4191,6 +4983,19 @@ export interface DefaultApiDeleteUserRequest {
4191
4983
  */
4192
4984
  readonly id: string;
4193
4985
  }
4986
+ /**
4987
+ * Request parameters for deleteWorkspaceMember operation in DefaultApi.
4988
+ * @export
4989
+ * @interface DefaultApiDeleteWorkspaceMemberRequest
4990
+ */
4991
+ export interface DefaultApiDeleteWorkspaceMemberRequest {
4992
+ /**
4993
+ * Workspace member ID
4994
+ * @type {string}
4995
+ * @memberof DefaultApiDeleteWorkspaceMember
4996
+ */
4997
+ readonly id: string;
4998
+ }
4194
4999
  /**
4195
5000
  * Request parameters for downloadFile operation in DefaultApi.
4196
5001
  * @export
@@ -4272,7 +5077,7 @@ export interface DefaultApiGetBotWebchatRequest {
4272
5077
  * @type {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'}
4273
5078
  * @memberof DefaultApiGetBotWebchat
4274
5079
  */
4275
- readonly type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl';
5080
+ readonly type: GetBotWebchatTypeEnum;
4276
5081
  }
4277
5082
  /**
4278
5083
  * Request parameters for getConversation operation in DefaultApi.
@@ -4453,7 +5258,7 @@ export interface DefaultApiGetStateRequest {
4453
5258
  * @type {'conversation' | 'user' | 'bot' | 'integration'}
4454
5259
  * @memberof DefaultApiGetState
4455
5260
  */
4456
- readonly type: 'conversation' | 'user' | 'bot' | 'integration';
5261
+ readonly type: GetStateTypeEnum;
4457
5262
  /**
4458
5263
  * State id
4459
5264
  * @type {string}
@@ -4688,6 +5493,19 @@ export interface DefaultApiListUsersRequest {
4688
5493
  [key: string]: string;
4689
5494
  };
4690
5495
  }
5496
+ /**
5497
+ * Request parameters for listWorkspaceMembers operation in DefaultApi.
5498
+ * @export
5499
+ * @interface DefaultApiListWorkspaceMembersRequest
5500
+ */
5501
+ export interface DefaultApiListWorkspaceMembersRequest {
5502
+ /**
5503
+ * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
5504
+ * @type {string}
5505
+ * @memberof DefaultApiListWorkspaceMembers
5506
+ */
5507
+ readonly nextToken?: string;
5508
+ }
4691
5509
  /**
4692
5510
  * Request parameters for listWorkspaces operation in DefaultApi.
4693
5511
  * @export
@@ -4712,7 +5530,7 @@ export interface DefaultApiPatchStateRequest {
4712
5530
  * @type {'conversation' | 'user' | 'bot' | 'integration'}
4713
5531
  * @memberof DefaultApiPatchState
4714
5532
  */
4715
- readonly type: 'conversation' | 'user' | 'bot' | 'integration';
5533
+ readonly type: PatchStateTypeEnum;
4716
5534
  /**
4717
5535
  * State id
4718
5536
  * @type {string}
@@ -4743,7 +5561,7 @@ export interface DefaultApiSetStateRequest {
4743
5561
  * @type {'conversation' | 'user' | 'bot' | 'integration'}
4744
5562
  * @memberof DefaultApiSetState
4745
5563
  */
4746
- readonly type: 'conversation' | 'user' | 'bot' | 'integration';
5564
+ readonly type: SetStateTypeEnum;
4747
5565
  /**
4748
5566
  * State id
4749
5567
  * @type {string}
@@ -4877,6 +5695,44 @@ export interface DefaultApiUpdateUserRequest {
4877
5695
  */
4878
5696
  readonly updateUserBody?: UpdateUserBody;
4879
5697
  }
5698
+ /**
5699
+ * Request parameters for updateWorkspace operation in DefaultApi.
5700
+ * @export
5701
+ * @interface DefaultApiUpdateWorkspaceRequest
5702
+ */
5703
+ export interface DefaultApiUpdateWorkspaceRequest {
5704
+ /**
5705
+ * Workspace ID
5706
+ * @type {string}
5707
+ * @memberof DefaultApiUpdateWorkspace
5708
+ */
5709
+ readonly id: string;
5710
+ /**
5711
+ * Workspace metadata
5712
+ * @type {UpdateWorkspaceBody}
5713
+ * @memberof DefaultApiUpdateWorkspace
5714
+ */
5715
+ readonly updateWorkspaceBody?: UpdateWorkspaceBody;
5716
+ }
5717
+ /**
5718
+ * Request parameters for updateWorkspaceMember operation in DefaultApi.
5719
+ * @export
5720
+ * @interface DefaultApiUpdateWorkspaceMemberRequest
5721
+ */
5722
+ export interface DefaultApiUpdateWorkspaceMemberRequest {
5723
+ /**
5724
+ * Workspace member ID
5725
+ * @type {string}
5726
+ * @memberof DefaultApiUpdateWorkspaceMember
5727
+ */
5728
+ readonly id: string;
5729
+ /**
5730
+ * Workspace member metadata
5731
+ * @type {UpdateWorkspaceMemberBody}
5732
+ * @memberof DefaultApiUpdateWorkspaceMember
5733
+ */
5734
+ readonly updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody;
5735
+ }
4880
5736
  /**
4881
5737
  * DefaultApi - object-oriented interface
4882
5738
  * @export
@@ -4956,6 +5812,14 @@ export declare class DefaultApi extends BaseAPI {
4956
5812
  * @memberof DefaultApi
4957
5813
  */
4958
5814
  createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserResponse, any>>;
5815
+ /**
5816
+ * Add a member to the workspace
5817
+ * @param {DefaultApiCreateWorkspaceMemberRequest} requestParameters Request parameters.
5818
+ * @param {*} [options] Override http request option.
5819
+ * @throws {RequiredError}
5820
+ * @memberof DefaultApi
5821
+ */
5822
+ createWorkspaceMember(requestParameters?: DefaultApiCreateWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkspaceMemberResponse, any>>;
4959
5823
  /**
4960
5824
  * Delete bot
4961
5825
  * @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
@@ -5004,6 +5868,14 @@ export declare class DefaultApi extends BaseAPI {
5004
5868
  * @memberof DefaultApi
5005
5869
  */
5006
5870
  deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
5871
+ /**
5872
+ * Remove a member of a workspace
5873
+ * @param {DefaultApiDeleteWorkspaceMemberRequest} requestParameters Request parameters.
5874
+ * @param {*} [options] Override http request option.
5875
+ * @throws {RequiredError}
5876
+ * @memberof DefaultApi
5877
+ */
5878
+ deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
5007
5879
  /**
5008
5880
  * Download File
5009
5881
  * @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
@@ -5236,6 +6108,14 @@ export declare class DefaultApi extends BaseAPI {
5236
6108
  * @memberof DefaultApi
5237
6109
  */
5238
6110
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsersResponse, any>>;
6111
+ /**
6112
+ * Lists all the members in a workspace
6113
+ * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
6114
+ * @param {*} [options] Override http request option.
6115
+ * @throws {RequiredError}
6116
+ * @memberof DefaultApi
6117
+ */
6118
+ listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceMembersResponse, any>>;
5239
6119
  /**
5240
6120
  * List workspaces the user has access to
5241
6121
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -5308,4 +6188,60 @@ export declare class DefaultApi extends BaseAPI {
5308
6188
  * @memberof DefaultApi
5309
6189
  */
5310
6190
  updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponse, any>>;
6191
+ /**
6192
+ * Update workspace
6193
+ * @param {DefaultApiUpdateWorkspaceRequest} requestParameters Request parameters.
6194
+ * @param {*} [options] Override http request option.
6195
+ * @throws {RequiredError}
6196
+ * @memberof DefaultApi
6197
+ */
6198
+ updateWorkspace(requestParameters: DefaultApiUpdateWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkspaceResponse, any>>;
6199
+ /**
6200
+ * Update the member of a workspace
6201
+ * @param {DefaultApiUpdateWorkspaceMemberRequest} requestParameters Request parameters.
6202
+ * @param {*} [options] Override http request option.
6203
+ * @throws {RequiredError}
6204
+ * @memberof DefaultApi
6205
+ */
6206
+ updateWorkspaceMember(requestParameters: DefaultApiUpdateWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkspaceMemberResponse, any>>;
5311
6207
  }
6208
+ /**
6209
+ * @export
6210
+ */
6211
+ export declare const GetBotWebchatTypeEnum: {
6212
+ readonly Preconfigured: "preconfigured";
6213
+ readonly Configurable: "configurable";
6214
+ readonly Fullscreen: "fullscreen";
6215
+ readonly SharableUrl: "sharableUrl";
6216
+ };
6217
+ export type GetBotWebchatTypeEnum = typeof GetBotWebchatTypeEnum[keyof typeof GetBotWebchatTypeEnum];
6218
+ /**
6219
+ * @export
6220
+ */
6221
+ export declare const GetStateTypeEnum: {
6222
+ readonly Conversation: "conversation";
6223
+ readonly User: "user";
6224
+ readonly Bot: "bot";
6225
+ readonly Integration: "integration";
6226
+ };
6227
+ export type GetStateTypeEnum = typeof GetStateTypeEnum[keyof typeof GetStateTypeEnum];
6228
+ /**
6229
+ * @export
6230
+ */
6231
+ export declare const PatchStateTypeEnum: {
6232
+ readonly Conversation: "conversation";
6233
+ readonly User: "user";
6234
+ readonly Bot: "bot";
6235
+ readonly Integration: "integration";
6236
+ };
6237
+ export type PatchStateTypeEnum = typeof PatchStateTypeEnum[keyof typeof PatchStateTypeEnum];
6238
+ /**
6239
+ * @export
6240
+ */
6241
+ export declare const SetStateTypeEnum: {
6242
+ readonly Conversation: "conversation";
6243
+ readonly User: "user";
6244
+ readonly Bot: "bot";
6245
+ readonly Integration: "integration";
6246
+ };
6247
+ export type SetStateTypeEnum = typeof SetStateTypeEnum[keyof typeof SetStateTypeEnum];