@botpress/client 0.7.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/gen/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.13.0
5
+ * The version of the OpenAPI document: 0.14.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -71,7 +71,7 @@ export interface AddParticipantResponse {
71
71
  */
72
72
  export interface Bot {
73
73
  /**
74
- * Id of the [Bot](#schema_bot)
74
+ * ID of the [Conversation](#schema_conversation)
75
75
  * @type {string}
76
76
  * @memberof Bot
77
77
  */
@@ -144,11 +144,11 @@ export interface Bot {
144
144
  };
145
145
  /**
146
146
  * Recurring events
147
- * @type {{ [key: string]: CreateBotBodyRecurringEventsValue; }}
147
+ * @type {{ [key: string]: BotRecurringEventsValue; }}
148
148
  * @memberof Bot
149
149
  */
150
150
  'recurringEvents': {
151
- [key: string]: CreateBotBodyRecurringEventsValue;
151
+ [key: string]: BotRecurringEventsValue;
152
152
  };
153
153
  /**
154
154
  * Name of the [Bot](#schema_bot)
@@ -232,31 +232,31 @@ export interface BotIntegrationsValue {
232
232
  */
233
233
  'enabled': boolean;
234
234
  /**
235
- * Name of the [Integration](#schema_integration)
235
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
236
236
  * @type {string}
237
237
  * @memberof BotIntegrationsValue
238
238
  */
239
239
  'name': string;
240
240
  /**
241
- * Version of the [Integration](#schema_integration)
241
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
242
242
  * @type {string}
243
243
  * @memberof BotIntegrationsValue
244
244
  */
245
245
  'version': string;
246
246
  /**
247
- *
247
+ * Signing secret of the [Bot](#schema_bot)
248
248
  * @type {string}
249
249
  * @memberof BotIntegrationsValue
250
250
  */
251
251
  'webhookUrl': string;
252
252
  /**
253
- *
253
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
254
254
  * @type {string}
255
255
  * @memberof BotIntegrationsValue
256
256
  */
257
257
  'webhookId': string;
258
258
  /**
259
- *
259
+ * Signing secret of the [Bot](#schema_bot)
260
260
  * @type {string}
261
261
  * @memberof BotIntegrationsValue
262
262
  */
@@ -276,13 +276,13 @@ export interface BotIntegrationsValue {
276
276
  */
277
277
  'status': BotIntegrationsValueStatusEnum;
278
278
  /**
279
- *
279
+ * Signing secret of the [Bot](#schema_bot)
280
280
  * @type {string}
281
281
  * @memberof BotIntegrationsValue
282
282
  */
283
283
  'statusReason': string | null;
284
284
  /**
285
- * ID of the [Integration](#schema_integration)
285
+ * ID of the [Conversation](#schema_conversation)
286
286
  * @type {string}
287
287
  * @memberof BotIntegrationsValue
288
288
  */
@@ -361,6 +361,46 @@ export interface BotMessage {
361
361
  [key: string]: CreateBotBodyUserTagsValue;
362
362
  };
363
363
  }
364
+ /**
365
+ *
366
+ * @export
367
+ * @interface BotRecurringEventsValue
368
+ */
369
+ export interface BotRecurringEventsValue {
370
+ /**
371
+ *
372
+ * @type {BotRecurringEventsValueSchedule}
373
+ * @memberof BotRecurringEventsValue
374
+ */
375
+ 'schedule': BotRecurringEventsValueSchedule;
376
+ /**
377
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
378
+ * @type {string}
379
+ * @memberof BotRecurringEventsValue
380
+ */
381
+ 'type': string;
382
+ /**
383
+ *
384
+ * @type {{ [key: string]: any; }}
385
+ * @memberof BotRecurringEventsValue
386
+ */
387
+ 'payload': {
388
+ [key: string]: any;
389
+ };
390
+ }
391
+ /**
392
+ *
393
+ * @export
394
+ * @interface BotRecurringEventsValueSchedule
395
+ */
396
+ export interface BotRecurringEventsValueSchedule {
397
+ /**
398
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
399
+ * @type {string}
400
+ * @memberof BotRecurringEventsValueSchedule
401
+ */
402
+ 'cron': string;
403
+ }
364
404
  /**
365
405
  * User object configuration
366
406
  * @export
@@ -383,7 +423,7 @@ export interface BotUser {
383
423
  */
384
424
  export interface CallActionBody {
385
425
  /**
386
- * Type of the action
426
+ * Unique identifier of the integration that was installed on the bot
387
427
  * @type {string}
388
428
  * @memberof CallActionBody
389
429
  */
@@ -604,7 +644,7 @@ export interface ConfigureIntegrationBody {
604
644
  */
605
645
  export interface Conversation {
606
646
  /**
607
- * Id of the [Conversation](#schema_conversation)
647
+ * ID of the [Conversation](#schema_conversation)
608
648
  * @type {string}
609
649
  * @memberof Conversation
610
650
  */
@@ -809,7 +849,7 @@ export interface CreateBotBodyRecurringEventsValue {
809
849
  */
810
850
  'schedule': CreateBotBodyRecurringEventsValueSchedule;
811
851
  /**
812
- *
852
+ * Unique identifier of the integration that was installed on the bot
813
853
  * @type {string}
814
854
  * @memberof CreateBotBodyRecurringEventsValue
815
855
  */
@@ -830,7 +870,7 @@ export interface CreateBotBodyRecurringEventsValue {
830
870
  */
831
871
  export interface CreateBotBodyRecurringEventsValueSchedule {
832
872
  /**
833
- *
873
+ * Unique identifier of the integration that was installed on the bot
834
874
  * @type {string}
835
875
  * @memberof CreateBotBodyRecurringEventsValueSchedule
836
876
  */
@@ -923,7 +963,7 @@ export interface CreateBotResponse {
923
963
  */
924
964
  export interface CreateConversationBody {
925
965
  /**
926
- * Channel name
966
+ * Unique identifier of the integration that was installed on the bot
927
967
  * @type {string}
928
968
  * @memberof CreateConversationBody
929
969
  */
@@ -937,7 +977,7 @@ export interface CreateConversationBody {
937
977
  [key: string]: string;
938
978
  };
939
979
  /**
940
- * Name of the integration to which the conversation creation will be delegated
980
+ * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
941
981
  * @type {string}
942
982
  * @memberof CreateConversationBody
943
983
  */
@@ -963,7 +1003,7 @@ export interface CreateConversationResponse {
963
1003
  */
964
1004
  export interface CreateEventBody {
965
1005
  /**
966
- * Type of the [Event](#schema_event).
1006
+ * Unique identifier of the integration that was installed on the bot
967
1007
  * @type {string}
968
1008
  * @memberof CreateEventBody
969
1009
  */
@@ -1089,13 +1129,13 @@ export interface CreateFileResponse {
1089
1129
  */
1090
1130
  export interface CreateIntegrationBody {
1091
1131
  /**
1092
- * Name of the [Integration](#schema_integration)
1132
+ * Unique identifier of the integration that was installed on the bot
1093
1133
  * @type {string}
1094
1134
  * @memberof CreateIntegrationBody
1095
1135
  */
1096
1136
  'name': string;
1097
1137
  /**
1098
- * Version of the [Integration](#schema_integration)
1138
+ * Unique identifier of the integration that was installed on the bot
1099
1139
  * @type {string}
1100
1140
  * @memberof CreateIntegrationBody
1101
1141
  */
@@ -1367,7 +1407,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1367
1407
  */
1368
1408
  'required'?: boolean;
1369
1409
  /**
1370
- *
1410
+ * Signing secret of the [Bot](#schema_bot)
1371
1411
  * @type {string}
1372
1412
  * @memberof CreateIntegrationBodyConfigurationIdentifier
1373
1413
  */
@@ -1380,13 +1420,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1380
1420
  */
1381
1421
  export interface CreateIntegrationBodyIdentifier {
1382
1422
  /**
1383
- *
1423
+ * Signing secret of the [Bot](#schema_bot)
1384
1424
  * @type {string}
1385
1425
  * @memberof CreateIntegrationBodyIdentifier
1386
1426
  */
1387
1427
  'fallbackHandlerScript'?: string;
1388
1428
  /**
1389
- *
1429
+ * Signing secret of the [Bot](#schema_bot)
1390
1430
  * @type {string}
1391
1431
  * @memberof CreateIntegrationBodyIdentifier
1392
1432
  */
@@ -1487,19 +1527,19 @@ export interface CreateMessageBody {
1487
1527
  [key: string]: any;
1488
1528
  };
1489
1529
  /**
1490
- * ID of the [User](#schema_user)
1530
+ * User id
1491
1531
  * @type {string}
1492
1532
  * @memberof CreateMessageBody
1493
1533
  */
1494
1534
  'userId': string;
1495
1535
  /**
1496
- * ID of the [Conversation](#schema_conversation)
1536
+ * User id
1497
1537
  * @type {string}
1498
1538
  * @memberof CreateMessageBody
1499
1539
  */
1500
1540
  'conversationId': string;
1501
1541
  /**
1502
- * Type of the [Message](#schema_message) represents the resource type that the message is related to
1542
+ * Unique identifier of the integration that was installed on the bot
1503
1543
  * @type {string}
1504
1544
  * @memberof CreateMessageBody
1505
1545
  */
@@ -1526,7 +1566,7 @@ export interface CreateMessageBody {
1526
1566
  */
1527
1567
  export interface CreateMessageBodySchedule {
1528
1568
  /**
1529
- * When the [Message](#schema_message) will be sent, in the ISO 8601 format
1569
+ * When the [Event](#schema_event) will be sent, in the ISO 8601 format
1530
1570
  * @type {string}
1531
1571
  * @memberof CreateMessageBodySchedule
1532
1572
  */
@@ -1623,7 +1663,7 @@ export interface CreateUserBody {
1623
1663
  [key: string]: string;
1624
1664
  };
1625
1665
  /**
1626
- * Name of the integration to which the user creation will be delegated
1666
+ * [DEPRECATED] To create a user from within a bot, call an action of the integration instead.
1627
1667
  * @type {string}
1628
1668
  * @memberof CreateUserBody
1629
1669
  */
@@ -1635,7 +1675,7 @@ export interface CreateUserBody {
1635
1675
  */
1636
1676
  'name'?: string;
1637
1677
  /**
1638
- * URL of the user picture
1678
+ * URI of the user picture
1639
1679
  * @type {string}
1640
1680
  * @memberof CreateUserBody
1641
1681
  */
@@ -1820,7 +1860,7 @@ export type CreateWorkspaceResponsePlanEnum = typeof CreateWorkspaceResponsePlan
1820
1860
  */
1821
1861
  export interface Event {
1822
1862
  /**
1823
- * Id of the [Event](#schema_event)
1863
+ * ID of the [Conversation](#schema_conversation)
1824
1864
  * @type {string}
1825
1865
  * @memberof Event
1826
1866
  */
@@ -1832,7 +1872,7 @@ export interface Event {
1832
1872
  */
1833
1873
  'createdAt': string;
1834
1874
  /**
1835
- * Type of the [Event](#schema_event).
1875
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
1836
1876
  * @type {string}
1837
1877
  * @memberof Event
1838
1878
  */
@@ -2248,7 +2288,7 @@ export interface GetMessageResponse {
2248
2288
  */
2249
2289
  export interface GetOrCreateConversationBody {
2250
2290
  /**
2251
- * Channel name
2291
+ * Unique identifier of the integration that was installed on the bot
2252
2292
  * @type {string}
2253
2293
  * @memberof GetOrCreateConversationBody
2254
2294
  */
@@ -2262,7 +2302,7 @@ export interface GetOrCreateConversationBody {
2262
2302
  [key: string]: string;
2263
2303
  };
2264
2304
  /**
2265
- * Name of the integration to which the conversation creation will be delegated
2305
+ * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
2266
2306
  * @type {string}
2267
2307
  * @memberof GetOrCreateConversationBody
2268
2308
  */
@@ -2296,19 +2336,19 @@ export interface GetOrCreateMessageBody {
2296
2336
  [key: string]: any;
2297
2337
  };
2298
2338
  /**
2299
- * ID of the [User](#schema_user)
2339
+ * User id
2300
2340
  * @type {string}
2301
2341
  * @memberof GetOrCreateMessageBody
2302
2342
  */
2303
2343
  'userId': string;
2304
2344
  /**
2305
- * ID of the [Conversation](#schema_conversation)
2345
+ * User id
2306
2346
  * @type {string}
2307
2347
  * @memberof GetOrCreateMessageBody
2308
2348
  */
2309
2349
  'conversationId': string;
2310
2350
  /**
2311
- * Type of the [Message](#schema_message) represents the resource type that the message is related to
2351
+ * Unique identifier of the integration that was installed on the bot
2312
2352
  * @type {string}
2313
2353
  * @memberof GetOrCreateMessageBody
2314
2354
  */
@@ -2356,7 +2396,7 @@ export interface GetOrCreateUserBody {
2356
2396
  [key: string]: string;
2357
2397
  };
2358
2398
  /**
2359
- * Name of the integration to which the user creation will be delegated
2399
+ * [DEPRECATED] To create a user from within a bot, call an action of the integration instead.
2360
2400
  * @type {string}
2361
2401
  * @memberof GetOrCreateUserBody
2362
2402
  */
@@ -2368,7 +2408,7 @@ export interface GetOrCreateUserBody {
2368
2408
  */
2369
2409
  'name'?: string;
2370
2410
  /**
2371
- * URL of the user picture
2411
+ * URI of the user picture
2372
2412
  * @type {string}
2373
2413
  * @memberof GetOrCreateUserBody
2374
2414
  */
@@ -2627,13 +2667,14 @@ export declare const GetWorkspaceQuotaResponseQuotaTypeEnum: {
2627
2667
  readonly InvocationCalls: "invocation_calls";
2628
2668
  readonly StorageCount: "storage_count";
2629
2669
  readonly BotCount: "bot_count";
2630
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
2631
- readonly BotRatelimit: "bot_ratelimit";
2670
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
2671
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
2632
2672
  readonly TableRowCount: "table_row_count";
2633
2673
  readonly WorkspaceMemberCount: "workspace_member_count";
2634
2674
  readonly IntegrationsOwnedCount: "integrations_owned_count";
2635
- readonly CognitiveCalls: "cognitive_calls";
2636
- readonly ModelCredit: "model_credit";
2675
+ readonly AiSpend: "ai_spend";
2676
+ readonly OpenaiSpend: "openai_spend";
2677
+ readonly BingSearchSpend: "bing_search_spend";
2637
2678
  };
2638
2679
  export type GetWorkspaceQuotaResponseQuotaTypeEnum = typeof GetWorkspaceQuotaResponseQuotaTypeEnum[keyof typeof GetWorkspaceQuotaResponseQuotaTypeEnum];
2639
2680
  /**
@@ -2721,7 +2762,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
2721
2762
  */
2722
2763
  export interface Integration {
2723
2764
  /**
2724
- * ID of the [Integration](#schema_integration)
2765
+ * ID of the [Conversation](#schema_conversation)
2725
2766
  * @type {string}
2726
2767
  * @memberof Integration
2727
2768
  */
@@ -2745,13 +2786,13 @@ export interface Integration {
2745
2786
  */
2746
2787
  'identifier': IntegrationIdentifier;
2747
2788
  /**
2748
- * Name of the [Integration](#schema_integration)
2789
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
2749
2790
  * @type {string}
2750
2791
  * @memberof Integration
2751
2792
  */
2752
2793
  'name': string;
2753
2794
  /**
2754
- * Version of the [Integration](#schema_integration)
2795
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
2755
2796
  * @type {string}
2756
2797
  * @memberof Integration
2757
2798
  */
@@ -2919,7 +2960,7 @@ export interface IntegrationConfiguration {
2919
2960
  */
2920
2961
  export interface IntegrationConfigurationIdentifier {
2921
2962
  /**
2922
- *
2963
+ * Signing secret of the [Bot](#schema_bot)
2923
2964
  * @type {string}
2924
2965
  * @memberof IntegrationConfigurationIdentifier
2925
2966
  */
@@ -3311,7 +3352,7 @@ export interface ListBotsResponse {
3311
3352
  */
3312
3353
  export interface ListBotsResponseBotsInner {
3313
3354
  /**
3314
- * Id of the [Bot](#schema_bot)
3355
+ * User id
3315
3356
  * @type {string}
3316
3357
  * @memberof ListBotsResponseBotsInner
3317
3358
  */
@@ -3532,19 +3573,19 @@ export interface ListPublicIntegrationsResponse {
3532
3573
  */
3533
3574
  export interface ListPublicIntegrationsResponseIntegrationsInner {
3534
3575
  /**
3535
- * ID of the [Integration](#schema_integration)
3576
+ * User id
3536
3577
  * @type {string}
3537
3578
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
3538
3579
  */
3539
3580
  'id': string;
3540
3581
  /**
3541
- * Name of the [Integration](#schema_integration)
3582
+ * Unique identifier of the integration that was installed on the bot
3542
3583
  * @type {string}
3543
3584
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
3544
3585
  */
3545
3586
  'name': string;
3546
3587
  /**
3547
- * Version of the [Integration](#schema_integration)
3588
+ * Unique identifier of the integration that was installed on the bot
3548
3589
  * @type {string}
3549
3590
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
3550
3591
  */
@@ -3812,13 +3853,14 @@ export declare const ListWorkspaceQuotasResponseQuotasInnerTypeEnum: {
3812
3853
  readonly InvocationCalls: "invocation_calls";
3813
3854
  readonly StorageCount: "storage_count";
3814
3855
  readonly BotCount: "bot_count";
3815
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
3816
- readonly BotRatelimit: "bot_ratelimit";
3856
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
3857
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
3817
3858
  readonly TableRowCount: "table_row_count";
3818
3859
  readonly WorkspaceMemberCount: "workspace_member_count";
3819
3860
  readonly IntegrationsOwnedCount: "integrations_owned_count";
3820
- readonly CognitiveCalls: "cognitive_calls";
3821
- readonly ModelCredit: "model_credit";
3861
+ readonly AiSpend: "ai_spend";
3862
+ readonly OpenaiSpend: "openai_spend";
3863
+ readonly BingSearchSpend: "bing_search_spend";
3822
3864
  };
3823
3865
  export type ListWorkspaceQuotasResponseQuotasInnerTypeEnum = typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum[keyof typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum];
3824
3866
  /**
@@ -3860,7 +3902,7 @@ export interface ListWorkspacesResponse {
3860
3902
  */
3861
3903
  export interface Message {
3862
3904
  /**
3863
- * Id of the [Message](#schema_message)
3905
+ * ID of the [Conversation](#schema_conversation)
3864
3906
  * @type {string}
3865
3907
  * @memberof Message
3866
3908
  */
@@ -3892,7 +3934,7 @@ export interface Message {
3892
3934
  */
3893
3935
  'direction': MessageDirectionEnum;
3894
3936
  /**
3895
- * ID of the [User](#schema_user)
3937
+ * ID of the [Conversation](#schema_conversation)
3896
3938
  * @type {string}
3897
3939
  * @memberof Message
3898
3940
  */
@@ -4106,7 +4148,7 @@ export interface SetWorkspacePaymentMethodResponseNextAction {
4106
4148
  */
4107
4149
  export interface State {
4108
4150
  /**
4109
- * Id of the [State](#schema_state)
4151
+ * ID of the [Conversation](#schema_conversation)
4110
4152
  * @type {string}
4111
4153
  * @memberof State
4112
4154
  */
@@ -4124,7 +4166,7 @@ export interface State {
4124
4166
  */
4125
4167
  'updatedAt': string;
4126
4168
  /**
4127
- * Id of the [Bot](#schema_bot)
4169
+ * ID of the [Conversation](#schema_conversation)
4128
4170
  * @type {string}
4129
4171
  * @memberof State
4130
4172
  */
@@ -4142,7 +4184,7 @@ export interface State {
4142
4184
  */
4143
4185
  'userId'?: string;
4144
4186
  /**
4145
- * Name of the [State](#schema_state) which is declared inside the bot definition
4187
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
4146
4188
  * @type {string}
4147
4189
  * @memberof State
4148
4190
  */
@@ -4346,7 +4388,7 @@ export interface UpdateBotBodyRecurringEventsValue {
4346
4388
  */
4347
4389
  'schedule': CreateBotBodyRecurringEventsValueSchedule;
4348
4390
  /**
4349
- *
4391
+ * Unique identifier of the integration that was installed on the bot
4350
4392
  * @type {string}
4351
4393
  * @memberof UpdateBotBodyRecurringEventsValue
4352
4394
  */
@@ -4695,7 +4737,7 @@ export interface UpdateIntegrationBodyConfiguration {
4695
4737
  */
4696
4738
  export interface UpdateIntegrationBodyConfigurationIdentifier {
4697
4739
  /**
4698
- *
4740
+ * Signing secret of the [Bot](#schema_bot)
4699
4741
  * @type {string}
4700
4742
  * @memberof UpdateIntegrationBodyConfigurationIdentifier
4701
4743
  */
@@ -4714,13 +4756,13 @@ export interface UpdateIntegrationBodyConfigurationIdentifier {
4714
4756
  */
4715
4757
  export interface UpdateIntegrationBodyIdentifier {
4716
4758
  /**
4717
- *
4759
+ * Signing secret of the [Bot](#schema_bot)
4718
4760
  * @type {string}
4719
4761
  * @memberof UpdateIntegrationBodyIdentifier
4720
4762
  */
4721
4763
  'extractScript'?: string | null;
4722
4764
  /**
4723
- *
4765
+ * Signing secret of the [Bot](#schema_bot)
4724
4766
  * @type {string}
4725
4767
  * @memberof UpdateIntegrationBodyIdentifier
4726
4768
  */
@@ -4826,7 +4868,7 @@ export interface UpdateUserBody {
4826
4868
  * @type {{ [key: string]: string; }}
4827
4869
  * @memberof UpdateUserBody
4828
4870
  */
4829
- 'tags': {
4871
+ 'tags'?: {
4830
4872
  [key: string]: string;
4831
4873
  };
4832
4874
  /**
@@ -4834,9 +4876,9 @@ export interface UpdateUserBody {
4834
4876
  * @type {string}
4835
4877
  * @memberof UpdateUserBody
4836
4878
  */
4837
- 'name'?: string | null;
4879
+ 'name'?: string;
4838
4880
  /**
4839
- * URL of the user picture
4881
+ * URI of the user picture
4840
4882
  * @type {string}
4841
4883
  * @memberof UpdateUserBody
4842
4884
  */
@@ -5134,13 +5176,14 @@ export declare const UsageTypeEnum: {
5134
5176
  readonly InvocationCalls: "invocation_calls";
5135
5177
  readonly StorageCount: "storage_count";
5136
5178
  readonly BotCount: "bot_count";
5137
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
5138
- readonly BotRatelimit: "bot_ratelimit";
5179
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
5180
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
5139
5181
  readonly TableRowCount: "table_row_count";
5140
5182
  readonly WorkspaceMemberCount: "workspace_member_count";
5141
5183
  readonly IntegrationsOwnedCount: "integrations_owned_count";
5142
- readonly CognitiveCalls: "cognitive_calls";
5143
- readonly ModelCredit: "model_credit";
5184
+ readonly AiSpend: "ai_spend";
5185
+ readonly OpenaiSpend: "openai_spend";
5186
+ readonly BingSearchSpend: "bing_search_spend";
5144
5187
  };
5145
5188
  export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
5146
5189
  /**
@@ -5150,7 +5193,7 @@ export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
5150
5193
  */
5151
5194
  export interface User {
5152
5195
  /**
5153
- * Id of the [User](#schema_user)
5196
+ * ID of the [Conversation](#schema_conversation)
5154
5197
  * @type {string}
5155
5198
  * @memberof User
5156
5199
  */
@@ -7881,7 +7924,7 @@ export interface DefaultApiGetStateRequest {
7881
7924
  export interface DefaultApiGetUsageRequest {
7882
7925
  /**
7883
7926
  * Type of usage
7884
- * @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'}
7927
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
7885
7928
  * @memberof DefaultApiGetUsage
7886
7929
  */
7887
7930
  readonly type: GetUsageTypeEnum;
@@ -7951,7 +7994,7 @@ export interface DefaultApiGetWorkspaceQuotaRequest {
7951
7994
  readonly id: string;
7952
7995
  /**
7953
7996
  * Type of usage
7954
- * @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'}
7997
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
7955
7998
  * @memberof DefaultApiGetWorkspaceQuota
7956
7999
  */
7957
8000
  readonly type: GetWorkspaceQuotaTypeEnum;
@@ -8213,7 +8256,7 @@ export interface DefaultApiListPublicIntegrationsRequest {
8213
8256
  export interface DefaultApiListUsageHistoryRequest {
8214
8257
  /**
8215
8258
  * Type of usage
8216
- * @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'}
8259
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8217
8260
  * @memberof DefaultApiListUsageHistory
8218
8261
  */
8219
8262
  readonly type: ListUsageHistoryTypeEnum;
@@ -8310,7 +8353,7 @@ export interface DefaultApiListWorkspaceUsagesRequest {
8310
8353
  readonly id: string;
8311
8354
  /**
8312
8355
  * Type of usage
8313
- * @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'}
8356
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8314
8357
  * @memberof DefaultApiListWorkspaceUsages
8315
8358
  */
8316
8359
  readonly type: ListWorkspaceUsagesTypeEnum;
@@ -9276,13 +9319,14 @@ export declare const GetUsageTypeEnum: {
9276
9319
  readonly InvocationCalls: "invocation_calls";
9277
9320
  readonly StorageCount: "storage_count";
9278
9321
  readonly BotCount: "bot_count";
9279
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
9280
- readonly BotRatelimit: "bot_ratelimit";
9322
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
9323
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
9281
9324
  readonly TableRowCount: "table_row_count";
9282
9325
  readonly WorkspaceMemberCount: "workspace_member_count";
9283
9326
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9284
- readonly CognitiveCalls: "cognitive_calls";
9285
- readonly ModelCredit: "model_credit";
9327
+ readonly AiSpend: "ai_spend";
9328
+ readonly OpenaiSpend: "openai_spend";
9329
+ readonly BingSearchSpend: "bing_search_spend";
9286
9330
  };
9287
9331
  export type GetUsageTypeEnum = typeof GetUsageTypeEnum[keyof typeof GetUsageTypeEnum];
9288
9332
  /**
@@ -9293,13 +9337,14 @@ export declare const GetWorkspaceQuotaTypeEnum: {
9293
9337
  readonly InvocationCalls: "invocation_calls";
9294
9338
  readonly StorageCount: "storage_count";
9295
9339
  readonly BotCount: "bot_count";
9296
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
9297
- readonly BotRatelimit: "bot_ratelimit";
9340
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
9341
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
9298
9342
  readonly TableRowCount: "table_row_count";
9299
9343
  readonly WorkspaceMemberCount: "workspace_member_count";
9300
9344
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9301
- readonly CognitiveCalls: "cognitive_calls";
9302
- readonly ModelCredit: "model_credit";
9345
+ readonly AiSpend: "ai_spend";
9346
+ readonly OpenaiSpend: "openai_spend";
9347
+ readonly BingSearchSpend: "bing_search_spend";
9303
9348
  };
9304
9349
  export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
9305
9350
  /**
@@ -9310,13 +9355,14 @@ export declare const ListUsageHistoryTypeEnum: {
9310
9355
  readonly InvocationCalls: "invocation_calls";
9311
9356
  readonly StorageCount: "storage_count";
9312
9357
  readonly BotCount: "bot_count";
9313
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
9314
- readonly BotRatelimit: "bot_ratelimit";
9358
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
9359
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
9315
9360
  readonly TableRowCount: "table_row_count";
9316
9361
  readonly WorkspaceMemberCount: "workspace_member_count";
9317
9362
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9318
- readonly CognitiveCalls: "cognitive_calls";
9319
- readonly ModelCredit: "model_credit";
9363
+ readonly AiSpend: "ai_spend";
9364
+ readonly OpenaiSpend: "openai_spend";
9365
+ readonly BingSearchSpend: "bing_search_spend";
9320
9366
  };
9321
9367
  export type ListUsageHistoryTypeEnum = typeof ListUsageHistoryTypeEnum[keyof typeof ListUsageHistoryTypeEnum];
9322
9368
  /**
@@ -9327,13 +9373,14 @@ export declare const ListWorkspaceUsagesTypeEnum: {
9327
9373
  readonly InvocationCalls: "invocation_calls";
9328
9374
  readonly StorageCount: "storage_count";
9329
9375
  readonly BotCount: "bot_count";
9330
- readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
9331
- readonly BotRatelimit: "bot_ratelimit";
9376
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
9377
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
9332
9378
  readonly TableRowCount: "table_row_count";
9333
9379
  readonly WorkspaceMemberCount: "workspace_member_count";
9334
9380
  readonly IntegrationsOwnedCount: "integrations_owned_count";
9335
- readonly CognitiveCalls: "cognitive_calls";
9336
- readonly ModelCredit: "model_credit";
9381
+ readonly AiSpend: "ai_spend";
9382
+ readonly OpenaiSpend: "openai_spend";
9383
+ readonly BingSearchSpend: "bing_search_spend";
9337
9384
  };
9338
9385
  export type ListWorkspaceUsagesTypeEnum = typeof ListWorkspaceUsagesTypeEnum[keyof typeof ListWorkspaceUsagesTypeEnum];
9339
9386
  /**