@botpress/client 0.1.0 → 0.1.2

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.2
5
+ * The version of the OpenAPI document: 0.3.3
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -212,6 +212,12 @@ export interface BotIntegrationsValue {
212
212
  * @memberof BotIntegrationsValue
213
213
  */
214
214
  'status': BotIntegrationsValueStatusEnum;
215
+ /**
216
+ *
217
+ * @type {string}
218
+ * @memberof BotIntegrationsValue
219
+ */
220
+ 'statusReason': string | null;
215
221
  }
216
222
  export declare const BotIntegrationsValueStatusEnum: {
217
223
  readonly RegistrationPending: "registration_pending";
@@ -479,6 +485,18 @@ export interface CreateBotBodyConfiguration {
479
485
  * @interface CreateBotBodyEventsValue
480
486
  */
481
487
  export interface CreateBotBodyEventsValue {
488
+ /**
489
+ * Title of the event
490
+ * @type {string}
491
+ * @memberof CreateBotBodyEventsValue
492
+ */
493
+ 'title'?: string;
494
+ /**
495
+ * Description of the event
496
+ * @type {string}
497
+ * @memberof CreateBotBodyEventsValue
498
+ */
499
+ 'description'?: string;
482
500
  /**
483
501
  *
484
502
  * @type {{ [key: string]: any; }}
@@ -886,6 +904,18 @@ export interface CreateIntegrationBody {
886
904
  * @interface CreateIntegrationBodyActionsValue
887
905
  */
888
906
  export interface CreateIntegrationBodyActionsValue {
907
+ /**
908
+ * Title of the action
909
+ * @type {string}
910
+ * @memberof CreateIntegrationBodyActionsValue
911
+ */
912
+ 'title'?: string;
913
+ /**
914
+ * Description of the action
915
+ * @type {string}
916
+ * @memberof CreateIntegrationBodyActionsValue
917
+ */
918
+ 'description'?: string;
889
919
  /**
890
920
  *
891
921
  * @type {CreateIntegrationBodyActionsValueInput}
@@ -920,6 +950,18 @@ export interface CreateIntegrationBodyActionsValueInput {
920
950
  * @interface CreateIntegrationBodyChannelsValue
921
951
  */
922
952
  export interface CreateIntegrationBodyChannelsValue {
953
+ /**
954
+ * Title of the channel
955
+ * @type {string}
956
+ * @memberof CreateIntegrationBodyChannelsValue
957
+ */
958
+ 'title'?: string;
959
+ /**
960
+ * Description of the channel
961
+ * @type {string}
962
+ * @memberof CreateIntegrationBodyChannelsValue
963
+ */
964
+ 'description'?: string;
923
965
  /**
924
966
  *
925
967
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
@@ -1124,7 +1166,7 @@ export interface CreateMessageBody {
1124
1166
  */
1125
1167
  'type': string;
1126
1168
  /**
1127
- * 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.
1169
+ * Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) 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.
1128
1170
  * @type {{ [key: string]: string; }}
1129
1171
  * @memberof CreateMessageBody
1130
1172
  */
@@ -1204,6 +1246,74 @@ export interface CreateUserResponse {
1204
1246
  */
1205
1247
  'user': User;
1206
1248
  }
1249
+ /**
1250
+ *
1251
+ * @export
1252
+ * @interface CreateWorkspaceMemberBody
1253
+ */
1254
+ export interface CreateWorkspaceMemberBody {
1255
+ /**
1256
+ *
1257
+ * @type {string}
1258
+ * @memberof CreateWorkspaceMemberBody
1259
+ */
1260
+ 'email': string;
1261
+ /**
1262
+ *
1263
+ * @type {string}
1264
+ * @memberof CreateWorkspaceMemberBody
1265
+ */
1266
+ 'role': CreateWorkspaceMemberBodyRoleEnum;
1267
+ }
1268
+ export declare const CreateWorkspaceMemberBodyRoleEnum: {
1269
+ readonly Viewer: "viewer";
1270
+ readonly Billing: "billing";
1271
+ readonly Developer: "developer";
1272
+ readonly Manager: "manager";
1273
+ readonly Administrator: "administrator";
1274
+ readonly Owner: "owner";
1275
+ };
1276
+ export type CreateWorkspaceMemberBodyRoleEnum = typeof CreateWorkspaceMemberBodyRoleEnum[keyof typeof CreateWorkspaceMemberBodyRoleEnum];
1277
+ /**
1278
+ *
1279
+ * @export
1280
+ * @interface CreateWorkspaceMemberResponse
1281
+ */
1282
+ export interface CreateWorkspaceMemberResponse {
1283
+ /**
1284
+ *
1285
+ * @type {string}
1286
+ * @memberof CreateWorkspaceMemberResponse
1287
+ */
1288
+ 'id': string;
1289
+ /**
1290
+ *
1291
+ * @type {string}
1292
+ * @memberof CreateWorkspaceMemberResponse
1293
+ */
1294
+ 'userId'?: string;
1295
+ /**
1296
+ *
1297
+ * @type {string}
1298
+ * @memberof CreateWorkspaceMemberResponse
1299
+ */
1300
+ 'email': string;
1301
+ /**
1302
+ *
1303
+ * @type {string}
1304
+ * @memberof CreateWorkspaceMemberResponse
1305
+ */
1306
+ 'role': CreateWorkspaceMemberResponseRoleEnum;
1307
+ }
1308
+ export declare const CreateWorkspaceMemberResponseRoleEnum: {
1309
+ readonly Viewer: "viewer";
1310
+ readonly Billing: "billing";
1311
+ readonly Developer: "developer";
1312
+ readonly Manager: "manager";
1313
+ readonly Administrator: "administrator";
1314
+ readonly Owner: "owner";
1315
+ };
1316
+ export type CreateWorkspaceMemberResponseRoleEnum = typeof CreateWorkspaceMemberResponseRoleEnum[keyof typeof CreateWorkspaceMemberResponseRoleEnum];
1207
1317
  /**
1208
1318
  * The event object represents an action or an occurrence.
1209
1319
  * @export
@@ -1521,7 +1631,7 @@ export interface GetOrCreateMessageBody {
1521
1631
  */
1522
1632
  'type': string;
1523
1633
  /**
1524
- * 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.
1634
+ * Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) 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.
1525
1635
  * @type {{ [key: string]: string; }}
1526
1636
  * @memberof GetOrCreateMessageBody
1527
1637
  */
@@ -1670,12 +1780,18 @@ export interface GetWorkspaceResponse {
1670
1780
  * @memberof GetWorkspaceResponse
1671
1781
  */
1672
1782
  'updatedAt': string;
1783
+ /**
1784
+ *
1785
+ * @type {number}
1786
+ * @memberof GetWorkspaceResponse
1787
+ */
1788
+ 'botCount': number;
1673
1789
  /**
1674
1790
  *
1675
1791
  * @type {string}
1676
1792
  * @memberof GetWorkspaceResponse
1677
1793
  */
1678
- 'accountType': string;
1794
+ 'accountType': GetWorkspaceResponseAccountTypeEnum;
1679
1795
  /**
1680
1796
  *
1681
1797
  * @type {boolean}
@@ -1689,6 +1805,11 @@ export interface GetWorkspaceResponse {
1689
1805
  */
1690
1806
  'spendingLimit': number;
1691
1807
  }
1808
+ export declare const GetWorkspaceResponseAccountTypeEnum: {
1809
+ readonly Free: "free";
1810
+ readonly Premium: "premium";
1811
+ };
1812
+ export type GetWorkspaceResponseAccountTypeEnum = typeof GetWorkspaceResponseAccountTypeEnum[keyof typeof GetWorkspaceResponseAccountTypeEnum];
1692
1813
  /**
1693
1814
  *
1694
1815
  * @export
@@ -1806,6 +1927,18 @@ export interface Integration {
1806
1927
  * @interface IntegrationChannelsValue
1807
1928
  */
1808
1929
  export interface IntegrationChannelsValue {
1930
+ /**
1931
+ * Title of the channel
1932
+ * @type {string}
1933
+ * @memberof IntegrationChannelsValue
1934
+ */
1935
+ 'title'?: string;
1936
+ /**
1937
+ * Description of the channel
1938
+ * @type {string}
1939
+ * @memberof IntegrationChannelsValue
1940
+ */
1941
+ 'description'?: string;
1809
1942
  /**
1810
1943
  *
1811
1944
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
@@ -2164,6 +2297,65 @@ export interface ListUsersResponse {
2164
2297
  */
2165
2298
  'meta': ListConversationsResponseMeta;
2166
2299
  }
2300
+ /**
2301
+ *
2302
+ * @export
2303
+ * @interface ListWorkspaceMembersResponse
2304
+ */
2305
+ export interface ListWorkspaceMembersResponse {
2306
+ /**
2307
+ *
2308
+ * @type {Array<ListWorkspaceMembersResponseMembersInner>}
2309
+ * @memberof ListWorkspaceMembersResponse
2310
+ */
2311
+ 'members': Array<ListWorkspaceMembersResponseMembersInner>;
2312
+ /**
2313
+ *
2314
+ * @type {ListConversationsResponseMeta}
2315
+ * @memberof ListWorkspaceMembersResponse
2316
+ */
2317
+ 'meta': ListConversationsResponseMeta;
2318
+ }
2319
+ /**
2320
+ *
2321
+ * @export
2322
+ * @interface ListWorkspaceMembersResponseMembersInner
2323
+ */
2324
+ export interface ListWorkspaceMembersResponseMembersInner {
2325
+ /**
2326
+ *
2327
+ * @type {string}
2328
+ * @memberof ListWorkspaceMembersResponseMembersInner
2329
+ */
2330
+ 'id': string;
2331
+ /**
2332
+ *
2333
+ * @type {string}
2334
+ * @memberof ListWorkspaceMembersResponseMembersInner
2335
+ */
2336
+ 'userId'?: string;
2337
+ /**
2338
+ *
2339
+ * @type {string}
2340
+ * @memberof ListWorkspaceMembersResponseMembersInner
2341
+ */
2342
+ 'email': string;
2343
+ /**
2344
+ *
2345
+ * @type {string}
2346
+ * @memberof ListWorkspaceMembersResponseMembersInner
2347
+ */
2348
+ 'role': ListWorkspaceMembersResponseMembersInnerRoleEnum;
2349
+ }
2350
+ export declare const ListWorkspaceMembersResponseMembersInnerRoleEnum: {
2351
+ readonly Viewer: "viewer";
2352
+ readonly Billing: "billing";
2353
+ readonly Developer: "developer";
2354
+ readonly Manager: "manager";
2355
+ readonly Administrator: "administrator";
2356
+ readonly Owner: "owner";
2357
+ };
2358
+ export type ListWorkspaceMembersResponseMembersInnerRoleEnum = typeof ListWorkspaceMembersResponseMembersInnerRoleEnum[keyof typeof ListWorkspaceMembersResponseMembersInnerRoleEnum];
2167
2359
  /**
2168
2360
  *
2169
2361
  * @export
@@ -2219,7 +2411,24 @@ export interface ListWorkspacesResponseWorkspacesInner {
2219
2411
  * @memberof ListWorkspacesResponseWorkspacesInner
2220
2412
  */
2221
2413
  'updatedAt': string;
2414
+ /**
2415
+ *
2416
+ * @type {number}
2417
+ * @memberof ListWorkspacesResponseWorkspacesInner
2418
+ */
2419
+ 'botCount': number;
2420
+ /**
2421
+ *
2422
+ * @type {string}
2423
+ * @memberof ListWorkspacesResponseWorkspacesInner
2424
+ */
2425
+ 'accountType': ListWorkspacesResponseWorkspacesInnerAccountTypeEnum;
2222
2426
  }
2427
+ export declare const ListWorkspacesResponseWorkspacesInnerAccountTypeEnum: {
2428
+ readonly Free: "free";
2429
+ readonly Premium: "premium";
2430
+ };
2431
+ export type ListWorkspacesResponseWorkspacesInnerAccountTypeEnum = typeof ListWorkspacesResponseWorkspacesInnerAccountTypeEnum[keyof typeof ListWorkspacesResponseWorkspacesInnerAccountTypeEnum];
2223
2432
  /**
2224
2433
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
2225
2434
  * @export
@@ -2592,6 +2801,18 @@ export type UpdateBotBodyAuthenticationEnum = typeof UpdateBotBodyAuthentication
2592
2801
  * @interface UpdateBotBodyEventsValue
2593
2802
  */
2594
2803
  export interface UpdateBotBodyEventsValue {
2804
+ /**
2805
+ * Title of the event
2806
+ * @type {string}
2807
+ * @memberof UpdateBotBodyEventsValue
2808
+ */
2809
+ 'title'?: string;
2810
+ /**
2811
+ * Description of the event
2812
+ * @type {string}
2813
+ * @memberof UpdateBotBodyEventsValue
2814
+ */
2815
+ 'description'?: string;
2595
2816
  /**
2596
2817
  *
2597
2818
  * @type {{ [key: string]: any; }}
@@ -2612,13 +2833,13 @@ export interface UpdateBotBodyIntegrationsValue {
2612
2833
  * @type {boolean}
2613
2834
  * @memberof UpdateBotBodyIntegrationsValue
2614
2835
  */
2615
- 'enabled': boolean;
2836
+ 'enabled'?: boolean;
2616
2837
  /**
2617
2838
  *
2618
2839
  * @type {{ [key: string]: any; }}
2619
2840
  * @memberof UpdateBotBodyIntegrationsValue
2620
2841
  */
2621
- 'configuration': {
2842
+ 'configuration'?: {
2622
2843
  [key: string]: any;
2623
2844
  };
2624
2845
  }
@@ -2777,11 +2998,11 @@ export interface UpdateIntegrationBody {
2777
2998
  'configuration'?: CreateIntegrationBodyConfiguration;
2778
2999
  /**
2779
3000
  *
2780
- * @type {{ [key: string]: UpdateIntegrationBodyChannelsValue; }}
3001
+ * @type {{ [key: string]: UpdateIntegrationBodyChannelsValue | null; }}
2781
3002
  * @memberof UpdateIntegrationBody
2782
3003
  */
2783
3004
  'channels'?: {
2784
- [key: string]: UpdateIntegrationBodyChannelsValue;
3005
+ [key: string]: UpdateIntegrationBodyChannelsValue | null;
2785
3006
  };
2786
3007
  /**
2787
3008
  *
@@ -2856,6 +3077,18 @@ export interface UpdateIntegrationBody {
2856
3077
  * @interface UpdateIntegrationBodyActionsValue
2857
3078
  */
2858
3079
  export interface UpdateIntegrationBodyActionsValue {
3080
+ /**
3081
+ * Title of the action
3082
+ * @type {string}
3083
+ * @memberof UpdateIntegrationBodyActionsValue
3084
+ */
3085
+ 'title'?: string;
3086
+ /**
3087
+ * Description of the action
3088
+ * @type {string}
3089
+ * @memberof UpdateIntegrationBodyActionsValue
3090
+ */
3091
+ 'description'?: string;
2859
3092
  /**
2860
3093
  *
2861
3094
  * @type {CreateIntegrationBodyActionsValueInput}
@@ -2875,6 +3108,18 @@ export interface UpdateIntegrationBodyActionsValue {
2875
3108
  * @interface UpdateIntegrationBodyChannelsValue
2876
3109
  */
2877
3110
  export interface UpdateIntegrationBodyChannelsValue {
3111
+ /**
3112
+ * Title of the channel
3113
+ * @type {string}
3114
+ * @memberof UpdateIntegrationBodyChannelsValue
3115
+ */
3116
+ 'title'?: string;
3117
+ /**
3118
+ * Description of the channel
3119
+ * @type {string}
3120
+ * @memberof UpdateIntegrationBodyChannelsValue
3121
+ */
3122
+ 'description'?: string;
2878
3123
  /**
2879
3124
  *
2880
3125
  * @type {{ [key: string]: UpdateIntegrationBodyChannelsValueMessagesValue | null; }}
@@ -3049,6 +3294,164 @@ export interface UpdateUserResponse {
3049
3294
  */
3050
3295
  'user': User;
3051
3296
  }
3297
+ /**
3298
+ *
3299
+ * @export
3300
+ * @interface UpdateWorkspaceBody
3301
+ */
3302
+ export interface UpdateWorkspaceBody {
3303
+ /**
3304
+ *
3305
+ * @type {string}
3306
+ * @memberof UpdateWorkspaceBody
3307
+ */
3308
+ 'name'?: string;
3309
+ /**
3310
+ *
3311
+ * @type {string}
3312
+ * @memberof UpdateWorkspaceBody
3313
+ */
3314
+ 'accountType'?: UpdateWorkspaceBodyAccountTypeEnum;
3315
+ /**
3316
+ *
3317
+ * @type {number}
3318
+ * @memberof UpdateWorkspaceBody
3319
+ */
3320
+ 'spendingLimit'?: number;
3321
+ }
3322
+ export declare const UpdateWorkspaceBodyAccountTypeEnum: {
3323
+ readonly Free: "free";
3324
+ readonly Premium: "premium";
3325
+ };
3326
+ export type UpdateWorkspaceBodyAccountTypeEnum = typeof UpdateWorkspaceBodyAccountTypeEnum[keyof typeof UpdateWorkspaceBodyAccountTypeEnum];
3327
+ /**
3328
+ *
3329
+ * @export
3330
+ * @interface UpdateWorkspaceMemberBody
3331
+ */
3332
+ export interface UpdateWorkspaceMemberBody {
3333
+ /**
3334
+ *
3335
+ * @type {string}
3336
+ * @memberof UpdateWorkspaceMemberBody
3337
+ */
3338
+ 'role'?: UpdateWorkspaceMemberBodyRoleEnum;
3339
+ }
3340
+ export declare const UpdateWorkspaceMemberBodyRoleEnum: {
3341
+ readonly Viewer: "viewer";
3342
+ readonly Billing: "billing";
3343
+ readonly Developer: "developer";
3344
+ readonly Manager: "manager";
3345
+ readonly Administrator: "administrator";
3346
+ readonly Owner: "owner";
3347
+ };
3348
+ export type UpdateWorkspaceMemberBodyRoleEnum = typeof UpdateWorkspaceMemberBodyRoleEnum[keyof typeof UpdateWorkspaceMemberBodyRoleEnum];
3349
+ /**
3350
+ *
3351
+ * @export
3352
+ * @interface UpdateWorkspaceMemberResponse
3353
+ */
3354
+ export interface UpdateWorkspaceMemberResponse {
3355
+ /**
3356
+ *
3357
+ * @type {string}
3358
+ * @memberof UpdateWorkspaceMemberResponse
3359
+ */
3360
+ 'id': string;
3361
+ /**
3362
+ *
3363
+ * @type {string}
3364
+ * @memberof UpdateWorkspaceMemberResponse
3365
+ */
3366
+ 'userId'?: string;
3367
+ /**
3368
+ *
3369
+ * @type {string}
3370
+ * @memberof UpdateWorkspaceMemberResponse
3371
+ */
3372
+ 'email': string;
3373
+ /**
3374
+ *
3375
+ * @type {string}
3376
+ * @memberof UpdateWorkspaceMemberResponse
3377
+ */
3378
+ 'role': UpdateWorkspaceMemberResponseRoleEnum;
3379
+ }
3380
+ export declare const UpdateWorkspaceMemberResponseRoleEnum: {
3381
+ readonly Viewer: "viewer";
3382
+ readonly Billing: "billing";
3383
+ readonly Developer: "developer";
3384
+ readonly Manager: "manager";
3385
+ readonly Administrator: "administrator";
3386
+ readonly Owner: "owner";
3387
+ };
3388
+ export type UpdateWorkspaceMemberResponseRoleEnum = typeof UpdateWorkspaceMemberResponseRoleEnum[keyof typeof UpdateWorkspaceMemberResponseRoleEnum];
3389
+ /**
3390
+ *
3391
+ * @export
3392
+ * @interface UpdateWorkspaceResponse
3393
+ */
3394
+ export interface UpdateWorkspaceResponse {
3395
+ /**
3396
+ *
3397
+ * @type {string}
3398
+ * @memberof UpdateWorkspaceResponse
3399
+ */
3400
+ 'id': string;
3401
+ /**
3402
+ *
3403
+ * @type {string}
3404
+ * @memberof UpdateWorkspaceResponse
3405
+ */
3406
+ 'name': string;
3407
+ /**
3408
+ *
3409
+ * @type {string}
3410
+ * @memberof UpdateWorkspaceResponse
3411
+ */
3412
+ 'ownerId': string;
3413
+ /**
3414
+ *
3415
+ * @type {string}
3416
+ * @memberof UpdateWorkspaceResponse
3417
+ */
3418
+ 'createdAt': string;
3419
+ /**
3420
+ *
3421
+ * @type {string}
3422
+ * @memberof UpdateWorkspaceResponse
3423
+ */
3424
+ 'updatedAt': string;
3425
+ /**
3426
+ *
3427
+ * @type {number}
3428
+ * @memberof UpdateWorkspaceResponse
3429
+ */
3430
+ 'botCount': number;
3431
+ /**
3432
+ *
3433
+ * @type {string}
3434
+ * @memberof UpdateWorkspaceResponse
3435
+ */
3436
+ 'accountType': UpdateWorkspaceResponseAccountTypeEnum;
3437
+ /**
3438
+ *
3439
+ * @type {boolean}
3440
+ * @memberof UpdateWorkspaceResponse
3441
+ */
3442
+ 'blocked': boolean;
3443
+ /**
3444
+ *
3445
+ * @type {number}
3446
+ * @memberof UpdateWorkspaceResponse
3447
+ */
3448
+ 'spendingLimit': number;
3449
+ }
3450
+ export declare const UpdateWorkspaceResponseAccountTypeEnum: {
3451
+ readonly Free: "free";
3452
+ readonly Premium: "premium";
3453
+ };
3454
+ export type UpdateWorkspaceResponseAccountTypeEnum = typeof UpdateWorkspaceResponseAccountTypeEnum[keyof typeof UpdateWorkspaceResponseAccountTypeEnum];
3052
3455
  /**
3053
3456
  * 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.
3054
3457
  * @export
@@ -3118,12 +3521,18 @@ export interface Workspace {
3118
3521
  * @memberof Workspace
3119
3522
  */
3120
3523
  'updatedAt': string;
3524
+ /**
3525
+ *
3526
+ * @type {number}
3527
+ * @memberof Workspace
3528
+ */
3529
+ 'botCount': number;
3121
3530
  /**
3122
3531
  *
3123
3532
  * @type {string}
3124
3533
  * @memberof Workspace
3125
3534
  */
3126
- 'accountType': string;
3535
+ 'accountType': WorkspaceAccountTypeEnum;
3127
3536
  /**
3128
3537
  *
3129
3538
  * @type {boolean}
@@ -3137,6 +3546,11 @@ export interface Workspace {
3137
3546
  */
3138
3547
  'spendingLimit': number;
3139
3548
  }
3549
+ export declare const WorkspaceAccountTypeEnum: {
3550
+ readonly Free: "free";
3551
+ readonly Premium: "premium";
3552
+ };
3553
+ export type WorkspaceAccountTypeEnum = typeof WorkspaceAccountTypeEnum[keyof typeof WorkspaceAccountTypeEnum];
3140
3554
  /**
3141
3555
  * DefaultApi - axios parameter creator
3142
3556
  * @export
@@ -3205,6 +3619,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3205
3619
  * @throws {RequiredError}
3206
3620
  */
3207
3621
  createUser: (createUserBody?: CreateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3622
+ /**
3623
+ * Add a member to the workspace
3624
+ * @param {CreateWorkspaceMemberBody} [createWorkspaceMemberBody] Workspace member metadata
3625
+ * @param {*} [options] Override http request option.
3626
+ * @throws {RequiredError}
3627
+ */
3628
+ createWorkspaceMember: (createWorkspaceMemberBody?: CreateWorkspaceMemberBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3208
3629
  /**
3209
3630
  * Delete bot
3210
3631
  * @param {string} id Bot ID
@@ -3247,6 +3668,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3247
3668
  * @throws {RequiredError}
3248
3669
  */
3249
3670
  deleteUser: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3671
+ /**
3672
+ * Remove a member of a workspace
3673
+ * @param {string} id Workspace member ID
3674
+ * @param {*} [options] Override http request option.
3675
+ * @throws {RequiredError}
3676
+ */
3677
+ deleteWorkspaceMember: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3250
3678
  /**
3251
3679
  * Download File
3252
3680
  * @param {string} id File ID
@@ -3475,6 +3903,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3475
3903
  listUsers: (nextToken?: string, conversationId?: string, tags?: {
3476
3904
  [key: string]: string;
3477
3905
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3906
+ /**
3907
+ * Lists all the members in a workspace
3908
+ * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3909
+ * @param {*} [options] Override http request option.
3910
+ * @throws {RequiredError}
3911
+ */
3912
+ listWorkspaceMembers: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3478
3913
  /**
3479
3914
  * List workspaces the user has access to
3480
3915
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -3550,6 +3985,22 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3550
3985
  * @throws {RequiredError}
3551
3986
  */
3552
3987
  updateUser: (id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3988
+ /**
3989
+ * Update workspace
3990
+ * @param {string} id Workspace ID
3991
+ * @param {UpdateWorkspaceBody} [updateWorkspaceBody] Workspace metadata
3992
+ * @param {*} [options] Override http request option.
3993
+ * @throws {RequiredError}
3994
+ */
3995
+ updateWorkspace: (id: string, updateWorkspaceBody?: UpdateWorkspaceBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3996
+ /**
3997
+ * Update the member of a workspace
3998
+ * @param {string} id Workspace member ID
3999
+ * @param {UpdateWorkspaceMemberBody} [updateWorkspaceMemberBody] Workspace member metadata
4000
+ * @param {*} [options] Override http request option.
4001
+ * @throws {RequiredError}
4002
+ */
4003
+ updateWorkspaceMember: (id: string, updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3553
4004
  };
3554
4005
  /**
3555
4006
  * DefaultApi - functional programming interface
@@ -3619,6 +4070,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3619
4070
  * @throws {RequiredError}
3620
4071
  */
3621
4072
  createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponse>>;
4073
+ /**
4074
+ * Add a member to the workspace
4075
+ * @param {CreateWorkspaceMemberBody} [createWorkspaceMemberBody] Workspace member metadata
4076
+ * @param {*} [options] Override http request option.
4077
+ * @throws {RequiredError}
4078
+ */
4079
+ createWorkspaceMember(createWorkspaceMemberBody?: CreateWorkspaceMemberBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkspaceMemberResponse>>;
3622
4080
  /**
3623
4081
  * Delete bot
3624
4082
  * @param {string} id Bot ID
@@ -3661,6 +4119,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3661
4119
  * @throws {RequiredError}
3662
4120
  */
3663
4121
  deleteUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
4122
+ /**
4123
+ * Remove a member of a workspace
4124
+ * @param {string} id Workspace member ID
4125
+ * @param {*} [options] Override http request option.
4126
+ * @throws {RequiredError}
4127
+ */
4128
+ deleteWorkspaceMember(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
3664
4129
  /**
3665
4130
  * Download File
3666
4131
  * @param {string} id File ID
@@ -3889,6 +4354,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3889
4354
  listUsers(nextToken?: string, conversationId?: string, tags?: {
3890
4355
  [key: string]: string;
3891
4356
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
4357
+ /**
4358
+ * Lists all the members in a workspace
4359
+ * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4360
+ * @param {*} [options] Override http request option.
4361
+ * @throws {RequiredError}
4362
+ */
4363
+ listWorkspaceMembers(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceMembersResponse>>;
3892
4364
  /**
3893
4365
  * List workspaces the user has access to
3894
4366
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -3964,6 +4436,22 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3964
4436
  * @throws {RequiredError}
3965
4437
  */
3966
4438
  updateUser(id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponse>>;
4439
+ /**
4440
+ * Update workspace
4441
+ * @param {string} id Workspace ID
4442
+ * @param {UpdateWorkspaceBody} [updateWorkspaceBody] Workspace metadata
4443
+ * @param {*} [options] Override http request option.
4444
+ * @throws {RequiredError}
4445
+ */
4446
+ updateWorkspace(id: string, updateWorkspaceBody?: UpdateWorkspaceBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkspaceResponse>>;
4447
+ /**
4448
+ * Update the member of a workspace
4449
+ * @param {string} id Workspace member ID
4450
+ * @param {UpdateWorkspaceMemberBody} [updateWorkspaceMemberBody] Workspace member metadata
4451
+ * @param {*} [options] Override http request option.
4452
+ * @throws {RequiredError}
4453
+ */
4454
+ updateWorkspaceMember(id: string, updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkspaceMemberResponse>>;
3967
4455
  };
3968
4456
  /**
3969
4457
  * DefaultApi - factory interface
@@ -4033,6 +4521,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
4033
4521
  * @throws {RequiredError}
4034
4522
  */
4035
4523
  createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
4524
+ /**
4525
+ * Add a member to the workspace
4526
+ * @param {DefaultApiCreateWorkspaceMemberRequest} requestParameters Request parameters.
4527
+ * @param {*} [options] Override http request option.
4528
+ * @throws {RequiredError}
4529
+ */
4530
+ createWorkspaceMember(requestParameters?: DefaultApiCreateWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<CreateWorkspaceMemberResponse>;
4036
4531
  /**
4037
4532
  * Delete bot
4038
4533
  * @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
@@ -4075,6 +4570,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
4075
4570
  * @throws {RequiredError}
4076
4571
  */
4077
4572
  deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
4573
+ /**
4574
+ * Remove a member of a workspace
4575
+ * @param {DefaultApiDeleteWorkspaceMemberRequest} requestParameters Request parameters.
4576
+ * @param {*} [options] Override http request option.
4577
+ * @throws {RequiredError}
4578
+ */
4579
+ deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
4078
4580
  /**
4079
4581
  * Download File
4080
4582
  * @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
@@ -4278,6 +4780,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
4278
4780
  * @throws {RequiredError}
4279
4781
  */
4280
4782
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
4783
+ /**
4784
+ * Lists all the members in a workspace
4785
+ * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
4786
+ * @param {*} [options] Override http request option.
4787
+ * @throws {RequiredError}
4788
+ */
4789
+ listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceMembersResponse>;
4281
4790
  /**
4282
4791
  * List workspaces the user has access to
4283
4792
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -4341,6 +4850,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
4341
4850
  * @throws {RequiredError}
4342
4851
  */
4343
4852
  updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
4853
+ /**
4854
+ * Update workspace
4855
+ * @param {DefaultApiUpdateWorkspaceRequest} requestParameters Request parameters.
4856
+ * @param {*} [options] Override http request option.
4857
+ * @throws {RequiredError}
4858
+ */
4859
+ updateWorkspace(requestParameters: DefaultApiUpdateWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateWorkspaceResponse>;
4860
+ /**
4861
+ * Update the member of a workspace
4862
+ * @param {DefaultApiUpdateWorkspaceMemberRequest} requestParameters Request parameters.
4863
+ * @param {*} [options] Override http request option.
4864
+ * @throws {RequiredError}
4865
+ */
4866
+ updateWorkspaceMember(requestParameters: DefaultApiUpdateWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateWorkspaceMemberResponse>;
4344
4867
  };
4345
4868
  /**
4346
4869
  * Request parameters for callAction operation in DefaultApi.
@@ -4459,6 +4982,19 @@ export interface DefaultApiCreateUserRequest {
4459
4982
  */
4460
4983
  readonly createUserBody?: CreateUserBody;
4461
4984
  }
4985
+ /**
4986
+ * Request parameters for createWorkspaceMember operation in DefaultApi.
4987
+ * @export
4988
+ * @interface DefaultApiCreateWorkspaceMemberRequest
4989
+ */
4990
+ export interface DefaultApiCreateWorkspaceMemberRequest {
4991
+ /**
4992
+ * Workspace member metadata
4993
+ * @type {CreateWorkspaceMemberBody}
4994
+ * @memberof DefaultApiCreateWorkspaceMember
4995
+ */
4996
+ readonly createWorkspaceMemberBody?: CreateWorkspaceMemberBody;
4997
+ }
4462
4998
  /**
4463
4999
  * Request parameters for deleteBot operation in DefaultApi.
4464
5000
  * @export
@@ -4537,6 +5073,19 @@ export interface DefaultApiDeleteUserRequest {
4537
5073
  */
4538
5074
  readonly id: string;
4539
5075
  }
5076
+ /**
5077
+ * Request parameters for deleteWorkspaceMember operation in DefaultApi.
5078
+ * @export
5079
+ * @interface DefaultApiDeleteWorkspaceMemberRequest
5080
+ */
5081
+ export interface DefaultApiDeleteWorkspaceMemberRequest {
5082
+ /**
5083
+ * Workspace member ID
5084
+ * @type {string}
5085
+ * @memberof DefaultApiDeleteWorkspaceMember
5086
+ */
5087
+ readonly id: string;
5088
+ }
4540
5089
  /**
4541
5090
  * Request parameters for downloadFile operation in DefaultApi.
4542
5091
  * @export
@@ -5034,6 +5583,19 @@ export interface DefaultApiListUsersRequest {
5034
5583
  [key: string]: string;
5035
5584
  };
5036
5585
  }
5586
+ /**
5587
+ * Request parameters for listWorkspaceMembers operation in DefaultApi.
5588
+ * @export
5589
+ * @interface DefaultApiListWorkspaceMembersRequest
5590
+ */
5591
+ export interface DefaultApiListWorkspaceMembersRequest {
5592
+ /**
5593
+ * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
5594
+ * @type {string}
5595
+ * @memberof DefaultApiListWorkspaceMembers
5596
+ */
5597
+ readonly nextToken?: string;
5598
+ }
5037
5599
  /**
5038
5600
  * Request parameters for listWorkspaces operation in DefaultApi.
5039
5601
  * @export
@@ -5223,6 +5785,44 @@ export interface DefaultApiUpdateUserRequest {
5223
5785
  */
5224
5786
  readonly updateUserBody?: UpdateUserBody;
5225
5787
  }
5788
+ /**
5789
+ * Request parameters for updateWorkspace operation in DefaultApi.
5790
+ * @export
5791
+ * @interface DefaultApiUpdateWorkspaceRequest
5792
+ */
5793
+ export interface DefaultApiUpdateWorkspaceRequest {
5794
+ /**
5795
+ * Workspace ID
5796
+ * @type {string}
5797
+ * @memberof DefaultApiUpdateWorkspace
5798
+ */
5799
+ readonly id: string;
5800
+ /**
5801
+ * Workspace metadata
5802
+ * @type {UpdateWorkspaceBody}
5803
+ * @memberof DefaultApiUpdateWorkspace
5804
+ */
5805
+ readonly updateWorkspaceBody?: UpdateWorkspaceBody;
5806
+ }
5807
+ /**
5808
+ * Request parameters for updateWorkspaceMember operation in DefaultApi.
5809
+ * @export
5810
+ * @interface DefaultApiUpdateWorkspaceMemberRequest
5811
+ */
5812
+ export interface DefaultApiUpdateWorkspaceMemberRequest {
5813
+ /**
5814
+ * Workspace member ID
5815
+ * @type {string}
5816
+ * @memberof DefaultApiUpdateWorkspaceMember
5817
+ */
5818
+ readonly id: string;
5819
+ /**
5820
+ * Workspace member metadata
5821
+ * @type {UpdateWorkspaceMemberBody}
5822
+ * @memberof DefaultApiUpdateWorkspaceMember
5823
+ */
5824
+ readonly updateWorkspaceMemberBody?: UpdateWorkspaceMemberBody;
5825
+ }
5226
5826
  /**
5227
5827
  * DefaultApi - object-oriented interface
5228
5828
  * @export
@@ -5302,6 +5902,14 @@ export declare class DefaultApi extends BaseAPI {
5302
5902
  * @memberof DefaultApi
5303
5903
  */
5304
5904
  createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserResponse, any>>;
5905
+ /**
5906
+ * Add a member to the workspace
5907
+ * @param {DefaultApiCreateWorkspaceMemberRequest} requestParameters Request parameters.
5908
+ * @param {*} [options] Override http request option.
5909
+ * @throws {RequiredError}
5910
+ * @memberof DefaultApi
5911
+ */
5912
+ createWorkspaceMember(requestParameters?: DefaultApiCreateWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkspaceMemberResponse, any>>;
5305
5913
  /**
5306
5914
  * Delete bot
5307
5915
  * @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
@@ -5350,6 +5958,14 @@ export declare class DefaultApi extends BaseAPI {
5350
5958
  * @memberof DefaultApi
5351
5959
  */
5352
5960
  deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
5961
+ /**
5962
+ * Remove a member of a workspace
5963
+ * @param {DefaultApiDeleteWorkspaceMemberRequest} requestParameters Request parameters.
5964
+ * @param {*} [options] Override http request option.
5965
+ * @throws {RequiredError}
5966
+ * @memberof DefaultApi
5967
+ */
5968
+ deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
5353
5969
  /**
5354
5970
  * Download File
5355
5971
  * @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
@@ -5582,6 +6198,14 @@ export declare class DefaultApi extends BaseAPI {
5582
6198
  * @memberof DefaultApi
5583
6199
  */
5584
6200
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsersResponse, any>>;
6201
+ /**
6202
+ * Lists all the members in a workspace
6203
+ * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
6204
+ * @param {*} [options] Override http request option.
6205
+ * @throws {RequiredError}
6206
+ * @memberof DefaultApi
6207
+ */
6208
+ listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceMembersResponse, any>>;
5585
6209
  /**
5586
6210
  * List workspaces the user has access to
5587
6211
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -5654,6 +6278,22 @@ export declare class DefaultApi extends BaseAPI {
5654
6278
  * @memberof DefaultApi
5655
6279
  */
5656
6280
  updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponse, any>>;
6281
+ /**
6282
+ * Update workspace
6283
+ * @param {DefaultApiUpdateWorkspaceRequest} requestParameters Request parameters.
6284
+ * @param {*} [options] Override http request option.
6285
+ * @throws {RequiredError}
6286
+ * @memberof DefaultApi
6287
+ */
6288
+ updateWorkspace(requestParameters: DefaultApiUpdateWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkspaceResponse, any>>;
6289
+ /**
6290
+ * Update the member of a workspace
6291
+ * @param {DefaultApiUpdateWorkspaceMemberRequest} requestParameters Request parameters.
6292
+ * @param {*} [options] Override http request option.
6293
+ * @throws {RequiredError}
6294
+ * @memberof DefaultApi
6295
+ */
6296
+ updateWorkspaceMember(requestParameters: DefaultApiUpdateWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkspaceMemberResponse, any>>;
5657
6297
  }
5658
6298
  /**
5659
6299
  * @export