@botpress/client 0.6.1 → 0.6.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/gen/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.10.0
5
+ * The version of the OpenAPI document: 0.12.5
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -223,6 +223,18 @@ 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;
232
+ /**
233
+ *
234
+ * @type {string}
235
+ * @memberof BotIntegrationsValue
236
+ */
237
+ 'identifier'?: string;
226
238
  /**
227
239
  *
228
240
  * @type {{ [key: string]: any; }}
@@ -440,6 +452,12 @@ export interface ChangeWorkspacePlanResponse {
440
452
  * @memberof ChangeWorkspacePlanResponse
441
453
  */
442
454
  'accountType': ChangeWorkspacePlanResponseAccountTypeEnum;
455
+ /**
456
+ *
457
+ * @type {string}
458
+ * @memberof ChangeWorkspacePlanResponse
459
+ */
460
+ 'plan': ChangeWorkspacePlanResponsePlanEnum;
443
461
  /**
444
462
  *
445
463
  * @type {boolean}
@@ -458,6 +476,88 @@ export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
458
476
  readonly Premium: "premium";
459
477
  };
460
478
  export type ChangeWorkspacePlanResponseAccountTypeEnum = typeof ChangeWorkspacePlanResponseAccountTypeEnum[keyof typeof ChangeWorkspacePlanResponseAccountTypeEnum];
479
+ export declare const ChangeWorkspacePlanResponsePlanEnum: {
480
+ readonly Community: "community";
481
+ readonly Team: "team";
482
+ readonly Enterprise: "enterprise";
483
+ };
484
+ export type ChangeWorkspacePlanResponsePlanEnum = typeof ChangeWorkspacePlanResponsePlanEnum[keyof typeof ChangeWorkspacePlanResponsePlanEnum];
485
+ /**
486
+ *
487
+ * @export
488
+ * @interface ChargeWorkspaceUnpaidInvoicesBody
489
+ */
490
+ export interface ChargeWorkspaceUnpaidInvoicesBody {
491
+ /**
492
+ *
493
+ * @type {Array<string>}
494
+ * @memberof ChargeWorkspaceUnpaidInvoicesBody
495
+ */
496
+ 'invoiceIds'?: Array<string>;
497
+ }
498
+ /**
499
+ *
500
+ * @export
501
+ * @interface ChargeWorkspaceUnpaidInvoicesResponse
502
+ */
503
+ export interface ChargeWorkspaceUnpaidInvoicesResponse {
504
+ /**
505
+ * Invoices that were successfully charged by this request.
506
+ * @type {Array<ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner>}
507
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponse
508
+ */
509
+ 'chargedInvoices': Array<ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner>;
510
+ /**
511
+ * Invoices that failed to be charged by this request.
512
+ * @type {Array<ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner>}
513
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponse
514
+ */
515
+ 'failedInvoices': Array<ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner>;
516
+ }
517
+ /**
518
+ *
519
+ * @export
520
+ * @interface ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
521
+ */
522
+ export interface ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner {
523
+ /**
524
+ *
525
+ * @type {string}
526
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
527
+ */
528
+ 'id': string;
529
+ /**
530
+ *
531
+ * @type {number}
532
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseChargedInvoicesInner
533
+ */
534
+ 'amount': number;
535
+ }
536
+ /**
537
+ *
538
+ * @export
539
+ * @interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
540
+ */
541
+ export interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner {
542
+ /**
543
+ *
544
+ * @type {string}
545
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
546
+ */
547
+ 'id': string;
548
+ /**
549
+ *
550
+ * @type {number}
551
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
552
+ */
553
+ 'amount': number;
554
+ /**
555
+ *
556
+ * @type {string}
557
+ * @memberof ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner
558
+ */
559
+ 'failedReason': string;
560
+ }
461
561
  /**
462
562
  *
463
563
  * @export
@@ -508,7 +608,7 @@ export interface Conversation {
508
608
  */
509
609
  'integration': string;
510
610
  /**
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.
611
+ * 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
612
  * @type {{ [key: string]: string; }}
513
613
  * @memberof Conversation
514
614
  */
@@ -856,6 +956,24 @@ export interface CreateEventBody {
856
956
  * @memberof CreateEventBody
857
957
  */
858
958
  'schedule'?: CreateEventBodySchedule;
959
+ /**
960
+ * ID of the [Conversation](#schema_conversation) to link the event to.
961
+ * @type {string}
962
+ * @memberof CreateEventBody
963
+ */
964
+ 'conversationId'?: string;
965
+ /**
966
+ * ID of the [User](#schema_user) to link the event to.
967
+ * @type {string}
968
+ * @memberof CreateEventBody
969
+ */
970
+ 'userId'?: string;
971
+ /**
972
+ * ID of the [Message](#schema_message) to link the event to.
973
+ * @type {string}
974
+ * @memberof CreateEventBody
975
+ */
976
+ 'messageId'?: string;
859
977
  }
860
978
  /**
861
979
  * Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
@@ -986,6 +1104,12 @@ export interface CreateIntegrationBody {
986
1104
  'actions'?: {
987
1105
  [key: string]: CreateIntegrationBodyActionsValue;
988
1106
  };
1107
+ /**
1108
+ *
1109
+ * @type {CreateIntegrationBodyIdentifier}
1110
+ * @memberof CreateIntegrationBody
1111
+ */
1112
+ 'identifier'?: CreateIntegrationBodyIdentifier;
989
1113
  /**
990
1114
  *
991
1115
  * @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
@@ -1184,7 +1308,7 @@ export interface CreateIntegrationBodyChannelsValueMessagesValue {
1184
1308
  };
1185
1309
  }
1186
1310
  /**
1187
- * Configuration definition
1311
+ *
1188
1312
  * @export
1189
1313
  * @interface CreateIntegrationBodyConfiguration
1190
1314
  */
@@ -1194,9 +1318,47 @@ export interface CreateIntegrationBodyConfiguration {
1194
1318
  * @type {{ [key: string]: any; }}
1195
1319
  * @memberof CreateIntegrationBodyConfiguration
1196
1320
  */
1197
- 'schema': {
1321
+ 'schema'?: {
1198
1322
  [key: string]: any;
1199
1323
  };
1324
+ /**
1325
+ *
1326
+ * @type {CreateIntegrationBodyConfigurationIdentifier}
1327
+ * @memberof CreateIntegrationBodyConfiguration
1328
+ */
1329
+ 'identifier'?: CreateIntegrationBodyConfigurationIdentifier;
1330
+ }
1331
+ /**
1332
+ *
1333
+ * @export
1334
+ * @interface CreateIntegrationBodyConfigurationIdentifier
1335
+ */
1336
+ export interface CreateIntegrationBodyConfigurationIdentifier {
1337
+ /**
1338
+ *
1339
+ * @type {boolean}
1340
+ * @memberof CreateIntegrationBodyConfigurationIdentifier
1341
+ */
1342
+ 'required'?: boolean;
1343
+ /**
1344
+ *
1345
+ * @type {string}
1346
+ * @memberof CreateIntegrationBodyConfigurationIdentifier
1347
+ */
1348
+ 'linkTemplateScript'?: string;
1349
+ }
1350
+ /**
1351
+ *
1352
+ * @export
1353
+ * @interface CreateIntegrationBodyIdentifier
1354
+ */
1355
+ export interface CreateIntegrationBodyIdentifier {
1356
+ /**
1357
+ *
1358
+ * @type {string}
1359
+ * @memberof CreateIntegrationBodyIdentifier
1360
+ */
1361
+ 'extractScript'?: string;
1200
1362
  }
1201
1363
  /**
1202
1364
  * State definition
@@ -1434,6 +1596,18 @@ export interface CreateUserBody {
1434
1596
  * @memberof CreateUserBody
1435
1597
  */
1436
1598
  'integrationName'?: string;
1599
+ /**
1600
+ * Name of the user
1601
+ * @type {string}
1602
+ * @memberof CreateUserBody
1603
+ */
1604
+ 'name'?: string;
1605
+ /**
1606
+ * URL of the user picture
1607
+ * @type {string}
1608
+ * @memberof CreateUserBody
1609
+ */
1610
+ 'pictureUrl'?: string;
1437
1611
  }
1438
1612
  /**
1439
1613
  *
@@ -1577,6 +1751,12 @@ export interface CreateWorkspaceResponse {
1577
1751
  * @memberof CreateWorkspaceResponse
1578
1752
  */
1579
1753
  'accountType': CreateWorkspaceResponseAccountTypeEnum;
1754
+ /**
1755
+ *
1756
+ * @type {string}
1757
+ * @memberof CreateWorkspaceResponse
1758
+ */
1759
+ 'plan': CreateWorkspaceResponsePlanEnum;
1580
1760
  /**
1581
1761
  *
1582
1762
  * @type {boolean}
@@ -1595,6 +1775,12 @@ export declare const CreateWorkspaceResponseAccountTypeEnum: {
1595
1775
  readonly Premium: "premium";
1596
1776
  };
1597
1777
  export type CreateWorkspaceResponseAccountTypeEnum = typeof CreateWorkspaceResponseAccountTypeEnum[keyof typeof CreateWorkspaceResponseAccountTypeEnum];
1778
+ export declare const CreateWorkspaceResponsePlanEnum: {
1779
+ readonly Community: "community";
1780
+ readonly Team: "team";
1781
+ readonly Enterprise: "enterprise";
1782
+ };
1783
+ export type CreateWorkspaceResponsePlanEnum = typeof CreateWorkspaceResponsePlanEnum[keyof typeof CreateWorkspaceResponsePlanEnum];
1598
1784
  /**
1599
1785
  * The event object represents an action or an occurrence.
1600
1786
  * @export
@@ -1627,6 +1813,24 @@ export interface Event {
1627
1813
  'payload': {
1628
1814
  [key: string]: any;
1629
1815
  };
1816
+ /**
1817
+ * ID of the [Conversation](#schema_conversation) to link the event to.
1818
+ * @type {string}
1819
+ * @memberof Event
1820
+ */
1821
+ 'conversationId'?: string;
1822
+ /**
1823
+ * ID of the [User](#schema_user) to link the event to.
1824
+ * @type {string}
1825
+ * @memberof Event
1826
+ */
1827
+ 'userId'?: string;
1828
+ /**
1829
+ * ID of the [Message](#schema_message) to link the event to.
1830
+ * @type {string}
1831
+ * @memberof Event
1832
+ */
1833
+ 'messageId'?: string;
1630
1834
  }
1631
1835
  /**
1632
1836
  *
@@ -1806,11 +2010,37 @@ export interface GetBotAnalyticsResponseRecordsInner {
1806
2010
  */
1807
2011
  'sessions': number;
1808
2012
  /**
1809
- *
2013
+ * Deprecated. Use `userMessages` instead.
1810
2014
  * @type {number}
1811
2015
  * @memberof GetBotAnalyticsResponseRecordsInner
1812
2016
  */
1813
2017
  'messages': number;
2018
+ /**
2019
+ *
2020
+ * @type {number}
2021
+ * @memberof GetBotAnalyticsResponseRecordsInner
2022
+ */
2023
+ 'userMessages': number;
2024
+ /**
2025
+ *
2026
+ * @type {number}
2027
+ * @memberof GetBotAnalyticsResponseRecordsInner
2028
+ */
2029
+ 'botMessages': number;
2030
+ /**
2031
+ *
2032
+ * @type {number}
2033
+ * @memberof GetBotAnalyticsResponseRecordsInner
2034
+ */
2035
+ 'events': number;
2036
+ /**
2037
+ *
2038
+ * @type {{ [key: string]: number; }}
2039
+ * @memberof GetBotAnalyticsResponseRecordsInner
2040
+ */
2041
+ 'eventTypes': {
2042
+ [key: string]: number;
2043
+ };
1814
2044
  }
1815
2045
  /**
1816
2046
  *
@@ -2099,6 +2329,18 @@ export interface GetOrCreateUserBody {
2099
2329
  * @memberof GetOrCreateUserBody
2100
2330
  */
2101
2331
  'integrationName'?: string;
2332
+ /**
2333
+ * Name of the user
2334
+ * @type {string}
2335
+ * @memberof GetOrCreateUserBody
2336
+ */
2337
+ 'name'?: string;
2338
+ /**
2339
+ * URL of the user picture
2340
+ * @type {string}
2341
+ * @memberof GetOrCreateUserBody
2342
+ */
2343
+ 'pictureUrl'?: string;
2102
2344
  }
2103
2345
  /**
2104
2346
  *
@@ -2178,6 +2420,125 @@ export interface GetUserResponse {
2178
2420
  */
2179
2421
  'user': User;
2180
2422
  }
2423
+ /**
2424
+ *
2425
+ * @export
2426
+ * @interface GetWorkspaceBillingDetailsResponse
2427
+ */
2428
+ export interface GetWorkspaceBillingDetailsResponse {
2429
+ /**
2430
+ *
2431
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriod}
2432
+ * @memberof GetWorkspaceBillingDetailsResponse
2433
+ */
2434
+ 'currentPeriod': GetWorkspaceBillingDetailsResponseCurrentPeriod;
2435
+ /**
2436
+ *
2437
+ * @type {GetWorkspaceBillingDetailsResponsePaymentMethod}
2438
+ * @memberof GetWorkspaceBillingDetailsResponse
2439
+ */
2440
+ 'paymentMethod': GetWorkspaceBillingDetailsResponsePaymentMethod | null;
2441
+ }
2442
+ /**
2443
+ *
2444
+ * @export
2445
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriod
2446
+ */
2447
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriod {
2448
+ /**
2449
+ *
2450
+ * @type {string}
2451
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2452
+ */
2453
+ 'start': string;
2454
+ /**
2455
+ *
2456
+ * @type {string}
2457
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2458
+ */
2459
+ 'end': string;
2460
+ /**
2461
+ *
2462
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriodUsage}
2463
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriod
2464
+ */
2465
+ 'usage': GetWorkspaceBillingDetailsResponseCurrentPeriodUsage;
2466
+ }
2467
+ /**
2468
+ *
2469
+ * @export
2470
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsage
2471
+ */
2472
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsage {
2473
+ /**
2474
+ *
2475
+ * @type {GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages}
2476
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsage
2477
+ */
2478
+ 'userMessages': GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages;
2479
+ }
2480
+ /**
2481
+ *
2482
+ * @export
2483
+ * @interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2484
+ */
2485
+ export interface GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages {
2486
+ /**
2487
+ *
2488
+ * @type {string}
2489
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2490
+ */
2491
+ 'status': GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum;
2492
+ /**
2493
+ *
2494
+ * @type {number}
2495
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2496
+ */
2497
+ 'quantity': number;
2498
+ /**
2499
+ *
2500
+ * @type {number}
2501
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2502
+ */
2503
+ 'price': number;
2504
+ /**
2505
+ *
2506
+ * @type {number}
2507
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2508
+ */
2509
+ 'minimum': number;
2510
+ /**
2511
+ *
2512
+ * @type {number}
2513
+ * @memberof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessages
2514
+ */
2515
+ 'maximum': number;
2516
+ }
2517
+ export declare const GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum: {
2518
+ readonly Ok: "OK";
2519
+ readonly Warning: "Warning";
2520
+ readonly LimitReached: "LimitReached";
2521
+ };
2522
+ export type GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum = typeof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum[keyof typeof GetWorkspaceBillingDetailsResponseCurrentPeriodUsageUserMessagesStatusEnum];
2523
+ /**
2524
+ *
2525
+ * @export
2526
+ * @interface GetWorkspaceBillingDetailsResponsePaymentMethod
2527
+ */
2528
+ export interface GetWorkspaceBillingDetailsResponsePaymentMethod {
2529
+ /**
2530
+ *
2531
+ * @type {string}
2532
+ * @memberof GetWorkspaceBillingDetailsResponsePaymentMethod
2533
+ */
2534
+ 'type': string;
2535
+ /**
2536
+ *
2537
+ * @type {string}
2538
+ * @memberof GetWorkspaceBillingDetailsResponsePaymentMethod
2539
+ */
2540
+ 'lastDigits': string;
2541
+ }
2181
2542
  /**
2182
2543
  *
2183
2544
  * @export
@@ -2226,6 +2587,8 @@ export declare const GetWorkspaceQuotaResponseQuotaTypeEnum: {
2226
2587
  readonly TableRowCount: "table_row_count";
2227
2588
  readonly WorkspaceMemberCount: "workspace_member_count";
2228
2589
  readonly IntegrationsOwnedCount: "integrations_owned_count";
2590
+ readonly CognitiveCalls: "cognitive_calls";
2591
+ readonly ModelCredit: "model_credit";
2229
2592
  };
2230
2593
  export type GetWorkspaceQuotaResponseQuotaTypeEnum = typeof GetWorkspaceQuotaResponseQuotaTypeEnum[keyof typeof GetWorkspaceQuotaResponseQuotaTypeEnum];
2231
2594
  /**
@@ -2276,6 +2639,12 @@ export interface GetWorkspaceResponse {
2276
2639
  * @memberof GetWorkspaceResponse
2277
2640
  */
2278
2641
  'accountType': GetWorkspaceResponseAccountTypeEnum;
2642
+ /**
2643
+ *
2644
+ * @type {string}
2645
+ * @memberof GetWorkspaceResponse
2646
+ */
2647
+ 'plan': GetWorkspaceResponsePlanEnum;
2279
2648
  /**
2280
2649
  *
2281
2650
  * @type {boolean}
@@ -2294,6 +2663,12 @@ export declare const GetWorkspaceResponseAccountTypeEnum: {
2294
2663
  readonly Premium: "premium";
2295
2664
  };
2296
2665
  export type GetWorkspaceResponseAccountTypeEnum = typeof GetWorkspaceResponseAccountTypeEnum[keyof typeof GetWorkspaceResponseAccountTypeEnum];
2666
+ export declare const GetWorkspaceResponsePlanEnum: {
2667
+ readonly Community: "community";
2668
+ readonly Team: "team";
2669
+ readonly Enterprise: "enterprise";
2670
+ };
2671
+ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[keyof typeof GetWorkspaceResponsePlanEnum];
2297
2672
  /**
2298
2673
  *
2299
2674
  * @export
@@ -2318,6 +2693,12 @@ export interface Integration {
2318
2693
  * @memberof Integration
2319
2694
  */
2320
2695
  'updatedAt': string;
2696
+ /**
2697
+ *
2698
+ * @type {IntegrationIdentifier}
2699
+ * @memberof Integration
2700
+ */
2701
+ 'identifier': IntegrationIdentifier;
2321
2702
  /**
2322
2703
  * Name of the [Integration](#schema_integration)
2323
2704
  * @type {string}
@@ -2332,10 +2713,10 @@ export interface Integration {
2332
2713
  'version': string;
2333
2714
  /**
2334
2715
  *
2335
- * @type {CreateIntegrationBodyConfiguration}
2716
+ * @type {IntegrationConfiguration}
2336
2717
  * @memberof Integration
2337
2718
  */
2338
- 'configuration': CreateIntegrationBodyConfiguration;
2719
+ 'configuration': IntegrationConfiguration;
2339
2720
  /**
2340
2721
  *
2341
2722
  * @type {{ [key: string]: IntegrationChannelsValue; }}
@@ -2465,6 +2846,59 @@ export interface IntegrationChannelsValueConversation {
2465
2846
  */
2466
2847
  'creation': CreateIntegrationBodyChannelsValueConversationCreation;
2467
2848
  }
2849
+ /**
2850
+ * Configuration definition
2851
+ * @export
2852
+ * @interface IntegrationConfiguration
2853
+ */
2854
+ export interface IntegrationConfiguration {
2855
+ /**
2856
+ *
2857
+ * @type {IntegrationConfigurationIdentifier}
2858
+ * @memberof IntegrationConfiguration
2859
+ */
2860
+ 'identifier': IntegrationConfigurationIdentifier;
2861
+ /**
2862
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
2863
+ * @type {{ [key: string]: any; }}
2864
+ * @memberof IntegrationConfiguration
2865
+ */
2866
+ 'schema'?: {
2867
+ [key: string]: any;
2868
+ };
2869
+ }
2870
+ /**
2871
+ * Identifier configuration of the [Integration](#schema_integration)
2872
+ * @export
2873
+ * @interface IntegrationConfigurationIdentifier
2874
+ */
2875
+ export interface IntegrationConfigurationIdentifier {
2876
+ /**
2877
+ *
2878
+ * @type {string}
2879
+ * @memberof IntegrationConfigurationIdentifier
2880
+ */
2881
+ 'linkTemplateScript'?: string;
2882
+ /**
2883
+ *
2884
+ * @type {boolean}
2885
+ * @memberof IntegrationConfigurationIdentifier
2886
+ */
2887
+ 'required': boolean;
2888
+ }
2889
+ /**
2890
+ * Global identifier configuration of the [Integration](#schema_integration)
2891
+ * @export
2892
+ * @interface IntegrationIdentifier
2893
+ */
2894
+ export interface IntegrationIdentifier {
2895
+ /**
2896
+ * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
2897
+ * @type {string}
2898
+ * @memberof IntegrationIdentifier
2899
+ */
2900
+ 'extractScript'?: string;
2901
+ }
2468
2902
  /**
2469
2903
  * User object configuration
2470
2904
  * @export
@@ -2568,10 +3002,12 @@ export interface Issue {
2568
3002
  'description': string;
2569
3003
  /**
2570
3004
  *
2571
- * @type {object}
3005
+ * @type {{ [key: string]: IssueGroupedDataValue; }}
2572
3006
  * @memberof Issue
2573
3007
  */
2574
- 'groupedData': object;
3008
+ 'groupedData': {
3009
+ [key: string]: IssueGroupedDataValue;
3010
+ };
2575
3011
  /**
2576
3012
  *
2577
3013
  * @type {number}
@@ -2618,10 +3054,31 @@ export interface IssueEvent {
2618
3054
  'createdAt': string;
2619
3055
  /**
2620
3056
  *
2621
- * @type {object}
3057
+ * @type {{ [key: string]: IssueGroupedDataValue; }}
2622
3058
  * @memberof IssueEvent
2623
3059
  */
2624
- 'data': object;
3060
+ 'data': {
3061
+ [key: string]: IssueGroupedDataValue;
3062
+ };
3063
+ }
3064
+ /**
3065
+ *
3066
+ * @export
3067
+ * @interface IssueGroupedDataValue
3068
+ */
3069
+ export interface IssueGroupedDataValue {
3070
+ /**
3071
+ *
3072
+ * @type {string}
3073
+ * @memberof IssueGroupedDataValue
3074
+ */
3075
+ 'raw': string;
3076
+ /**
3077
+ *
3078
+ * @type {string}
3079
+ * @memberof IssueGroupedDataValue
3080
+ */
3081
+ 'pretty'?: string;
2625
3082
  }
2626
3083
  /**
2627
3084
  *
@@ -2656,10 +3113,12 @@ export interface ListBotIssueEventsResponseIssueEventsInner {
2656
3113
  'createdAt': string;
2657
3114
  /**
2658
3115
  *
2659
- * @type {object}
3116
+ * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
2660
3117
  * @memberof ListBotIssueEventsResponseIssueEventsInner
2661
3118
  */
2662
- 'data': object;
3119
+ 'data': {
3120
+ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
3121
+ };
2663
3122
  }
2664
3123
  /**
2665
3124
  *
@@ -2724,10 +3183,12 @@ export interface ListBotIssuesResponseIssuesInner {
2724
3183
  'description': string;
2725
3184
  /**
2726
3185
  *
2727
- * @type {object}
3186
+ * @type {{ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue; }}
2728
3187
  * @memberof ListBotIssuesResponseIssuesInner
2729
3188
  */
2730
- 'groupedData': object;
3189
+ 'groupedData': {
3190
+ [key: string]: ListBotIssuesResponseIssuesInnerGroupedDataValue;
3191
+ };
2731
3192
  /**
2732
3193
  *
2733
3194
  * @type {number}
@@ -2754,6 +3215,25 @@ export declare const ListBotIssuesResponseIssuesInnerCategoryEnum: {
2754
3215
  readonly Other: "other";
2755
3216
  };
2756
3217
  export type ListBotIssuesResponseIssuesInnerCategoryEnum = typeof ListBotIssuesResponseIssuesInnerCategoryEnum[keyof typeof ListBotIssuesResponseIssuesInnerCategoryEnum];
3218
+ /**
3219
+ *
3220
+ * @export
3221
+ * @interface ListBotIssuesResponseIssuesInnerGroupedDataValue
3222
+ */
3223
+ export interface ListBotIssuesResponseIssuesInnerGroupedDataValue {
3224
+ /**
3225
+ *
3226
+ * @type {string}
3227
+ * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
3228
+ */
3229
+ 'raw': string;
3230
+ /**
3231
+ *
3232
+ * @type {string}
3233
+ * @memberof ListBotIssuesResponseIssuesInnerGroupedDataValue
3234
+ */
3235
+ 'pretty'?: string;
3236
+ }
2757
3237
  /**
2758
3238
  *
2759
3239
  * @export
@@ -3046,21 +3526,119 @@ export interface ListUsageHistoryResponse {
3046
3526
  /**
3047
3527
  *
3048
3528
  * @export
3049
- * @interface ListUsersResponse
3529
+ * @interface ListUsersResponse
3530
+ */
3531
+ export interface ListUsersResponse {
3532
+ /**
3533
+ *
3534
+ * @type {Array<User>}
3535
+ * @memberof ListUsersResponse
3536
+ */
3537
+ 'users': Array<User>;
3538
+ /**
3539
+ *
3540
+ * @type {ListConversationsResponseMeta}
3541
+ * @memberof ListUsersResponse
3542
+ */
3543
+ 'meta': ListConversationsResponseMeta;
3544
+ }
3545
+ /**
3546
+ *
3547
+ * @export
3548
+ * @interface ListWorkspaceInvoicesResponse
3549
+ */
3550
+ export interface ListWorkspaceInvoicesResponse {
3551
+ /**
3552
+ *
3553
+ * @type {Array<ListWorkspaceInvoicesResponseInvoicesInner>}
3554
+ * @memberof ListWorkspaceInvoicesResponse
3555
+ */
3556
+ 'invoices': Array<ListWorkspaceInvoicesResponseInvoicesInner>;
3557
+ }
3558
+ /**
3559
+ *
3560
+ * @export
3561
+ * @interface ListWorkspaceInvoicesResponseInvoicesInner
3562
+ */
3563
+ export interface ListWorkspaceInvoicesResponseInvoicesInner {
3564
+ /**
3565
+ *
3566
+ * @type {string}
3567
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3568
+ */
3569
+ 'id': string;
3570
+ /**
3571
+ *
3572
+ * @type {ListWorkspaceInvoicesResponseInvoicesInnerPeriod}
3573
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3574
+ */
3575
+ 'period': ListWorkspaceInvoicesResponseInvoicesInnerPeriod;
3576
+ /**
3577
+ * Date on which the invoice was generated.
3578
+ * @type {string}
3579
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3580
+ */
3581
+ 'date': string;
3582
+ /**
3583
+ * Total amount to pay of the invoice.
3584
+ * @type {number}
3585
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3586
+ */
3587
+ 'amount': number;
3588
+ /**
3589
+ * Currency of the invoice amount.
3590
+ * @type {string}
3591
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3592
+ */
3593
+ 'currency': string;
3594
+ /**
3595
+ *
3596
+ * @type {string}
3597
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3598
+ */
3599
+ 'paymentStatus': ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum;
3600
+ /**
3601
+ * Number of times payment has been unsuccessfully attempted on the invoice.
3602
+ * @type {number}
3603
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3604
+ */
3605
+ 'paymentAttemptCount': number | null;
3606
+ /**
3607
+ * Date on which the next payment attempt will be made.
3608
+ * @type {string}
3609
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3610
+ */
3611
+ 'nextPaymentAttemptDate': string | null;
3612
+ /**
3613
+ * URL to download the PDF file of the invoice.
3614
+ * @type {string}
3615
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInner
3616
+ */
3617
+ 'pdfUrl': string;
3618
+ }
3619
+ export declare const ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum: {
3620
+ readonly Paid: "paid";
3621
+ readonly Unpaid: "unpaid";
3622
+ };
3623
+ export type ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum = typeof ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum[keyof typeof ListWorkspaceInvoicesResponseInvoicesInnerPaymentStatusEnum];
3624
+ /**
3625
+ *
3626
+ * @export
3627
+ * @interface ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3050
3628
  */
3051
- export interface ListUsersResponse {
3629
+ export interface ListWorkspaceInvoicesResponseInvoicesInnerPeriod {
3052
3630
  /**
3053
3631
  *
3054
- * @type {Array<User>}
3055
- * @memberof ListUsersResponse
3632
+ * @type {number}
3633
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3056
3634
  */
3057
- 'users': Array<User>;
3635
+ 'month': number;
3058
3636
  /**
3059
3637
  *
3060
- * @type {ListConversationsResponseMeta}
3061
- * @memberof ListUsersResponse
3638
+ * @type {number}
3639
+ * @memberof ListWorkspaceInvoicesResponseInvoicesInnerPeriod
3062
3640
  */
3063
- 'meta': ListConversationsResponseMeta;
3641
+ 'year': number;
3064
3642
  }
3065
3643
  /**
3066
3644
  *
@@ -3169,6 +3747,8 @@ export declare const ListWorkspaceQuotasResponseQuotasInnerTypeEnum: {
3169
3747
  readonly TableRowCount: "table_row_count";
3170
3748
  readonly WorkspaceMemberCount: "workspace_member_count";
3171
3749
  readonly IntegrationsOwnedCount: "integrations_owned_count";
3750
+ readonly CognitiveCalls: "cognitive_calls";
3751
+ readonly ModelCredit: "model_credit";
3172
3752
  };
3173
3753
  export type ListWorkspaceQuotasResponseQuotasInnerTypeEnum = typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum[keyof typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum];
3174
3754
  /**
@@ -3254,7 +3834,7 @@ export interface Message {
3254
3834
  */
3255
3835
  'conversationId': string;
3256
3836
  /**
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.
3837
+ * 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
3838
  * @type {{ [key: string]: string; }}
3259
3839
  * @memberof Message
3260
3840
  */
@@ -3383,6 +3963,72 @@ export interface SetStateResponse {
3383
3963
  */
3384
3964
  'state': State;
3385
3965
  }
3966
+ /**
3967
+ *
3968
+ * @export
3969
+ * @interface SetWorkspacePaymentMethodBody
3970
+ */
3971
+ export interface SetWorkspacePaymentMethodBody {
3972
+ /**
3973
+ * ID of the Stripe PaymentMethod to attach to the workspace.
3974
+ * @type {string}
3975
+ * @memberof SetWorkspacePaymentMethodBody
3976
+ */
3977
+ 'stripePaymentMethodId': string;
3978
+ }
3979
+ /**
3980
+ *
3981
+ * @export
3982
+ * @interface SetWorkspacePaymentMethodResponse
3983
+ */
3984
+ export interface SetWorkspacePaymentMethodResponse {
3985
+ /**
3986
+ *
3987
+ * @type {string}
3988
+ * @memberof SetWorkspacePaymentMethodResponse
3989
+ */
3990
+ 'stripePaymentMethodId': string;
3991
+ /**
3992
+ *
3993
+ * @type {GetWorkspaceBillingDetailsResponsePaymentMethod}
3994
+ * @memberof SetWorkspacePaymentMethodResponse
3995
+ */
3996
+ 'paymentMethod': GetWorkspaceBillingDetailsResponsePaymentMethod | null;
3997
+ /**
3998
+ *
3999
+ * @type {string}
4000
+ * @memberof SetWorkspacePaymentMethodResponse
4001
+ */
4002
+ 'status': SetWorkspacePaymentMethodResponseStatusEnum;
4003
+ /**
4004
+ *
4005
+ * @type {SetWorkspacePaymentMethodResponseNextAction}
4006
+ * @memberof SetWorkspacePaymentMethodResponse
4007
+ */
4008
+ 'nextAction'?: SetWorkspacePaymentMethodResponseNextAction;
4009
+ }
4010
+ export declare const SetWorkspacePaymentMethodResponseStatusEnum: {
4011
+ readonly Succeeded: "succeeded";
4012
+ readonly Processing: "processing";
4013
+ readonly Canceled: "canceled";
4014
+ readonly RequiresConfirmation: "requires_confirmation";
4015
+ readonly RequiresAction: "requires_action";
4016
+ readonly RequiresPaymentMethod: "requires_payment_method";
4017
+ };
4018
+ export type SetWorkspacePaymentMethodResponseStatusEnum = typeof SetWorkspacePaymentMethodResponseStatusEnum[keyof typeof SetWorkspacePaymentMethodResponseStatusEnum];
4019
+ /**
4020
+ * 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.
4021
+ * @export
4022
+ * @interface SetWorkspacePaymentMethodResponseNextAction
4023
+ */
4024
+ export interface SetWorkspacePaymentMethodResponseNextAction {
4025
+ /**
4026
+ *
4027
+ * @type {string}
4028
+ * @memberof SetWorkspacePaymentMethodResponseNextAction
4029
+ */
4030
+ 'redirectToUrl': string;
4031
+ }
3386
4032
  /**
3387
4033
  * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
3388
4034
  * @export
@@ -3760,10 +4406,10 @@ export interface UpdateConversationResponse {
3760
4406
  export interface UpdateIntegrationBody {
3761
4407
  /**
3762
4408
  *
3763
- * @type {CreateIntegrationBodyConfiguration}
4409
+ * @type {UpdateIntegrationBodyConfiguration}
3764
4410
  * @memberof UpdateIntegrationBody
3765
4411
  */
3766
- 'configuration'?: CreateIntegrationBodyConfiguration;
4412
+ 'configuration'?: UpdateIntegrationBodyConfiguration;
3767
4413
  /**
3768
4414
  *
3769
4415
  * @type {{ [key: string]: UpdateIntegrationBodyChannelsValue | null; }}
@@ -3772,6 +4418,12 @@ export interface UpdateIntegrationBody {
3772
4418
  'channels'?: {
3773
4419
  [key: string]: UpdateIntegrationBodyChannelsValue | null;
3774
4420
  };
4421
+ /**
4422
+ *
4423
+ * @type {UpdateIntegrationBodyIdentifier}
4424
+ * @memberof UpdateIntegrationBody
4425
+ */
4426
+ 'identifier'?: UpdateIntegrationBodyIdentifier;
3775
4427
  /**
3776
4428
  *
3777
4429
  * @type {{ [key: string]: UpdateIntegrationBodyActionsValue | null; }}
@@ -3945,6 +4597,59 @@ export interface UpdateIntegrationBodyChannelsValueMessagesValue {
3945
4597
  [key: string]: any;
3946
4598
  };
3947
4599
  }
4600
+ /**
4601
+ *
4602
+ * @export
4603
+ * @interface UpdateIntegrationBodyConfiguration
4604
+ */
4605
+ export interface UpdateIntegrationBodyConfiguration {
4606
+ /**
4607
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
4608
+ * @type {{ [key: string]: any; }}
4609
+ * @memberof UpdateIntegrationBodyConfiguration
4610
+ */
4611
+ 'schema'?: {
4612
+ [key: string]: any;
4613
+ };
4614
+ /**
4615
+ *
4616
+ * @type {UpdateIntegrationBodyConfigurationIdentifier}
4617
+ * @memberof UpdateIntegrationBodyConfiguration
4618
+ */
4619
+ 'identifier'?: UpdateIntegrationBodyConfigurationIdentifier;
4620
+ }
4621
+ /**
4622
+ *
4623
+ * @export
4624
+ * @interface UpdateIntegrationBodyConfigurationIdentifier
4625
+ */
4626
+ export interface UpdateIntegrationBodyConfigurationIdentifier {
4627
+ /**
4628
+ *
4629
+ * @type {string}
4630
+ * @memberof UpdateIntegrationBodyConfigurationIdentifier
4631
+ */
4632
+ 'linkTemplateScript'?: string | null;
4633
+ /**
4634
+ *
4635
+ * @type {boolean}
4636
+ * @memberof UpdateIntegrationBodyConfigurationIdentifier
4637
+ */
4638
+ 'required'?: boolean;
4639
+ }
4640
+ /**
4641
+ *
4642
+ * @export
4643
+ * @interface UpdateIntegrationBodyIdentifier
4644
+ */
4645
+ export interface UpdateIntegrationBodyIdentifier {
4646
+ /**
4647
+ *
4648
+ * @type {string}
4649
+ * @memberof UpdateIntegrationBodyIdentifier
4650
+ */
4651
+ 'extractScript'?: string | null;
4652
+ }
3948
4653
  /**
3949
4654
  * State definition
3950
4655
  * @export
@@ -4048,6 +4753,18 @@ export interface UpdateUserBody {
4048
4753
  'tags': {
4049
4754
  [key: string]: string;
4050
4755
  };
4756
+ /**
4757
+ * Name of the user
4758
+ * @type {string}
4759
+ * @memberof UpdateUserBody
4760
+ */
4761
+ 'name'?: string | null;
4762
+ /**
4763
+ * URL of the user picture
4764
+ * @type {string}
4765
+ * @memberof UpdateUserBody
4766
+ */
4767
+ 'pictureUrl'?: string | null;
4051
4768
  }
4052
4769
  /**
4053
4770
  *
@@ -4191,6 +4908,12 @@ export interface UpdateWorkspaceResponse {
4191
4908
  * @memberof UpdateWorkspaceResponse
4192
4909
  */
4193
4910
  'accountType': UpdateWorkspaceResponseAccountTypeEnum;
4911
+ /**
4912
+ *
4913
+ * @type {string}
4914
+ * @memberof UpdateWorkspaceResponse
4915
+ */
4916
+ 'plan': UpdateWorkspaceResponsePlanEnum;
4194
4917
  /**
4195
4918
  *
4196
4919
  * @type {boolean}
@@ -4209,6 +4932,12 @@ export declare const UpdateWorkspaceResponseAccountTypeEnum: {
4209
4932
  readonly Premium: "premium";
4210
4933
  };
4211
4934
  export type UpdateWorkspaceResponseAccountTypeEnum = typeof UpdateWorkspaceResponseAccountTypeEnum[keyof typeof UpdateWorkspaceResponseAccountTypeEnum];
4935
+ export declare const UpdateWorkspaceResponsePlanEnum: {
4936
+ readonly Community: "community";
4937
+ readonly Team: "team";
4938
+ readonly Enterprise: "enterprise";
4939
+ };
4940
+ export type UpdateWorkspaceResponsePlanEnum = typeof UpdateWorkspaceResponsePlanEnum[keyof typeof UpdateWorkspaceResponsePlanEnum];
4212
4941
  /**
4213
4942
  *
4214
4943
  * @export
@@ -4257,6 +4986,12 @@ export interface UpdateWorkspaceResponse1 {
4257
4986
  * @memberof UpdateWorkspaceResponse1
4258
4987
  */
4259
4988
  'accountType': UpdateWorkspaceResponse1AccountTypeEnum;
4989
+ /**
4990
+ *
4991
+ * @type {string}
4992
+ * @memberof UpdateWorkspaceResponse1
4993
+ */
4994
+ 'plan': UpdateWorkspaceResponse1PlanEnum;
4260
4995
  /**
4261
4996
  *
4262
4997
  * @type {boolean}
@@ -4275,6 +5010,12 @@ export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
4275
5010
  readonly Premium: "premium";
4276
5011
  };
4277
5012
  export type UpdateWorkspaceResponse1AccountTypeEnum = typeof UpdateWorkspaceResponse1AccountTypeEnum[keyof typeof UpdateWorkspaceResponse1AccountTypeEnum];
5013
+ export declare const UpdateWorkspaceResponse1PlanEnum: {
5014
+ readonly Community: "community";
5015
+ readonly Team: "team";
5016
+ readonly Enterprise: "enterprise";
5017
+ };
5018
+ export type UpdateWorkspaceResponse1PlanEnum = typeof UpdateWorkspaceResponse1PlanEnum[keyof typeof UpdateWorkspaceResponse1PlanEnum];
4278
5019
  /**
4279
5020
  *
4280
5021
  * @export
@@ -4322,6 +5063,8 @@ export declare const UsageTypeEnum: {
4322
5063
  readonly TableRowCount: "table_row_count";
4323
5064
  readonly WorkspaceMemberCount: "workspace_member_count";
4324
5065
  readonly IntegrationsOwnedCount: "integrations_owned_count";
5066
+ readonly CognitiveCalls: "cognitive_calls";
5067
+ readonly ModelCredit: "model_credit";
4325
5068
  };
4326
5069
  export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
4327
5070
  /**
@@ -4349,13 +5092,25 @@ export interface User {
4349
5092
  */
4350
5093
  'updatedAt': string;
4351
5094
  /**
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.
5095
+ * 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
5096
  * @type {{ [key: string]: string; }}
4354
5097
  * @memberof User
4355
5098
  */
4356
5099
  'tags': {
4357
5100
  [key: string]: string;
4358
5101
  };
5102
+ /**
5103
+ * Name of the [User](#schema_user)
5104
+ * @type {string}
5105
+ * @memberof User
5106
+ */
5107
+ 'name'?: string;
5108
+ /**
5109
+ * Picture URL of the [User](#schema_user)
5110
+ * @type {string}
5111
+ * @memberof User
5112
+ */
5113
+ 'pictureUrl'?: string;
4359
5114
  }
4360
5115
  /**
4361
5116
  *
@@ -4405,6 +5160,12 @@ export interface Workspace {
4405
5160
  * @memberof Workspace
4406
5161
  */
4407
5162
  'accountType': WorkspaceAccountTypeEnum;
5163
+ /**
5164
+ *
5165
+ * @type {string}
5166
+ * @memberof Workspace
5167
+ */
5168
+ 'plan': WorkspacePlanEnum;
4408
5169
  /**
4409
5170
  *
4410
5171
  * @type {boolean}
@@ -4423,6 +5184,12 @@ export declare const WorkspaceAccountTypeEnum: {
4423
5184
  readonly Premium: "premium";
4424
5185
  };
4425
5186
  export type WorkspaceAccountTypeEnum = typeof WorkspaceAccountTypeEnum[keyof typeof WorkspaceAccountTypeEnum];
5187
+ export declare const WorkspacePlanEnum: {
5188
+ readonly Community: "community";
5189
+ readonly Team: "team";
5190
+ readonly Enterprise: "enterprise";
5191
+ };
5192
+ export type WorkspacePlanEnum = typeof WorkspacePlanEnum[keyof typeof WorkspacePlanEnum];
4426
5193
  /**
4427
5194
  *
4428
5195
  * @export
@@ -4483,6 +5250,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4483
5250
  * @throws {RequiredError}
4484
5251
  */
4485
5252
  changeWorkspacePlan: (id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5253
+ /**
5254
+ * Charge unpaid invoices of a workspace.
5255
+ * @param {string} id Workspace ID
5256
+ * @param {ChargeWorkspaceUnpaidInvoicesBody} [chargeWorkspaceUnpaidInvoicesBody]
5257
+ * @param {*} [options] Override http request option.
5258
+ * @throws {RequiredError}
5259
+ */
5260
+ chargeWorkspaceUnpaidInvoices: (id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4486
5261
  /**
4487
5262
  * An integration can call this endpoint to configure itself
4488
5263
  * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
@@ -4807,6 +5582,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4807
5582
  * @throws {RequiredError}
4808
5583
  */
4809
5584
  getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5585
+ /**
5586
+ * Get billing details of workspace
5587
+ * @param {string} id Workspace ID
5588
+ * @param {*} [options] Override http request option.
5589
+ * @throws {RequiredError}
5590
+ */
5591
+ getWorkspaceBillingDetails: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4810
5592
  /**
4811
5593
  * Get workspace quota
4812
5594
  * @param {string} id Workspace ID
@@ -4861,10 +5643,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4861
5643
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
4862
5644
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4863
5645
  * @param {string} [type] Filter by event type
5646
+ * @param {string} [conversationId] Filter by conversation id
5647
+ * @param {string} [userId] Filter by user id
5648
+ * @param {string} [messageId] Filter by message id
4864
5649
  * @param {*} [options] Override http request option.
4865
5650
  * @throws {RequiredError}
4866
5651
  */
4867
- listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5652
+ listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4868
5653
  /**
4869
5654
  * List Files
4870
5655
  * @param {string} botId Bot ID
@@ -4927,6 +5712,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4927
5712
  listUsers: (nextToken?: string, conversationId?: string, tags?: {
4928
5713
  [key: string]: string;
4929
5714
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5715
+ /**
5716
+ * List invoices billed to workspace
5717
+ * @param {string} id Workspace ID
5718
+ * @param {*} [options] Override http request option.
5719
+ * @throws {RequiredError}
5720
+ */
5721
+ listWorkspaceInvoices: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4930
5722
  /**
4931
5723
  * Lists all the members in a workspace
4932
5724
  * @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 +5770,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4978
5770
  * @throws {RequiredError}
4979
5771
  */
4980
5772
  setState: (type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5773
+ /**
5774
+ * 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.
5775
+ * @param {string} id Workspace ID
5776
+ * @param {SetWorkspacePaymentMethodBody} [setWorkspacePaymentMethodBody]
5777
+ * @param {*} [options] Override http request option.
5778
+ * @throws {RequiredError}
5779
+ */
5780
+ setWorkspacePaymentMethod: (id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4981
5781
  /**
4982
5782
  * 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
5783
  * @param {string} id Bot ID
@@ -5063,6 +5863,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5063
5863
  * @throws {RequiredError}
5064
5864
  */
5065
5865
  changeWorkspacePlan(id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeWorkspacePlanResponse>>;
5866
+ /**
5867
+ * Charge unpaid invoices of a workspace.
5868
+ * @param {string} id Workspace ID
5869
+ * @param {ChargeWorkspaceUnpaidInvoicesBody} [chargeWorkspaceUnpaidInvoicesBody]
5870
+ * @param {*} [options] Override http request option.
5871
+ * @throws {RequiredError}
5872
+ */
5873
+ chargeWorkspaceUnpaidInvoices(id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>>;
5066
5874
  /**
5067
5875
  * An integration can call this endpoint to configure itself
5068
5876
  * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
@@ -5387,6 +6195,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5387
6195
  * @throws {RequiredError}
5388
6196
  */
5389
6197
  getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
6198
+ /**
6199
+ * Get billing details of workspace
6200
+ * @param {string} id Workspace ID
6201
+ * @param {*} [options] Override http request option.
6202
+ * @throws {RequiredError}
6203
+ */
6204
+ getWorkspaceBillingDetails(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceBillingDetailsResponse>>;
5390
6205
  /**
5391
6206
  * Get workspace quota
5392
6207
  * @param {string} id Workspace ID
@@ -5441,10 +6256,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5441
6256
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
5442
6257
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
5443
6258
  * @param {string} [type] Filter by event type
6259
+ * @param {string} [conversationId] Filter by conversation id
6260
+ * @param {string} [userId] Filter by user id
6261
+ * @param {string} [messageId] Filter by message id
5444
6262
  * @param {*} [options] Override http request option.
5445
6263
  * @throws {RequiredError}
5446
6264
  */
5447
- listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
6265
+ listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
5448
6266
  /**
5449
6267
  * List Files
5450
6268
  * @param {string} botId Bot ID
@@ -5507,6 +6325,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5507
6325
  listUsers(nextToken?: string, conversationId?: string, tags?: {
5508
6326
  [key: string]: string;
5509
6327
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
6328
+ /**
6329
+ * List invoices billed to workspace
6330
+ * @param {string} id Workspace ID
6331
+ * @param {*} [options] Override http request option.
6332
+ * @throws {RequiredError}
6333
+ */
6334
+ listWorkspaceInvoices(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceInvoicesResponse>>;
5510
6335
  /**
5511
6336
  * Lists all the members in a workspace
5512
6337
  * @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 +6383,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
5558
6383
  * @throws {RequiredError}
5559
6384
  */
5560
6385
  setState(type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
6386
+ /**
6387
+ * 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.
6388
+ * @param {string} id Workspace ID
6389
+ * @param {SetWorkspacePaymentMethodBody} [setWorkspacePaymentMethodBody]
6390
+ * @param {*} [options] Override http request option.
6391
+ * @throws {RequiredError}
6392
+ */
6393
+ setWorkspacePaymentMethod(id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetWorkspacePaymentMethodResponse>>;
5561
6394
  /**
5562
6395
  * 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
6396
  * @param {string} id Bot ID
@@ -5642,6 +6475,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5642
6475
  * @throws {RequiredError}
5643
6476
  */
5644
6477
  changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeWorkspacePlanResponse>;
6478
+ /**
6479
+ * Charge unpaid invoices of a workspace.
6480
+ * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
6481
+ * @param {*} [options] Override http request option.
6482
+ * @throws {RequiredError}
6483
+ */
6484
+ chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>;
5645
6485
  /**
5646
6486
  * An integration can call this endpoint to configure itself
5647
6487
  * @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
@@ -5949,6 +6789,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5949
6789
  * @throws {RequiredError}
5950
6790
  */
5951
6791
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
6792
+ /**
6793
+ * Get billing details of workspace
6794
+ * @param {DefaultApiGetWorkspaceBillingDetailsRequest} requestParameters Request parameters.
6795
+ * @param {*} [options] Override http request option.
6796
+ * @throws {RequiredError}
6797
+ */
6798
+ getWorkspaceBillingDetails(requestParameters: DefaultApiGetWorkspaceBillingDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceBillingDetailsResponse>;
5952
6799
  /**
5953
6800
  * Get workspace quota
5954
6801
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -6046,6 +6893,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
6046
6893
  * @throws {RequiredError}
6047
6894
  */
6048
6895
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
6896
+ /**
6897
+ * List invoices billed to workspace
6898
+ * @param {DefaultApiListWorkspaceInvoicesRequest} requestParameters Request parameters.
6899
+ * @param {*} [options] Override http request option.
6900
+ * @throws {RequiredError}
6901
+ */
6902
+ listWorkspaceInvoices(requestParameters: DefaultApiListWorkspaceInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceInvoicesResponse>;
6049
6903
  /**
6050
6904
  * Lists all the members in a workspace
6051
6905
  * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
@@ -6088,6 +6942,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
6088
6942
  * @throws {RequiredError}
6089
6943
  */
6090
6944
  setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
6945
+ /**
6946
+ * 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.
6947
+ * @param {DefaultApiSetWorkspacePaymentMethodRequest} requestParameters Request parameters.
6948
+ * @param {*} [options] Override http request option.
6949
+ * @throws {RequiredError}
6950
+ */
6951
+ setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): AxiosPromise<SetWorkspacePaymentMethodResponse>;
6091
6952
  /**
6092
6953
  * 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
6954
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -6177,6 +7038,25 @@ export interface DefaultApiChangeWorkspacePlanRequest {
6177
7038
  */
6178
7039
  readonly changeWorkspacePlanBody?: ChangeWorkspacePlanBody;
6179
7040
  }
7041
+ /**
7042
+ * Request parameters for chargeWorkspaceUnpaidInvoices operation in DefaultApi.
7043
+ * @export
7044
+ * @interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest
7045
+ */
7046
+ export interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest {
7047
+ /**
7048
+ * Workspace ID
7049
+ * @type {string}
7050
+ * @memberof DefaultApiChargeWorkspaceUnpaidInvoices
7051
+ */
7052
+ readonly id: string;
7053
+ /**
7054
+ *
7055
+ * @type {ChargeWorkspaceUnpaidInvoicesBody}
7056
+ * @memberof DefaultApiChargeWorkspaceUnpaidInvoices
7057
+ */
7058
+ readonly chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody;
7059
+ }
6180
7060
  /**
6181
7061
  * Request parameters for configureIntegration operation in DefaultApi.
6182
7062
  * @export
@@ -6795,7 +7675,7 @@ export interface DefaultApiGetStateRequest {
6795
7675
  export interface DefaultApiGetUsageRequest {
6796
7676
  /**
6797
7677
  * 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'}
7678
+ * @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
7679
  * @memberof DefaultApiGetUsage
6800
7680
  */
6801
7681
  readonly type: GetUsageTypeEnum;
@@ -6838,6 +7718,19 @@ export interface DefaultApiGetWorkspaceRequest {
6838
7718
  */
6839
7719
  readonly id: string;
6840
7720
  }
7721
+ /**
7722
+ * Request parameters for getWorkspaceBillingDetails operation in DefaultApi.
7723
+ * @export
7724
+ * @interface DefaultApiGetWorkspaceBillingDetailsRequest
7725
+ */
7726
+ export interface DefaultApiGetWorkspaceBillingDetailsRequest {
7727
+ /**
7728
+ * Workspace ID
7729
+ * @type {string}
7730
+ * @memberof DefaultApiGetWorkspaceBillingDetails
7731
+ */
7732
+ readonly id: string;
7733
+ }
6841
7734
  /**
6842
7735
  * Request parameters for getWorkspaceQuota operation in DefaultApi.
6843
7736
  * @export
@@ -6852,7 +7745,7 @@ export interface DefaultApiGetWorkspaceQuotaRequest {
6852
7745
  readonly id: string;
6853
7746
  /**
6854
7747
  * 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'}
7748
+ * @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
7749
  * @memberof DefaultApiGetWorkspaceQuota
6857
7750
  */
6858
7751
  readonly type: GetWorkspaceQuotaTypeEnum;
@@ -6972,6 +7865,24 @@ export interface DefaultApiListEventsRequest {
6972
7865
  * @memberof DefaultApiListEvents
6973
7866
  */
6974
7867
  readonly type?: string;
7868
+ /**
7869
+ * Filter by conversation id
7870
+ * @type {string}
7871
+ * @memberof DefaultApiListEvents
7872
+ */
7873
+ readonly conversationId?: string;
7874
+ /**
7875
+ * Filter by user id
7876
+ * @type {string}
7877
+ * @memberof DefaultApiListEvents
7878
+ */
7879
+ readonly userId?: string;
7880
+ /**
7881
+ * Filter by message id
7882
+ * @type {string}
7883
+ * @memberof DefaultApiListEvents
7884
+ */
7885
+ readonly messageId?: string;
6975
7886
  }
6976
7887
  /**
6977
7888
  * Request parameters for listFiles operation in DefaultApi.
@@ -7077,7 +7988,7 @@ export interface DefaultApiListPublicIntegrationsRequest {
7077
7988
  export interface DefaultApiListUsageHistoryRequest {
7078
7989
  /**
7079
7990
  * 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'}
7991
+ * @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
7992
  * @memberof DefaultApiListUsageHistory
7082
7993
  */
7083
7994
  readonly type: ListUsageHistoryTypeEnum;
@@ -7115,6 +8026,19 @@ export interface DefaultApiListUsersRequest {
7115
8026
  [key: string]: string;
7116
8027
  };
7117
8028
  }
8029
+ /**
8030
+ * Request parameters for listWorkspaceInvoices operation in DefaultApi.
8031
+ * @export
8032
+ * @interface DefaultApiListWorkspaceInvoicesRequest
8033
+ */
8034
+ export interface DefaultApiListWorkspaceInvoicesRequest {
8035
+ /**
8036
+ * Workspace ID
8037
+ * @type {string}
8038
+ * @memberof DefaultApiListWorkspaceInvoices
8039
+ */
8040
+ readonly id: string;
8041
+ }
7118
8042
  /**
7119
8043
  * Request parameters for listWorkspaceMembers operation in DefaultApi.
7120
8044
  * @export
@@ -7161,7 +8085,7 @@ export interface DefaultApiListWorkspaceUsagesRequest {
7161
8085
  readonly id: string;
7162
8086
  /**
7163
8087
  * 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'}
8088
+ * @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
8089
  * @memberof DefaultApiListWorkspaceUsages
7166
8090
  */
7167
8091
  readonly type: ListWorkspaceUsagesTypeEnum;
@@ -7247,6 +8171,25 @@ export interface DefaultApiSetStateRequest {
7247
8171
  */
7248
8172
  readonly setStateBody?: SetStateBody;
7249
8173
  }
8174
+ /**
8175
+ * Request parameters for setWorkspacePaymentMethod operation in DefaultApi.
8176
+ * @export
8177
+ * @interface DefaultApiSetWorkspacePaymentMethodRequest
8178
+ */
8179
+ export interface DefaultApiSetWorkspacePaymentMethodRequest {
8180
+ /**
8181
+ * Workspace ID
8182
+ * @type {string}
8183
+ * @memberof DefaultApiSetWorkspacePaymentMethod
8184
+ */
8185
+ readonly id: string;
8186
+ /**
8187
+ *
8188
+ * @type {SetWorkspacePaymentMethodBody}
8189
+ * @memberof DefaultApiSetWorkspacePaymentMethod
8190
+ */
8191
+ readonly setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody;
8192
+ }
7250
8193
  /**
7251
8194
  * Request parameters for transferBot operation in DefaultApi.
7252
8195
  * @export
@@ -7422,6 +8365,14 @@ export declare class DefaultApi extends BaseAPI {
7422
8365
  * @memberof DefaultApi
7423
8366
  */
7424
8367
  changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeWorkspacePlanResponse, any>>;
8368
+ /**
8369
+ * Charge unpaid invoices of a workspace.
8370
+ * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
8371
+ * @param {*} [options] Override http request option.
8372
+ * @throws {RequiredError}
8373
+ * @memberof DefaultApi
8374
+ */
8375
+ chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChargeWorkspaceUnpaidInvoicesResponse, any>>;
7425
8376
  /**
7426
8377
  * An integration can call this endpoint to configure itself
7427
8378
  * @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
@@ -7773,6 +8724,14 @@ export declare class DefaultApi extends BaseAPI {
7773
8724
  * @memberof DefaultApi
7774
8725
  */
7775
8726
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
8727
+ /**
8728
+ * Get billing details of workspace
8729
+ * @param {DefaultApiGetWorkspaceBillingDetailsRequest} requestParameters Request parameters.
8730
+ * @param {*} [options] Override http request option.
8731
+ * @throws {RequiredError}
8732
+ * @memberof DefaultApi
8733
+ */
8734
+ getWorkspaceBillingDetails(requestParameters: DefaultApiGetWorkspaceBillingDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceBillingDetailsResponse, any>>;
7776
8735
  /**
7777
8736
  * Get workspace quota
7778
8737
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -7884,6 +8843,14 @@ export declare class DefaultApi extends BaseAPI {
7884
8843
  * @memberof DefaultApi
7885
8844
  */
7886
8845
  listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsersResponse, any>>;
8846
+ /**
8847
+ * List invoices billed to workspace
8848
+ * @param {DefaultApiListWorkspaceInvoicesRequest} requestParameters Request parameters.
8849
+ * @param {*} [options] Override http request option.
8850
+ * @throws {RequiredError}
8851
+ * @memberof DefaultApi
8852
+ */
8853
+ listWorkspaceInvoices(requestParameters: DefaultApiListWorkspaceInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceInvoicesResponse, any>>;
7887
8854
  /**
7888
8855
  * Lists all the members in a workspace
7889
8856
  * @param {DefaultApiListWorkspaceMembersRequest} requestParameters Request parameters.
@@ -7932,6 +8899,14 @@ export declare class DefaultApi extends BaseAPI {
7932
8899
  * @memberof DefaultApi
7933
8900
  */
7934
8901
  setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetStateResponse, any>>;
8902
+ /**
8903
+ * 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.
8904
+ * @param {DefaultApiSetWorkspacePaymentMethodRequest} requestParameters Request parameters.
8905
+ * @param {*} [options] Override http request option.
8906
+ * @throws {RequiredError}
8907
+ * @memberof DefaultApi
8908
+ */
8909
+ setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetWorkspacePaymentMethodResponse, any>>;
7935
8910
  /**
7936
8911
  * 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
8912
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -8030,6 +9005,8 @@ export declare const GetUsageTypeEnum: {
8030
9005
  readonly TableRowCount: "table_row_count";
8031
9006
  readonly WorkspaceMemberCount: "workspace_member_count";
8032
9007
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9008
+ readonly CognitiveCalls: "cognitive_calls";
9009
+ readonly ModelCredit: "model_credit";
8033
9010
  };
8034
9011
  export type GetUsageTypeEnum = typeof GetUsageTypeEnum[keyof typeof GetUsageTypeEnum];
8035
9012
  /**
@@ -8045,6 +9022,8 @@ export declare const GetWorkspaceQuotaTypeEnum: {
8045
9022
  readonly TableRowCount: "table_row_count";
8046
9023
  readonly WorkspaceMemberCount: "workspace_member_count";
8047
9024
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9025
+ readonly CognitiveCalls: "cognitive_calls";
9026
+ readonly ModelCredit: "model_credit";
8048
9027
  };
8049
9028
  export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
8050
9029
  /**
@@ -8060,6 +9039,8 @@ export declare const ListUsageHistoryTypeEnum: {
8060
9039
  readonly TableRowCount: "table_row_count";
8061
9040
  readonly WorkspaceMemberCount: "workspace_member_count";
8062
9041
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9042
+ readonly CognitiveCalls: "cognitive_calls";
9043
+ readonly ModelCredit: "model_credit";
8063
9044
  };
8064
9045
  export type ListUsageHistoryTypeEnum = typeof ListUsageHistoryTypeEnum[keyof typeof ListUsageHistoryTypeEnum];
8065
9046
  /**
@@ -8075,6 +9056,8 @@ export declare const ListWorkspaceUsagesTypeEnum: {
8075
9056
  readonly TableRowCount: "table_row_count";
8076
9057
  readonly WorkspaceMemberCount: "workspace_member_count";
8077
9058
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9059
+ readonly CognitiveCalls: "cognitive_calls";
9060
+ readonly ModelCredit: "model_credit";
8078
9061
  };
8079
9062
  export type ListWorkspaceUsagesTypeEnum = typeof ListWorkspaceUsagesTypeEnum[keyof typeof ListWorkspaceUsagesTypeEnum];
8080
9063
  /**