@botpress/client 0.6.0 → 0.6.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.10.0
5
+ * The version of the OpenAPI document: 0.12.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -223,6 +223,12 @@ export interface BotIntegrationsValue {
223
223
  * @memberof BotIntegrationsValue
224
224
  */
225
225
  'webhookUrl': string;
226
+ /**
227
+ *
228
+ * @type {string}
229
+ * @memberof BotIntegrationsValue
230
+ */
231
+ 'webhookId': string;
226
232
  /**
227
233
  *
228
234
  * @type {{ [key: string]: any; }}
@@ -440,6 +446,12 @@ export interface ChangeWorkspacePlanResponse {
440
446
  * @memberof ChangeWorkspacePlanResponse
441
447
  */
442
448
  'accountType': ChangeWorkspacePlanResponseAccountTypeEnum;
449
+ /**
450
+ *
451
+ * @type {string}
452
+ * @memberof ChangeWorkspacePlanResponse
453
+ */
454
+ 'plan': ChangeWorkspacePlanResponsePlanEnum;
443
455
  /**
444
456
  *
445
457
  * @type {boolean}
@@ -458,6 +470,88 @@ export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
458
470
  readonly Premium: "premium";
459
471
  };
460
472
  export type ChangeWorkspacePlanResponseAccountTypeEnum = typeof ChangeWorkspacePlanResponseAccountTypeEnum[keyof typeof ChangeWorkspacePlanResponseAccountTypeEnum];
473
+ export declare const ChangeWorkspacePlanResponsePlanEnum: {
474
+ readonly Community: "community";
475
+ readonly Team: "team";
476
+ readonly Enterprise: "enterprise";
477
+ };
478
+ export type ChangeWorkspacePlanResponsePlanEnum = typeof ChangeWorkspacePlanResponsePlanEnum[keyof typeof ChangeWorkspacePlanResponsePlanEnum];
479
+ /**
480
+ *
481
+ * @export
482
+ * @interface ChargeWorkspaceUnpaidInvoicesBody
483
+ */
484
+ export interface ChargeWorkspaceUnpaidInvoicesBody {
485
+ /**
486
+ *
487
+ * @type {Array<string>}
488
+ * @memberof ChargeWorkspaceUnpaidInvoicesBody
489
+ */
490
+ 'invoiceIds'?: Array<string>;
491
+ }
492
+ /**
493
+ *
494
+ * @export
495
+ * @interface ChargeWorkspaceUnpaidInvoicesResponse
496
+ */
497
+ export interface ChargeWorkspaceUnpaidInvoicesResponse {
498
+ /**
499
+ * Invoices that were successfully charged by this request.
500
+ * @type {Array<ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner>}
501
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponse
502
+ */
503
+ 'chargedInvoices': Array<ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner>;
504
+ /**
505
+ * Invoices that failed to be charged by this request.
506
+ * @type {Array<ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner>}
507
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponse
508
+ */
509
+ 'failedInvoices': Array<ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner>;
510
+ }
511
+ /**
512
+ *
513
+ * @export
514
+ * @interface ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
515
+ */
516
+ export interface ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner {
517
+ /**
518
+ *
519
+ * @type {string}
520
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
521
+ */
522
+ 'id': string;
523
+ /**
524
+ *
525
+ * @type {number}
526
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
527
+ */
528
+ 'amount': number;
529
+ }
530
+ /**
531
+ *
532
+ * @export
533
+ * @interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
534
+ */
535
+ export interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner {
536
+ /**
537
+ *
538
+ * @type {string}
539
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
540
+ */
541
+ 'id': string;
542
+ /**
543
+ *
544
+ * @type {number}
545
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
546
+ */
547
+ 'amount': number;
548
+ /**
549
+ *
550
+ * @type {string}
551
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
552
+ */
553
+ 'failedReason': string;
554
+ }
461
555
  /**
462
556
  *
463
557
  * @export
@@ -508,7 +602,7 @@ export interface Conversation {
508
602
  */
509
603
  'integration': string;
510
604
  /**
511
- * 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.
605
+ * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
512
606
  * @type {{ [key: string]: string; }}
513
607
  * @memberof Conversation
514
608
  */
@@ -986,6 +1080,12 @@ export interface CreateIntegrationBody {
986
1080
  'actions'?: {
987
1081
  [key: string]: CreateIntegrationBodyActionsValue;
988
1082
  };
1083
+ /**
1084
+ *
1085
+ * @type {CreateIntegrationBodyIdentifier}
1086
+ * @memberof CreateIntegrationBody
1087
+ */
1088
+ 'identifier'?: CreateIntegrationBodyIdentifier;
989
1089
  /**
990
1090
  *
991
1091
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
@@ -1184,7 +1284,7 @@ export interface CreateIntegrationBodyChannelsValueMessagesValue {
1184
1284
  };
1185
1285
  }
1186
1286
  /**
1187
- * Configuration definition
1287
+ *
1188
1288
  * @export
1189
1289
  * @interface CreateIntegrationBodyConfiguration
1190
1290
  */
@@ -1194,9 +1294,47 @@ export interface CreateIntegrationBodyConfiguration {
1194
1294
  * @type {{ [key: string]: any; }}
1195
1295
  * @memberof CreateIntegrationBodyConfiguration
1196
1296
  */
1197
- 'schema': {
1297
+ 'schema'?: {
1198
1298
  [key: string]: any;
1199
1299
  };
1300
+ /**
1301
+ *
1302
+ * @type {CreateIntegrationBodyConfigurationIdentifier}
1303
+ * @memberof CreateIntegrationBodyConfiguration
1304
+ */
1305
+ 'identifier'?: CreateIntegrationBodyConfigurationIdentifier;
1306
+ }
1307
+ /**
1308
+ *
1309
+ * @export
1310
+ * @interface CreateIntegrationBodyConfigurationIdentifier
1311
+ */
1312
+ export interface CreateIntegrationBodyConfigurationIdentifier {
1313
+ /**
1314
+ *
1315
+ * @type {boolean}
1316
+ * @memberof CreateIntegrationBodyConfigurationIdentifier
1317
+ */
1318
+ 'required'?: boolean;
1319
+ /**
1320
+ *
1321
+ * @type {string}
1322
+ * @memberof CreateIntegrationBodyConfigurationIdentifier
1323
+ */
1324
+ 'linkTemplateScript'?: string;
1325
+ }
1326
+ /**
1327
+ *
1328
+ * @export
1329
+ * @interface CreateIntegrationBodyIdentifier
1330
+ */
1331
+ export interface CreateIntegrationBodyIdentifier {
1332
+ /**
1333
+ *
1334
+ * @type {string}
1335
+ * @memberof CreateIntegrationBodyIdentifier
1336
+ */
1337
+ 'extractScript'?: string;
1200
1338
  }
1201
1339
  /**
1202
1340
  * State definition
@@ -1577,6 +1715,12 @@ export interface CreateWorkspaceResponse {
1577
1715
  * @memberof CreateWorkspaceResponse
1578
1716
  */
1579
1717
  'accountType': CreateWorkspaceResponseAccountTypeEnum;
1718
+ /**
1719
+ *
1720
+ * @type {string}
1721
+ * @memberof CreateWorkspaceResponse
1722
+ */
1723
+ 'plan': CreateWorkspaceResponsePlanEnum;
1580
1724
  /**
1581
1725
  *
1582
1726
  * @type {boolean}
@@ -1595,6 +1739,12 @@ export declare const CreateWorkspaceResponseAccountTypeEnum: {
1595
1739
  readonly Premium: "premium";
1596
1740
  };
1597
1741
  export type CreateWorkspaceResponseAccountTypeEnum = typeof CreateWorkspaceResponseAccountTypeEnum[keyof typeof CreateWorkspaceResponseAccountTypeEnum];
1742
+ export declare const CreateWorkspaceResponsePlanEnum: {
1743
+ readonly Community: "community";
1744
+ readonly Team: "team";
1745
+ readonly Enterprise: "enterprise";
1746
+ };
1747
+ export type CreateWorkspaceResponsePlanEnum = typeof CreateWorkspaceResponsePlanEnum[keyof typeof CreateWorkspaceResponsePlanEnum];
1598
1748
  /**
1599
1749
  * The event object represents an action or an occurrence.
1600
1750
  * @export
@@ -1806,11 +1956,37 @@ export interface GetBotAnalyticsResponseRecordsInner {
1806
1956
  */
1807
1957
  'sessions': number;
1808
1958
  /**
1809
- *
1959
+ * Deprecated. Use `userMessages` instead.
1810
1960
  * @type {number}
1811
1961
  * @memberof GetBotAnalyticsResponseRecordsInner
1812
1962
  */
1813
1963
  'messages': number;
1964
+ /**
1965
+ *
1966
+ * @type {number}
1967
+ * @memberof GetBotAnalyticsResponseRecordsInner
1968
+ */
1969
+ 'userMessages': number;
1970
+ /**
1971
+ *
1972
+ * @type {number}
1973
+ * @memberof GetBotAnalyticsResponseRecordsInner
1974
+ */
1975
+ 'botMessages': number;
1976
+ /**
1977
+ *
1978
+ * @type {number}
1979
+ * @memberof GetBotAnalyticsResponseRecordsInner
1980
+ */
1981
+ 'events': number;
1982
+ /**
1983
+ *
1984
+ * @type {{ [key: string]: number; }}
1985
+ * @memberof GetBotAnalyticsResponseRecordsInner
1986
+ */
1987
+ 'eventTypes': {
1988
+ [key: string]: number;
1989
+ };
1814
1990
  }
1815
1991
  /**
1816
1992
  *
@@ -2178,6 +2354,125 @@ export interface GetUserResponse {
2178
2354
  */
2179
2355
  'user': User;
2180
2356
  }
2357
+ /**
2358
+ *
2359
+ * @export
2360
+ * @interface GetWorkspaceBillingDetailsResponse
2361
+ */
2362
+ export interface GetWorkspaceBillingDetailsResponse {
2363
+ /**
2364
+ *
2365
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriod}
2366
+ * @memberof GetWorkspaceBillingDetailsResponse
2367
+ */
2368
+ 'currentPeriod': GetWorkspaceBillingDetailsResponseCurrentPeriod;
2369
+ /**
2370
+ *
2371
+ * @type {GetWorkspaceBillingDetailsResponsePaymentMethod}
2372
+ * @memberof GetWorkspaceBillingDetailsResponse
2373
+ */
2374
+ 'paymentMethod': GetWorkspaceBillingDetailsResponsePaymentMethod | null;
2375
+ }
2376
+ /**
2377
+ *
2378
+ * @export
2379
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriod
2380
+ */
2381
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriod {
2382
+ /**
2383
+ *
2384
+ * @type {string}
2385
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2386
+ */
2387
+ 'start': string;
2388
+ /**
2389
+ *
2390
+ * @type {string}
2391
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2392
+ */
2393
+ 'end': string;
2394
+ /**
2395
+ *
2396
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriodUsage}
2397
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2398
+ */
2399
+ 'usage': GetWorkspaceBillingDetailsResponseCurrentPeriodUsage;
2400
+ }
2401
+ /**
2402
+ *
2403
+ * @export
2404
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsage
2405
+ */
2406
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsage {
2407
+ /**
2408
+ *
2409
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages}
2410
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsage
2411
+ */
2412
+ 'userMessages': GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages;
2413
+ }
2414
+ /**
2415
+ *
2416
+ * @export
2417
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2418
+ */
2419
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages {
2420
+ /**
2421
+ *
2422
+ * @type {string}
2423
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2424
+ */
2425
+ 'status': GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum;
2426
+ /**
2427
+ *
2428
+ * @type {number}
2429
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2430
+ */
2431
+ 'quantity': number;
2432
+ /**
2433
+ *
2434
+ * @type {number}
2435
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2436
+ */
2437
+ 'price': number;
2438
+ /**
2439
+ *
2440
+ * @type {number}
2441
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2442
+ */
2443
+ 'minimum': number;
2444
+ /**
2445
+ *
2446
+ * @type {number}
2447
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2448
+ */
2449
+ 'maximum': number;
2450
+ }
2451
+ export declare const GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum: {
2452
+ readonly Ok: "OK";
2453
+ readonly Warning: "Warning";
2454
+ readonly LimitReached: "LimitReached";
2455
+ };
2456
+ export type GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum = typeof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum[keyof typeof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum];
2457
+ /**
2458
+ *
2459
+ * @export
2460
+ * @interface GetWorkspaceBillingDetailsResponsePaymentMethod
2461
+ */
2462
+ export interface GetWorkspaceBillingDetailsResponsePaymentMethod {
2463
+ /**
2464
+ *
2465
+ * @type {string}
2466
+ * @memberof GetWorkspaceBillingDetailsResponsePaymentMethod
2467
+ */
2468
+ 'type': string;
2469
+ /**
2470
+ *
2471
+ * @type {string}
2472
+ * @memberof GetWorkspaceBillingDetailsResponsePaymentMethod
2473
+ */
2474
+ 'lastDigits': string;
2475
+ }
2181
2476
  /**
2182
2477
  *
2183
2478
  * @export
@@ -2226,6 +2521,8 @@ export declare const GetWorkspaceQuotaResponseQuotaTypeEnum: {
2226
2521
  readonly TableRowCount: "table_row_count";
2227
2522
  readonly WorkspaceMemberCount: "workspace_member_count";
2228
2523
  readonly IntegrationsOwnedCount: "integrations_owned_count";
2524
+ readonly CognitiveCalls: "cognitive_calls";
2525
+ readonly ModelCredit: "model_credit";
2229
2526
  };
2230
2527
  export type GetWorkspaceQuotaResponseQuotaTypeEnum = typeof GetWorkspaceQuotaResponseQuotaTypeEnum[keyof typeof GetWorkspaceQuotaResponseQuotaTypeEnum];
2231
2528
  /**
@@ -2276,6 +2573,12 @@ export interface GetWorkspaceResponse {
2276
2573
  * @memberof GetWorkspaceResponse
2277
2574
  */
2278
2575
  'accountType': GetWorkspaceResponseAccountTypeEnum;
2576
+ /**
2577
+ *
2578
+ * @type {string}
2579
+ * @memberof GetWorkspaceResponse
2580
+ */
2581
+ 'plan': GetWorkspaceResponsePlanEnum;
2279
2582
  /**
2280
2583
  *
2281
2584
  * @type {boolean}
@@ -2294,6 +2597,12 @@ export declare const GetWorkspaceResponseAccountTypeEnum: {
2294
2597
  readonly Premium: "premium";
2295
2598
  };
2296
2599
  export type GetWorkspaceResponseAccountTypeEnum = typeof GetWorkspaceResponseAccountTypeEnum[keyof typeof GetWorkspaceResponseAccountTypeEnum];
2600
+ export declare const GetWorkspaceResponsePlanEnum: {
2601
+ readonly Community: "community";
2602
+ readonly Team: "team";
2603
+ readonly Enterprise: "enterprise";
2604
+ };
2605
+ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[keyof typeof GetWorkspaceResponsePlanEnum];
2297
2606
  /**
2298
2607
  *
2299
2608
  * @export
@@ -2318,6 +2627,12 @@ export interface Integration {
2318
2627
  * @memberof Integration
2319
2628
  */
2320
2629
  'updatedAt': string;
2630
+ /**
2631
+ *
2632
+ * @type {IntegrationIdentifier}
2633
+ * @memberof Integration
2634
+ */
2635
+ 'identifier': IntegrationIdentifier;
2321
2636
  /**
2322
2637
  * Name of the [Integration](#schema_integration)
2323
2638
  * @type {string}
@@ -2332,10 +2647,10 @@ export interface Integration {
2332
2647
  'version': string;
2333
2648
  /**
2334
2649
  *
2335
- * @type {CreateIntegrationBodyConfiguration}
2650
+ * @type {IntegrationConfiguration}
2336
2651
  * @memberof Integration
2337
2652
  */
2338
- 'configuration': CreateIntegrationBodyConfiguration;
2653
+ 'configuration': IntegrationConfiguration;
2339
2654
  /**
2340
2655
  *
2341
2656
  * @type {{ [key: string]: IntegrationChannelsValue; }}
@@ -2465,6 +2780,59 @@ export interface IntegrationChannelsValueConversation {
2465
2780
  */
2466
2781
  'creation': CreateIntegrationBodyChannelsValueConversationCreation;
2467
2782
  }
2783
+ /**
2784
+ * Configuration definition
2785
+ * @export
2786
+ * @interface IntegrationConfiguration
2787
+ */
2788
+ export interface IntegrationConfiguration {
2789
+ /**
2790
+ *
2791
+ * @type {IntegrationConfigurationIdentifier}
2792
+ * @memberof IntegrationConfiguration
2793
+ */
2794
+ 'identifier': IntegrationConfigurationIdentifier;
2795
+ /**
2796
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
2797
+ * @type {{ [key: string]: any; }}
2798
+ * @memberof IntegrationConfiguration
2799
+ */
2800
+ 'schema'?: {
2801
+ [key: string]: any;
2802
+ };
2803
+ }
2804
+ /**
2805
+ * Identifier configuration of the [Integration](#schema_integration)
2806
+ * @export
2807
+ * @interface IntegrationConfigurationIdentifier
2808
+ */
2809
+ export interface IntegrationConfigurationIdentifier {
2810
+ /**
2811
+ *
2812
+ * @type {string}
2813
+ * @memberof IntegrationConfigurationIdentifier
2814
+ */
2815
+ 'linkTemplateScript'?: string;
2816
+ /**
2817
+ *
2818
+ * @type {boolean}
2819
+ * @memberof IntegrationConfigurationIdentifier
2820
+ */
2821
+ 'required': boolean;
2822
+ }
2823
+ /**
2824
+ * Global identifier configuration of the [Integration](#schema_integration)
2825
+ * @export
2826
+ * @interface IntegrationIdentifier
2827
+ */
2828
+ export interface IntegrationIdentifier {
2829
+ /**
2830
+ * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
2831
+ * @type {string}
2832
+ * @memberof IntegrationIdentifier
2833
+ */
2834
+ 'extractScript'?: string;
2835
+ }
2468
2836
  /**
2469
2837
  * User object configuration
2470
2838
  * @export
@@ -3004,63 +3372,161 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
3004
3372
  * @type {string}
3005
3373
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
3006
3374
  */
3007
- 'createdAt': string;
3375
+ 'createdAt': string;
3376
+ /**
3377
+ * Updating date of the [Integration](#schema_integration) in ISO 8601 format
3378
+ * @type {string}
3379
+ * @memberof ListPublicIntegrationsResponseIntegrationsInner
3380
+ */
3381
+ 'updatedAt': string;
3382
+ /**
3383
+ * Title of the integration. This is the name that will be displayed in the UI
3384
+ * @type {string}
3385
+ * @memberof ListPublicIntegrationsResponseIntegrationsInner
3386
+ */
3387
+ 'title': string;
3388
+ /**
3389
+ * Description of the integration. This is the description that will be displayed in the UI
3390
+ * @type {string}
3391
+ * @memberof ListPublicIntegrationsResponseIntegrationsInner
3392
+ */
3393
+ 'description': string;
3394
+ /**
3395
+ * URL of the icon of the integration. This is the icon that will be displayed in the UI
3396
+ * @type {string}
3397
+ * @memberof ListPublicIntegrationsResponseIntegrationsInner
3398
+ */
3399
+ 'iconUrl': string;
3400
+ }
3401
+ /**
3402
+ *
3403
+ * @export
3404
+ * @interface ListUsageHistoryResponse
3405
+ */
3406
+ export interface ListUsageHistoryResponse {
3407
+ /**
3408
+ *
3409
+ * @type {Array<Usage>}
3410
+ * @memberof ListUsageHistoryResponse
3411
+ */
3412
+ 'usages': Array<Usage>;
3413
+ }
3414
+ /**
3415
+ *
3416
+ * @export
3417
+ * @interface ListUsersResponse
3418
+ */
3419
+ export interface ListUsersResponse {
3420
+ /**
3421
+ *
3422
+ * @type {Array<User>}
3423
+ * @memberof ListUsersResponse
3424
+ */
3425
+ 'users': Array<User>;
3426
+ /**
3427
+ *
3428
+ * @type {ListConversationsResponseMeta}
3429
+ * @memberof ListUsersResponse
3430
+ */
3431
+ 'meta': ListConversationsResponseMeta;
3432
+ }
3433
+ /**
3434
+ *
3435
+ * @export
3436
+ * @interface ListWorkspaceInvoicesResponse
3437
+ */
3438
+ export interface ListWorkspaceInvoicesResponse {
3439
+ /**
3440
+ *
3441
+ * @type {Array<ListWorkspaceInvoicesResponseInvoicesInner>}
3442
+ * @memberof ListWorkspaceInvoicesResponse
3443
+ */
3444
+ 'invoices': Array<ListWorkspaceInvoicesResponseInvoicesInner>;
3445
+ }
3446
+ /**
3447
+ *
3448
+ * @export
3449
+ * @interface ListWorkspaceInvoicesResponseInvoicesInner
3450
+ */
3451
+ export interface ListWorkspaceInvoicesResponseInvoicesInner {
3452
+ /**
3453
+ *
3454
+ * @type {string}
3455
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3456
+ */
3457
+ 'id': string;
3458
+ /**
3459
+ *
3460
+ * @type {ListWorkspaceInvoicesResponseInvoicesInnerPeriod}
3461
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3462
+ */
3463
+ 'period': ListWorkspaceInvoicesResponseInvoicesInnerPeriod;
3464
+ /**
3465
+ * Date on which the invoice was generated.
3466
+ * @type {string}
3467
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3468
+ */
3469
+ 'date': string;
3470
+ /**
3471
+ * Total amount to pay of the invoice.
3472
+ * @type {number}
3473
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3474
+ */
3475
+ 'amount': number;
3008
3476
  /**
3009
- * Updating date of the [Integration](#schema_integration) in ISO 8601 format
3477
+ * Currency of the invoice amount.
3010
3478
  * @type {string}
3011
- * @memberof ListPublicIntegrationsResponseIntegrationsInner
3479
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3012
3480
  */
3013
- 'updatedAt': string;
3481
+ 'currency': string;
3014
3482
  /**
3015
- * Title of the integration. This is the name that will be displayed in the UI
3483
+ *
3016
3484
  * @type {string}
3017
- * @memberof ListPublicIntegrationsResponseIntegrationsInner
3485
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3018
3486
  */
3019
- 'title': string;
3487
+ 'paymentStatus': ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum;
3020
3488
  /**
3021
- * Description of the integration. This is the description that will be displayed in the UI
3022
- * @type {string}
3023
- * @memberof ListPublicIntegrationsResponseIntegrationsInner
3489
+ * Number of times payment has been unsuccessfully attempted on the invoice.
3490
+ * @type {number}
3491
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3024
3492
  */
3025
- 'description': string;
3493
+ 'paymentAttemptCount': number | null;
3026
3494
  /**
3027
- * URL of the icon of the integration. This is the icon that will be displayed in the UI
3495
+ * Date on which the next payment attempt will be made.
3028
3496
  * @type {string}
3029
- * @memberof ListPublicIntegrationsResponseIntegrationsInner
3497
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3030
3498
  */
3031
- 'iconUrl': string;
3032
- }
3033
- /**
3034
- *
3035
- * @export
3036
- * @interface ListUsageHistoryResponse
3037
- */
3038
- export interface ListUsageHistoryResponse {
3499
+ 'nextPaymentAttemptDate': string | null;
3039
3500
  /**
3040
- *
3041
- * @type {Array<Usage>}
3042
- * @memberof ListUsageHistoryResponse
3501
+ * URL to download the PDF file of the invoice.
3502
+ * @type {string}
3503
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3043
3504
  */
3044
- 'usages': Array<Usage>;
3505
+ 'pdfUrl': string;
3045
3506
  }
3507
+ export declare const ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum: {
3508
+ readonly Paid: "paid";
3509
+ readonly Unpaid: "unpaid";
3510
+ };
3511
+ export type ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum = typeof ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum[keyof typeof ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum];
3046
3512
  /**
3047
3513
  *
3048
3514
  * @export
3049
- * @interface ListUsersResponse
3515
+ * @interface ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3050
3516
  */
3051
- export interface ListUsersResponse {
3517
+ export interface ListWorkspaceInvoicesResponseInvoicesInnerPeriod {
3052
3518
  /**
3053
3519
  *
3054
- * @type {Array<User>}
3055
- * @memberof ListUsersResponse
3520
+ * @type {number}
3521
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3056
3522
  */
3057
- 'users': Array<User>;
3523
+ 'month': number;
3058
3524
  /**
3059
3525
  *
3060
- * @type {ListConversationsResponseMeta}
3061
- * @memberof ListUsersResponse
3526
+ * @type {number}
3527
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3062
3528
  */
3063
- 'meta': ListConversationsResponseMeta;
3529
+ 'year': number;
3064
3530
  }
3065
3531
  /**
3066
3532
  *
@@ -3169,6 +3635,8 @@ export declare const ListWorkspaceQuotasResponseQuotasInnerTypeEnum: {
3169
3635
  readonly TableRowCount: "table_row_count";
3170
3636
  readonly WorkspaceMemberCount: "workspace_member_count";
3171
3637
  readonly IntegrationsOwnedCount: "integrations_owned_count";
3638
+ readonly CognitiveCalls: "cognitive_calls";
3639
+ readonly ModelCredit: "model_credit";
3172
3640
  };
3173
3641
  export type ListWorkspaceQuotasResponseQuotasInnerTypeEnum = typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum[keyof typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum];
3174
3642
  /**
@@ -3254,7 +3722,7 @@ export interface Message {
3254
3722
  */
3255
3723
  'conversationId': string;
3256
3724
  /**
3257
- * 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.
3725
+ * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
3258
3726
  * @type {{ [key: string]: string; }}
3259
3727
  * @memberof Message
3260
3728
  */
@@ -3383,6 +3851,72 @@ export interface SetStateResponse {
3383
3851
  */
3384
3852
  'state': State;
3385
3853
  }
3854
+ /**
3855
+ *
3856
+ * @export
3857
+ * @interface SetWorkspacePaymentMethodBody
3858
+ */
3859
+ export interface SetWorkspacePaymentMethodBody {
3860
+ /**
3861
+ * ID of the Stripe PaymentMethod to attach to the workspace.
3862
+ * @type {string}
3863
+ * @memberof SetWorkspacePaymentMethodBody
3864
+ */
3865
+ 'stripePaymentMethodId': string;
3866
+ }
3867
+ /**
3868
+ *
3869
+ * @export
3870
+ * @interface SetWorkspacePaymentMethodResponse
3871
+ */
3872
+ export interface SetWorkspacePaymentMethodResponse {
3873
+ /**
3874
+ *
3875
+ * @type {string}
3876
+ * @memberof SetWorkspacePaymentMethodResponse
3877
+ */
3878
+ 'stripePaymentMethodId': string;
3879
+ /**
3880
+ *
3881
+ * @type {GetWorkspaceBillingDetailsResponsePaymentMethod}
3882
+ * @memberof SetWorkspacePaymentMethodResponse
3883
+ */
3884
+ 'paymentMethod': GetWorkspaceBillingDetailsResponsePaymentMethod | null;
3885
+ /**
3886
+ *
3887
+ * @type {string}
3888
+ * @memberof SetWorkspacePaymentMethodResponse
3889
+ */
3890
+ 'status': SetWorkspacePaymentMethodResponseStatusEnum;
3891
+ /**
3892
+ *
3893
+ * @type {SetWorkspacePaymentMethodResponseNextAction}
3894
+ * @memberof SetWorkspacePaymentMethodResponse
3895
+ */
3896
+ 'nextAction'?: SetWorkspacePaymentMethodResponseNextAction;
3897
+ }
3898
+ export declare const SetWorkspacePaymentMethodResponseStatusEnum: {
3899
+ readonly Succeeded: "succeeded";
3900
+ readonly Processing: "processing";
3901
+ readonly Canceled: "canceled";
3902
+ readonly RequiresConfirmation: "requires_confirmation";
3903
+ readonly RequiresAction: "requires_action";
3904
+ readonly RequiresPaymentMethod: "requires_payment_method";
3905
+ };
3906
+ export type SetWorkspacePaymentMethodResponseStatusEnum = typeof SetWorkspacePaymentMethodResponseStatusEnum[keyof typeof SetWorkspacePaymentMethodResponseStatusEnum];
3907
+ /**
3908
+ * If the payment needs to be confirmed, this will contain a URL to redirect the user to so they can complete the verification process to confirm it.
3909
+ * @export
3910
+ * @interface SetWorkspacePaymentMethodResponseNextAction
3911
+ */
3912
+ export interface SetWorkspacePaymentMethodResponseNextAction {
3913
+ /**
3914
+ *
3915
+ * @type {string}
3916
+ * @memberof SetWorkspacePaymentMethodResponseNextAction
3917
+ */
3918
+ 'redirectToUrl': string;
3919
+ }
3386
3920
  /**
3387
3921
  * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
3388
3922
  * @export
@@ -3760,10 +4294,10 @@ export interface UpdateConversationResponse {
3760
4294
  export interface UpdateIntegrationBody {
3761
4295
  /**
3762
4296
  *
3763
- * @type {CreateIntegrationBodyConfiguration}
4297
+ * @type {UpdateIntegrationBodyConfiguration}
3764
4298
  * @memberof UpdateIntegrationBody
3765
4299
  */
3766
- 'configuration'?: CreateIntegrationBodyConfiguration;
4300
+ 'configuration'?: UpdateIntegrationBodyConfiguration;
3767
4301
  /**
3768
4302
  *
3769
4303
  * @type {{ [key: string]: UpdateIntegrationBodyChannelsValue | null; }}
@@ -3772,6 +4306,12 @@ export interface UpdateIntegrationBody {
3772
4306
  'channels'?: {
3773
4307
  [key: string]: UpdateIntegrationBodyChannelsValue | null;
3774
4308
  };
4309
+ /**
4310
+ *
4311
+ * @type {UpdateIntegrationBodyIdentifier}
4312
+ * @memberof UpdateIntegrationBody
4313
+ */
4314
+ 'identifier'?: UpdateIntegrationBodyIdentifier;
3775
4315
  /**
3776
4316
  *
3777
4317
  * @type {{ [key: string]: UpdateIntegrationBodyActionsValue | null; }}
@@ -3945,6 +4485,59 @@ export interface UpdateIntegrationBodyChannelsValueMessagesValue {
3945
4485
  [key: string]: any;
3946
4486
  };
3947
4487
  }
4488
+ /**
4489
+ *
4490
+ * @export
4491
+ * @interface UpdateIntegrationBodyConfiguration
4492
+ */
4493
+ export interface UpdateIntegrationBodyConfiguration {
4494
+ /**
4495
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
4496
+ * @type {{ [key: string]: any; }}
4497
+ * @memberof UpdateIntegrationBodyConfiguration
4498
+ */
4499
+ 'schema'?: {
4500
+ [key: string]: any;
4501
+ };
4502
+ /**
4503
+ *
4504
+ * @type {UpdateIntegrationBodyConfigurationIdentifier}
4505
+ * @memberof UpdateIntegrationBodyConfiguration
4506
+ */
4507
+ 'identifier'?: UpdateIntegrationBodyConfigurationIdentifier;
4508
+ }
4509
+ /**
4510
+ *
4511
+ * @export
4512
+ * @interface UpdateIntegrationBodyConfigurationIdentifier
4513
+ */
4514
+ export interface UpdateIntegrationBodyConfigurationIdentifier {
4515
+ /**
4516
+ *
4517
+ * @type {string}
4518
+ * @memberof UpdateIntegrationBodyConfigurationIdentifier
4519
+ */
4520
+ 'linkTemplateScript'?: string | null;
4521
+ /**
4522
+ *
4523
+ * @type {boolean}
4524
+ * @memberof UpdateIntegrationBodyConfigurationIdentifier
4525
+ */
4526
+ 'required'?: boolean;
4527
+ }
4528
+ /**
4529
+ *
4530
+ * @export
4531
+ * @interface UpdateIntegrationBodyIdentifier
4532
+ */
4533
+ export interface UpdateIntegrationBodyIdentifier {
4534
+ /**
4535
+ *
4536
+ * @type {string}
4537
+ * @memberof UpdateIntegrationBodyIdentifier
4538
+ */
4539
+ 'extractScript'?: string | null;
4540
+ }
3948
4541
  /**
3949
4542
  * State definition
3950
4543
  * @export
@@ -4191,6 +4784,12 @@ export interface UpdateWorkspaceResponse {
4191
4784
  * @memberof UpdateWorkspaceResponse
4192
4785
  */
4193
4786
  'accountType': UpdateWorkspaceResponseAccountTypeEnum;
4787
+ /**
4788
+ *
4789
+ * @type {string}
4790
+ * @memberof UpdateWorkspaceResponse
4791
+ */
4792
+ 'plan': UpdateWorkspaceResponsePlanEnum;
4194
4793
  /**
4195
4794
  *
4196
4795
  * @type {boolean}
@@ -4209,6 +4808,12 @@ export declare const UpdateWorkspaceResponseAccountTypeEnum: {
4209
4808
  readonly Premium: "premium";
4210
4809
  };
4211
4810
  export type UpdateWorkspaceResponseAccountTypeEnum = typeof UpdateWorkspaceResponseAccountTypeEnum[keyof typeof UpdateWorkspaceResponseAccountTypeEnum];
4811
+ export declare const UpdateWorkspaceResponsePlanEnum: {
4812
+ readonly Community: "community";
4813
+ readonly Team: "team";
4814
+ readonly Enterprise: "enterprise";
4815
+ };
4816
+ export type UpdateWorkspaceResponsePlanEnum = typeof UpdateWorkspaceResponsePlanEnum[keyof typeof UpdateWorkspaceResponsePlanEnum];
4212
4817
  /**
4213
4818
  *
4214
4819
  * @export
@@ -4257,6 +4862,12 @@ export interface UpdateWorkspaceResponse1 {
4257
4862
  * @memberof UpdateWorkspaceResponse1
4258
4863
  */
4259
4864
  'accountType': UpdateWorkspaceResponse1AccountTypeEnum;
4865
+ /**
4866
+ *
4867
+ * @type {string}
4868
+ * @memberof UpdateWorkspaceResponse1
4869
+ */
4870
+ 'plan': UpdateWorkspaceResponse1PlanEnum;
4260
4871
  /**
4261
4872
  *
4262
4873
  * @type {boolean}
@@ -4275,6 +4886,12 @@ export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
4275
4886
  readonly Premium: "premium";
4276
4887
  };
4277
4888
  export type UpdateWorkspaceResponse1AccountTypeEnum = typeof UpdateWorkspaceResponse1AccountTypeEnum[keyof typeof UpdateWorkspaceResponse1AccountTypeEnum];
4889
+ export declare const UpdateWorkspaceResponse1PlanEnum: {
4890
+ readonly Community: "community";
4891
+ readonly Team: "team";
4892
+ readonly Enterprise: "enterprise";
4893
+ };
4894
+ export type UpdateWorkspaceResponse1PlanEnum = typeof UpdateWorkspaceResponse1PlanEnum[keyof typeof UpdateWorkspaceResponse1PlanEnum];
4278
4895
  /**
4279
4896
  *
4280
4897
  * @export
@@ -4322,6 +4939,8 @@ export declare const UsageTypeEnum: {
4322
4939
  readonly TableRowCount: "table_row_count";
4323
4940
  readonly WorkspaceMemberCount: "workspace_member_count";
4324
4941
  readonly IntegrationsOwnedCount: "integrations_owned_count";
4942
+ readonly CognitiveCalls: "cognitive_calls";
4943
+ readonly ModelCredit: "model_credit";
4325
4944
  };
4326
4945
  export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
4327
4946
  /**
@@ -4349,7 +4968,7 @@ export interface User {
4349
4968
  */
4350
4969
  'updatedAt': string;
4351
4970
  /**
4352
- * Set of [Tags](#tags) that you can attach to a [User](#schema_user). The set of [Tags](#tags) available on a [User](#schema_user) 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.
4971
+ * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
4353
4972
  * @type {{ [key: string]: string; }}
4354
4973
  * @memberof User
4355
4974
  */
@@ -4405,6 +5024,12 @@ export interface Workspace {
4405
5024
  * @memberof Workspace
4406
5025
  */
4407
5026
  'accountType': WorkspaceAccountTypeEnum;
5027
+ /**
5028
+ *
5029
+ * @type {string}
5030
+ * @memberof Workspace
5031
+ */
5032
+ 'plan': WorkspacePlanEnum;
4408
5033
  /**
4409
5034
  *
4410
5035
  * @type {boolean}
@@ -4423,6 +5048,12 @@ export declare const WorkspaceAccountTypeEnum: {
4423
5048
  readonly Premium: "premium";
4424
5049
  };
4425
5050
  export type WorkspaceAccountTypeEnum = typeof WorkspaceAccountTypeEnum[keyof typeof WorkspaceAccountTypeEnum];
5051
+ export declare const WorkspacePlanEnum: {
5052
+ readonly Community: "community";
5053
+ readonly Team: "team";
5054
+ readonly Enterprise: "enterprise";
5055
+ };
5056
+ export type WorkspacePlanEnum = typeof WorkspacePlanEnum[keyof typeof WorkspacePlanEnum];
4426
5057
  /**
4427
5058
  *
4428
5059
  * @export
@@ -4483,6 +5114,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4483
5114
  * @throws {RequiredError}
4484
5115
  */
4485
5116
  changeWorkspacePlan: (id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5117
+ /**
5118
+ * Charge unpaid invoices of a workspace.
5119
+ * @param {string} id Workspace ID
5120
+ * @param {ChargeWorkspaceUnpaidInvoicesBody} [chargeWorkspaceUnpaidInvoicesBody]
5121
+ * @param {*} [options] Override http request option.
5122
+ * @throws {RequiredError}
5123
+ */
5124
+ chargeWorkspaceUnpaidInvoices: (id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4486
5125
  /**
4487
5126
  * An integration can call this endpoint to configure itself
4488
5127
  * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
@@ -4807,6 +5446,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4807
5446
  * @throws {RequiredError}
4808
5447
  */
4809
5448
  getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5449
+ /**
5450
+ * Get billing details of workspace
5451
+ * @param {string} id Workspace ID
5452
+ * @param {*} [options] Override http request option.
5453
+ * @throws {RequiredError}
5454
+ */
5455
+ getWorkspaceBillingDetails: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4810
5456
  /**
4811
5457
  * Get workspace quota
4812
5458
  * @param {string} id Workspace ID
@@ -4927,6 +5573,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4927
5573
  listUsers: (nextToken?: string, conversationId?: string, tags?: {
4928
5574
  [key: string]: string;
4929
5575
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5576
+ /**
5577
+ * List invoices billed to workspace
5578
+ * @param {string} id Workspace ID
5579
+ * @param {*} [options] Override http request option.
5580
+ * @throws {RequiredError}
5581
+ */
5582
+ listWorkspaceInvoices: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4930
5583
  /**
4931
5584
  * Lists all the members in a workspace
4932
5585
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -4978,6 +5631,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4978
5631
  * @throws {RequiredError}
4979
5632
  */
4980
5633
  setState: (type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5634
+ /**
5635
+ * Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.
5636
+ * @param {string} id Workspace ID
5637
+ * @param {SetWorkspacePaymentMethodBody} [setWorkspacePaymentMethodBody]
5638
+ * @param {*} [options] Override http request option.
5639
+ * @throws {RequiredError}
5640
+ */
5641
+ setWorkspacePaymentMethod: (id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4981
5642
  /**
4982
5643
  * 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.
4983
5644
  * @param {string} id Bot ID
@@ -5063,6 +5724,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5063
5724
  * @throws {RequiredError}
5064
5725
  */
5065
5726
  changeWorkspacePlan(id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeWorkspacePlanResponse>>;
5727
+ /**
5728
+ * Charge unpaid invoices of a workspace.
5729
+ * @param {string} id Workspace ID
5730
+ * @param {ChargeWorkspaceUnpaidInvoicesBody} [chargeWorkspaceUnpaidInvoicesBody]
5731
+ * @param {*} [options] Override http request option.
5732
+ * @throws {RequiredError}
5733
+ */
5734
+ chargeWorkspaceUnpaidInvoices(id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>>;
5066
5735
  /**
5067
5736
  * An integration can call this endpoint to configure itself
5068
5737
  * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
@@ -5387,6 +6056,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5387
6056
  * @throws {RequiredError}
5388
6057
  */
5389
6058
  getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
6059
+ /**
6060
+ * Get billing details of workspace
6061
+ * @param {string} id Workspace ID
6062
+ * @param {*} [options] Override http request option.
6063
+ * @throws {RequiredError}
6064
+ */
6065
+ getWorkspaceBillingDetails(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceBillingDetailsResponse>>;
5390
6066
  /**
5391
6067
  * Get workspace quota
5392
6068
  * @param {string} id Workspace ID
@@ -5507,6 +6183,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5507
6183
  listUsers(nextToken?: string, conversationId?: string, tags?: {
5508
6184
  [key: string]: string;
5509
6185
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
6186
+ /**
6187
+ * List invoices billed to workspace
6188
+ * @param {string} id Workspace ID
6189
+ * @param {*} [options] Override http request option.
6190
+ * @throws {RequiredError}
6191
+ */
6192
+ listWorkspaceInvoices(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceInvoicesResponse>>;
5510
6193
  /**
5511
6194
  * Lists all the members in a workspace
5512
6195
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -5558,6 +6241,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5558
6241
  * @throws {RequiredError}
5559
6242
  */
5560
6243
  setState(type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
6244
+ /**
6245
+ * Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.
6246
+ * @param {string} id Workspace ID
6247
+ * @param {SetWorkspacePaymentMethodBody} [setWorkspacePaymentMethodBody]
6248
+ * @param {*} [options] Override http request option.
6249
+ * @throws {RequiredError}
6250
+ */
6251
+ setWorkspacePaymentMethod(id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetWorkspacePaymentMethodResponse>>;
5561
6252
  /**
5562
6253
  * 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.
5563
6254
  * @param {string} id Bot ID
@@ -5642,6 +6333,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5642
6333
  * @throws {RequiredError}
5643
6334
  */
5644
6335
  changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeWorkspacePlanResponse>;
6336
+ /**
6337
+ * Charge unpaid invoices of a workspace.
6338
+ * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
6339
+ * @param {*} [options] Override http request option.
6340
+ * @throws {RequiredError}
6341
+ */
6342
+ chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>;
5645
6343
  /**
5646
6344
  * An integration can call this endpoint to configure itself
5647
6345
  * @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
@@ -5949,6 +6647,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5949
6647
  * @throws {RequiredError}
5950
6648
  */
5951
6649
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
6650
+ /**
6651
+ * Get billing details of workspace
6652
+ * @param {DefaultApiGetWorkspaceBillingDetailsRequest} requestParameters Request parameters.
6653
+ * @param {*} [options] Override http request option.
6654
+ * @throws {RequiredError}
6655
+ */
6656
+ getWorkspaceBillingDetails(requestParameters: DefaultApiGetWorkspaceBillingDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceBillingDetailsResponse>;
5952
6657
  /**
5953
6658
  * Get workspace quota
5954
6659
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -6046,6 +6751,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
6046
6751
  * @throws {RequiredError}
6047
6752
  */
6048
6753
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
6754
+ /**
6755
+ * List invoices billed to workspace
6756
+ * @param {DefaultApiListWorkspaceInvoicesRequest} requestParameters Request parameters.
6757
+ * @param {*} [options] Override http request option.
6758
+ * @throws {RequiredError}
6759
+ */
6760
+ listWorkspaceInvoices(requestParameters: DefaultApiListWorkspaceInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceInvoicesResponse>;
6049
6761
  /**
6050
6762
  * Lists all the members in a workspace
6051
6763
  * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
@@ -6088,6 +6800,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
6088
6800
  * @throws {RequiredError}
6089
6801
  */
6090
6802
  setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
6803
+ /**
6804
+ * Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.
6805
+ * @param {DefaultApiSetWorkspacePaymentMethodRequest} requestParameters Request parameters.
6806
+ * @param {*} [options] Override http request option.
6807
+ * @throws {RequiredError}
6808
+ */
6809
+ setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): AxiosPromise<SetWorkspacePaymentMethodResponse>;
6091
6810
  /**
6092
6811
  * 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.
6093
6812
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -6177,6 +6896,25 @@ export interface DefaultApiChangeWorkspacePlanRequest {
6177
6896
  */
6178
6897
  readonly changeWorkspacePlanBody?: ChangeWorkspacePlanBody;
6179
6898
  }
6899
+ /**
6900
+ * Request parameters for chargeWorkspaceUnpaidInvoices operation in DefaultApi.
6901
+ * @export
6902
+ * @interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest
6903
+ */
6904
+ export interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest {
6905
+ /**
6906
+ * Workspace ID
6907
+ * @type {string}
6908
+ * @memberof DefaultApiChargeWorkspaceUnpaidInvoices
6909
+ */
6910
+ readonly id: string;
6911
+ /**
6912
+ *
6913
+ * @type {ChargeWorkspaceUnpaidInvoicesBody}
6914
+ * @memberof DefaultApiChargeWorkspaceUnpaidInvoices
6915
+ */
6916
+ readonly chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody;
6917
+ }
6180
6918
  /**
6181
6919
  * Request parameters for configureIntegration operation in DefaultApi.
6182
6920
  * @export
@@ -6795,7 +7533,7 @@ export interface DefaultApiGetStateRequest {
6795
7533
  export interface DefaultApiGetUsageRequest {
6796
7534
  /**
6797
7535
  * Type of usage
6798
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count'}
7536
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'cognitive_calls' | 'model_credit'}
6799
7537
  * @memberof DefaultApiGetUsage
6800
7538
  */
6801
7539
  readonly type: GetUsageTypeEnum;
@@ -6838,6 +7576,19 @@ export interface DefaultApiGetWorkspaceRequest {
6838
7576
  */
6839
7577
  readonly id: string;
6840
7578
  }
7579
+ /**
7580
+ * Request parameters for getWorkspaceBillingDetails operation in DefaultApi.
7581
+ * @export
7582
+ * @interface DefaultApiGetWorkspaceBillingDetailsRequest
7583
+ */
7584
+ export interface DefaultApiGetWorkspaceBillingDetailsRequest {
7585
+ /**
7586
+ * Workspace ID
7587
+ * @type {string}
7588
+ * @memberof DefaultApiGetWorkspaceBillingDetails
7589
+ */
7590
+ readonly id: string;
7591
+ }
6841
7592
  /**
6842
7593
  * Request parameters for getWorkspaceQuota operation in DefaultApi.
6843
7594
  * @export
@@ -6852,7 +7603,7 @@ export interface DefaultApiGetWorkspaceQuotaRequest {
6852
7603
  readonly id: string;
6853
7604
  /**
6854
7605
  * Type of usage
6855
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count'}
7606
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'cognitive_calls' | 'model_credit'}
6856
7607
  * @memberof DefaultApiGetWorkspaceQuota
6857
7608
  */
6858
7609
  readonly type: GetWorkspaceQuotaTypeEnum;
@@ -7077,7 +7828,7 @@ export interface DefaultApiListPublicIntegrationsRequest {
7077
7828
  export interface DefaultApiListUsageHistoryRequest {
7078
7829
  /**
7079
7830
  * Type of usage
7080
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count'}
7831
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'cognitive_calls' | 'model_credit'}
7081
7832
  * @memberof DefaultApiListUsageHistory
7082
7833
  */
7083
7834
  readonly type: ListUsageHistoryTypeEnum;
@@ -7115,6 +7866,19 @@ export interface DefaultApiListUsersRequest {
7115
7866
  [key: string]: string;
7116
7867
  };
7117
7868
  }
7869
+ /**
7870
+ * Request parameters for listWorkspaceInvoices operation in DefaultApi.
7871
+ * @export
7872
+ * @interface DefaultApiListWorkspaceInvoicesRequest
7873
+ */
7874
+ export interface DefaultApiListWorkspaceInvoicesRequest {
7875
+ /**
7876
+ * Workspace ID
7877
+ * @type {string}
7878
+ * @memberof DefaultApiListWorkspaceInvoices
7879
+ */
7880
+ readonly id: string;
7881
+ }
7118
7882
  /**
7119
7883
  * Request parameters for listWorkspaceMembers operation in DefaultApi.
7120
7884
  * @export
@@ -7161,7 +7925,7 @@ export interface DefaultApiListWorkspaceUsagesRequest {
7161
7925
  readonly id: string;
7162
7926
  /**
7163
7927
  * Type of usage
7164
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count'}
7928
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'cognitive_calls' | 'model_credit'}
7165
7929
  * @memberof DefaultApiListWorkspaceUsages
7166
7930
  */
7167
7931
  readonly type: ListWorkspaceUsagesTypeEnum;
@@ -7247,6 +8011,25 @@ export interface DefaultApiSetStateRequest {
7247
8011
  */
7248
8012
  readonly setStateBody?: SetStateBody;
7249
8013
  }
8014
+ /**
8015
+ * Request parameters for setWorkspacePaymentMethod operation in DefaultApi.
8016
+ * @export
8017
+ * @interface DefaultApiSetWorkspacePaymentMethodRequest
8018
+ */
8019
+ export interface DefaultApiSetWorkspacePaymentMethodRequest {
8020
+ /**
8021
+ * Workspace ID
8022
+ * @type {string}
8023
+ * @memberof DefaultApiSetWorkspacePaymentMethod
8024
+ */
8025
+ readonly id: string;
8026
+ /**
8027
+ *
8028
+ * @type {SetWorkspacePaymentMethodBody}
8029
+ * @memberof DefaultApiSetWorkspacePaymentMethod
8030
+ */
8031
+ readonly setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody;
8032
+ }
7250
8033
  /**
7251
8034
  * Request parameters for transferBot operation in DefaultApi.
7252
8035
  * @export
@@ -7422,6 +8205,14 @@ export declare class DefaultApi extends BaseAPI {
7422
8205
  * @memberof DefaultApi
7423
8206
  */
7424
8207
  changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeWorkspacePlanResponse, any>>;
8208
+ /**
8209
+ * Charge unpaid invoices of a workspace.
8210
+ * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
8211
+ * @param {*} [options] Override http request option.
8212
+ * @throws {RequiredError}
8213
+ * @memberof DefaultApi
8214
+ */
8215
+ chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChargeWorkspaceUnpaidInvoicesResponse, any>>;
7425
8216
  /**
7426
8217
  * An integration can call this endpoint to configure itself
7427
8218
  * @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
@@ -7773,6 +8564,14 @@ export declare class DefaultApi extends BaseAPI {
7773
8564
  * @memberof DefaultApi
7774
8565
  */
7775
8566
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
8567
+ /**
8568
+ * Get billing details of workspace
8569
+ * @param {DefaultApiGetWorkspaceBillingDetailsRequest} requestParameters Request parameters.
8570
+ * @param {*} [options] Override http request option.
8571
+ * @throws {RequiredError}
8572
+ * @memberof DefaultApi
8573
+ */
8574
+ getWorkspaceBillingDetails(requestParameters: DefaultApiGetWorkspaceBillingDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceBillingDetailsResponse, any>>;
7776
8575
  /**
7777
8576
  * Get workspace quota
7778
8577
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -7884,6 +8683,14 @@ export declare class DefaultApi extends BaseAPI {
7884
8683
  * @memberof DefaultApi
7885
8684
  */
7886
8685
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsersResponse, any>>;
8686
+ /**
8687
+ * List invoices billed to workspace
8688
+ * @param {DefaultApiListWorkspaceInvoicesRequest} requestParameters Request parameters.
8689
+ * @param {*} [options] Override http request option.
8690
+ * @throws {RequiredError}
8691
+ * @memberof DefaultApi
8692
+ */
8693
+ listWorkspaceInvoices(requestParameters: DefaultApiListWorkspaceInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceInvoicesResponse, any>>;
7887
8694
  /**
7888
8695
  * Lists all the members in a workspace
7889
8696
  * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
@@ -7932,6 +8739,14 @@ export declare class DefaultApi extends BaseAPI {
7932
8739
  * @memberof DefaultApi
7933
8740
  */
7934
8741
  setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetStateResponse, any>>;
8742
+ /**
8743
+ * Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.
8744
+ * @param {DefaultApiSetWorkspacePaymentMethodRequest} requestParameters Request parameters.
8745
+ * @param {*} [options] Override http request option.
8746
+ * @throws {RequiredError}
8747
+ * @memberof DefaultApi
8748
+ */
8749
+ setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetWorkspacePaymentMethodResponse, any>>;
7935
8750
  /**
7936
8751
  * 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.
7937
8752
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -8030,6 +8845,8 @@ export declare const GetUsageTypeEnum: {
8030
8845
  readonly TableRowCount: "table_row_count";
8031
8846
  readonly WorkspaceMemberCount: "workspace_member_count";
8032
8847
  readonly IntegrationsOwnedCount: "integrations_owned_count";
8848
+ readonly CognitiveCalls: "cognitive_calls";
8849
+ readonly ModelCredit: "model_credit";
8033
8850
  };
8034
8851
  export type GetUsageTypeEnum = typeof GetUsageTypeEnum[keyof typeof GetUsageTypeEnum];
8035
8852
  /**
@@ -8045,6 +8862,8 @@ export declare const GetWorkspaceQuotaTypeEnum: {
8045
8862
  readonly TableRowCount: "table_row_count";
8046
8863
  readonly WorkspaceMemberCount: "workspace_member_count";
8047
8864
  readonly IntegrationsOwnedCount: "integrations_owned_count";
8865
+ readonly CognitiveCalls: "cognitive_calls";
8866
+ readonly ModelCredit: "model_credit";
8048
8867
  };
8049
8868
  export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
8050
8869
  /**
@@ -8060,6 +8879,8 @@ export declare const ListUsageHistoryTypeEnum: {
8060
8879
  readonly TableRowCount: "table_row_count";
8061
8880
  readonly WorkspaceMemberCount: "workspace_member_count";
8062
8881
  readonly IntegrationsOwnedCount: "integrations_owned_count";
8882
+ readonly CognitiveCalls: "cognitive_calls";
8883
+ readonly ModelCredit: "model_credit";
8063
8884
  };
8064
8885
  export type ListUsageHistoryTypeEnum = typeof ListUsageHistoryTypeEnum[keyof typeof ListUsageHistoryTypeEnum];
8065
8886
  /**
@@ -8075,6 +8896,8 @@ export declare const ListWorkspaceUsagesTypeEnum: {
8075
8896
  readonly TableRowCount: "table_row_count";
8076
8897
  readonly WorkspaceMemberCount: "workspace_member_count";
8077
8898
  readonly IntegrationsOwnedCount: "integrations_owned_count";
8899
+ readonly CognitiveCalls: "cognitive_calls";
8900
+ readonly ModelCredit: "model_credit";
8078
8901
  };
8079
8902
  export type ListWorkspaceUsagesTypeEnum = typeof ListWorkspaceUsagesTypeEnum[keyof typeof ListWorkspaceUsagesTypeEnum];
8080
8903
  /**