@botpress/client 0.10.1 → 0.11.0

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.15.9
5
+ * The version of the OpenAPI document: 0.16.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,6 +150,12 @@ export interface Bot {
150
150
  'recurringEvents': {
151
151
  [key: string]: BotRecurringEventsValue;
152
152
  };
153
+ /**
154
+ *
155
+ * @type {CreateBotBodySubscriptions}
156
+ * @memberof Bot
157
+ */
158
+ 'subscriptions': CreateBotBodySubscriptions;
153
159
  /**
154
160
  * Name of the [Bot](#schema_bot)
155
161
  * @type {string}
@@ -404,6 +410,18 @@ export interface BotRecurringEventsValue {
404
410
  'payload': {
405
411
  [key: string]: any;
406
412
  };
413
+ /**
414
+ * The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
415
+ * @type {number}
416
+ * @memberof BotRecurringEventsValue
417
+ */
418
+ 'failedAttempts': number;
419
+ /**
420
+ * The reason why the recurring event failed to run in the last attempt.
421
+ * @type {string}
422
+ * @memberof BotRecurringEventsValue
423
+ */
424
+ 'lastFailureReason': string | null;
407
425
  }
408
426
  /**
409
427
  *
@@ -604,6 +622,42 @@ export interface ChangeWorkspacePlanResponse {
604
622
  * @memberof ChangeWorkspacePlanResponse
605
623
  */
606
624
  'spendingLimit': number;
625
+ /**
626
+ *
627
+ * @type {string}
628
+ * @memberof ChangeWorkspacePlanResponse
629
+ */
630
+ 'about'?: string;
631
+ /**
632
+ *
633
+ * @type {string}
634
+ * @memberof ChangeWorkspacePlanResponse
635
+ */
636
+ 'profilePicture'?: string;
637
+ /**
638
+ *
639
+ * @type {string}
640
+ * @memberof ChangeWorkspacePlanResponse
641
+ */
642
+ 'contactEmail'?: string;
643
+ /**
644
+ *
645
+ * @type {string}
646
+ * @memberof ChangeWorkspacePlanResponse
647
+ */
648
+ 'website'?: string;
649
+ /**
650
+ *
651
+ * @type {Array<string>}
652
+ * @memberof ChangeWorkspacePlanResponse
653
+ */
654
+ 'socialAccounts'?: Array<string>;
655
+ /**
656
+ *
657
+ * @type {boolean}
658
+ * @memberof ChangeWorkspacePlanResponse
659
+ */
660
+ 'isPublic'?: boolean;
607
661
  }
608
662
  export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
609
663
  readonly Free: "free";
@@ -697,6 +751,65 @@ export interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner {
697
751
  */
698
752
  'failedReason': string;
699
753
  }
754
+ /**
755
+ *
756
+ * @export
757
+ * @interface Column
758
+ */
759
+ export interface Column {
760
+ /**
761
+ * Unique identifier for the column.
762
+ * @type {string}
763
+ * @memberof Column
764
+ */
765
+ 'id'?: string;
766
+ /**
767
+ * Name of the column, must be within length limits.
768
+ * @type {string}
769
+ * @memberof Column
770
+ */
771
+ 'name': string;
772
+ /**
773
+ * Optional descriptive text about the column.
774
+ * @type {string}
775
+ * @memberof Column
776
+ */
777
+ 'description'?: string;
778
+ /**
779
+ * Indicates if the column is vectorized and searchable.
780
+ * @type {boolean}
781
+ * @memberof Column
782
+ */
783
+ 'searchable'?: boolean;
784
+ /**
785
+ * Specifies the data type of the column. Use \"object\" for complex data structures.
786
+ * @type {string}
787
+ * @memberof Column
788
+ */
789
+ 'type': ColumnTypeEnum;
790
+ /**
791
+ * TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
792
+ * @type {string}
793
+ * @memberof Column
794
+ */
795
+ 'typings'?: string;
796
+ /**
797
+ *
798
+ * @type {{ [key: string]: any; }}
799
+ * @memberof Column
800
+ */
801
+ 'schema'?: {
802
+ [key: string]: any;
803
+ };
804
+ }
805
+ export declare const ColumnTypeEnum: {
806
+ readonly String: "string";
807
+ readonly Number: "number";
808
+ readonly Boolean: "boolean";
809
+ readonly Date: "date";
810
+ readonly Object: "object";
811
+ };
812
+ export type ColumnTypeEnum = typeof ColumnTypeEnum[keyof typeof ColumnTypeEnum];
700
813
  /**
701
814
  *
702
815
  * @export
@@ -785,6 +898,12 @@ export interface CreateBotBody {
785
898
  'recurringEvents'?: {
786
899
  [key: string]: CreateBotBodyRecurringEventsValue;
787
900
  };
901
+ /**
902
+ *
903
+ * @type {CreateBotBodySubscriptions}
904
+ * @memberof CreateBotBody
905
+ */
906
+ 'subscriptions'?: CreateBotBodySubscriptions;
788
907
  /**
789
908
  *
790
909
  * @type {CreateBotBodyConfiguration}
@@ -982,6 +1101,23 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
982
1101
  readonly Bot: "bot";
983
1102
  };
984
1103
  export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
1104
+ /**
1105
+ * Subscriptions of the bot
1106
+ * @export
1107
+ * @interface CreateBotBodySubscriptions
1108
+ */
1109
+ export interface CreateBotBodySubscriptions {
1110
+ /**
1111
+ * Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events.
1112
+ * @type {{ [key: string]: { [key: string]: any; }; }}
1113
+ * @memberof CreateBotBodySubscriptions
1114
+ */
1115
+ 'events': {
1116
+ [key: string]: {
1117
+ [key: string]: any;
1118
+ };
1119
+ } | null;
1120
+ }
985
1121
  /**
986
1122
  *
987
1123
  * @export
@@ -1264,6 +1400,14 @@ export interface CreateIntegrationBody {
1264
1400
  * @memberof CreateIntegrationBody
1265
1401
  */
1266
1402
  'user'?: CreateIntegrationBodyUser;
1403
+ /**
1404
+ * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
1405
+ * @type {{ [key: string]: string; }}
1406
+ * @memberof CreateIntegrationBody
1407
+ */
1408
+ 'secrets'?: {
1409
+ [key: string]: string;
1410
+ };
1267
1411
  /**
1268
1412
  * JavaScript code of the integration
1269
1413
  * @type {string}
@@ -1834,6 +1978,12 @@ export interface CreateWorkspaceMemberResponse {
1834
1978
  * @memberof CreateWorkspaceMemberResponse
1835
1979
  */
1836
1980
  'email': string;
1981
+ /**
1982
+ *
1983
+ * @type {string}
1984
+ * @memberof CreateWorkspaceMemberResponse
1985
+ */
1986
+ 'createdAt': string;
1837
1987
  /**
1838
1988
  *
1839
1989
  * @type {string}
@@ -1922,6 +2072,42 @@ export interface CreateWorkspaceResponse {
1922
2072
  * @memberof CreateWorkspaceResponse
1923
2073
  */
1924
2074
  'spendingLimit': number;
2075
+ /**
2076
+ *
2077
+ * @type {string}
2078
+ * @memberof CreateWorkspaceResponse
2079
+ */
2080
+ 'about'?: string;
2081
+ /**
2082
+ *
2083
+ * @type {string}
2084
+ * @memberof CreateWorkspaceResponse
2085
+ */
2086
+ 'profilePicture'?: string;
2087
+ /**
2088
+ *
2089
+ * @type {string}
2090
+ * @memberof CreateWorkspaceResponse
2091
+ */
2092
+ 'contactEmail'?: string;
2093
+ /**
2094
+ *
2095
+ * @type {string}
2096
+ * @memberof CreateWorkspaceResponse
2097
+ */
2098
+ 'website'?: string;
2099
+ /**
2100
+ *
2101
+ * @type {Array<string>}
2102
+ * @memberof CreateWorkspaceResponse
2103
+ */
2104
+ 'socialAccounts'?: Array<string>;
2105
+ /**
2106
+ *
2107
+ * @type {boolean}
2108
+ * @memberof CreateWorkspaceResponse
2109
+ */
2110
+ 'isPublic'?: boolean;
1925
2111
  }
1926
2112
  export declare const CreateWorkspaceResponseAccountTypeEnum: {
1927
2113
  readonly Free: "free";
@@ -1989,6 +2175,25 @@ export interface Event {
1989
2175
  * @memberof Event
1990
2176
  */
1991
2177
  'messageId'?: string;
2178
+ /**
2179
+ * Status of the event (e.g. `ignored`, `processed`)
2180
+ * @type {string}
2181
+ * @memberof Event
2182
+ */
2183
+ 'status': string;
2184
+ }
2185
+ /**
2186
+ *
2187
+ * @export
2188
+ * @interface GetAccountPreferenceResponse
2189
+ */
2190
+ export interface GetAccountPreferenceResponse {
2191
+ /**
2192
+ *
2193
+ * @type {any}
2194
+ * @memberof GetAccountPreferenceResponse
2195
+ */
2196
+ 'value'?: any | null;
1992
2197
  }
1993
2198
  /**
1994
2199
  *
@@ -2873,6 +3078,42 @@ export interface GetWorkspaceResponse {
2873
3078
  * @memberof GetWorkspaceResponse
2874
3079
  */
2875
3080
  'spendingLimit': number;
3081
+ /**
3082
+ *
3083
+ * @type {string}
3084
+ * @memberof GetWorkspaceResponse
3085
+ */
3086
+ 'about'?: string;
3087
+ /**
3088
+ *
3089
+ * @type {string}
3090
+ * @memberof GetWorkspaceResponse
3091
+ */
3092
+ 'profilePicture'?: string;
3093
+ /**
3094
+ *
3095
+ * @type {string}
3096
+ * @memberof GetWorkspaceResponse
3097
+ */
3098
+ 'contactEmail'?: string;
3099
+ /**
3100
+ *
3101
+ * @type {string}
3102
+ * @memberof GetWorkspaceResponse
3103
+ */
3104
+ 'website'?: string;
3105
+ /**
3106
+ *
3107
+ * @type {Array<string>}
3108
+ * @memberof GetWorkspaceResponse
3109
+ */
3110
+ 'socialAccounts'?: Array<string>;
3111
+ /**
3112
+ *
3113
+ * @type {boolean}
3114
+ * @memberof GetWorkspaceResponse
3115
+ */
3116
+ 'isPublic'?: boolean;
2876
3117
  }
2877
3118
  export declare const GetWorkspaceResponseAccountTypeEnum: {
2878
3119
  readonly Free: "free";
@@ -3006,6 +3247,12 @@ export interface Integration {
3006
3247
  * @memberof Integration
3007
3248
  */
3008
3249
  'readmeUrl': string;
3250
+ /**
3251
+ * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
3252
+ * @type {Array<string>}
3253
+ * @memberof Integration
3254
+ */
3255
+ 'secrets': Array<string>;
3009
3256
  }
3010
3257
  /**
3011
3258
  * Channel definition
@@ -3929,6 +4176,12 @@ export interface ListWorkspaceMembersResponseMembersInner {
3929
4176
  * @memberof ListWorkspaceMembersResponseMembersInner
3930
4177
  */
3931
4178
  'email': string;
4179
+ /**
4180
+ *
4181
+ * @type {string}
4182
+ * @memberof ListWorkspaceMembersResponseMembersInner
4183
+ */
4184
+ 'createdAt': string;
3932
4185
  /**
3933
4186
  *
3934
4187
  * @type {string}
@@ -4177,6 +4430,38 @@ export interface PatchStateResponse {
4177
4430
  */
4178
4431
  'state': State;
4179
4432
  }
4433
+ /**
4434
+ *
4435
+ * @export
4436
+ * @interface Row
4437
+ */
4438
+ export interface Row {
4439
+ [key: string]: any;
4440
+ /**
4441
+ * Unique identifier for the row.
4442
+ * @type {number}
4443
+ * @memberof Row
4444
+ */
4445
+ 'id': number;
4446
+ /**
4447
+ * Timestamp of row creation.
4448
+ * @type {string}
4449
+ * @memberof Row
4450
+ */
4451
+ 'createdAt'?: string;
4452
+ /**
4453
+ * Timestamp of the last row update.
4454
+ * @type {string}
4455
+ * @memberof Row
4456
+ */
4457
+ 'updatedAt'?: string;
4458
+ /**
4459
+ * Optional numeric value indicating similarity, when using findTableRows.
4460
+ * @type {number}
4461
+ * @memberof Row
4462
+ */
4463
+ 'similarity'?: number;
4464
+ }
4180
4465
  /**
4181
4466
  *
4182
4467
  * @export
@@ -4214,12 +4499,23 @@ export interface RunVrlResponse {
4214
4499
  };
4215
4500
  /**
4216
4501
  *
4217
- * @type {{ [key: string]: any; }}
4502
+ * @type {any}
4218
4503
  * @memberof RunVrlResponse
4219
4504
  */
4220
- 'result': {
4221
- [key: string]: any;
4222
- };
4505
+ 'result'?: any | null;
4506
+ }
4507
+ /**
4508
+ *
4509
+ * @export
4510
+ * @interface SetAccountPreferenceBody
4511
+ */
4512
+ export interface SetAccountPreferenceBody {
4513
+ /**
4514
+ *
4515
+ * @type {any}
4516
+ * @memberof SetAccountPreferenceBody
4517
+ */
4518
+ 'value'?: any | null;
4223
4519
  }
4224
4520
  /**
4225
4521
  *
@@ -4391,6 +4687,124 @@ export declare const StateTypeEnum: {
4391
4687
  readonly Integration: "integration";
4392
4688
  };
4393
4689
  export type StateTypeEnum = typeof StateTypeEnum[keyof typeof StateTypeEnum];
4690
+ /**
4691
+ *
4692
+ * @export
4693
+ * @interface Table
4694
+ */
4695
+ export interface Table {
4696
+ /**
4697
+ * Unique identifier for the table
4698
+ * @type {string}
4699
+ * @memberof Table
4700
+ */
4701
+ 'id': string;
4702
+ /**
4703
+ * Required. This name is used to identify your table.
4704
+ * @type {string}
4705
+ * @memberof Table
4706
+ */
4707
+ 'name': string;
4708
+ /**
4709
+ * The \'factor\' multiplies the row\'s data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
4710
+ * @type {number}
4711
+ * @memberof Table
4712
+ */
4713
+ 'factor'?: number;
4714
+ /**
4715
+ * Array of columns in the table.
4716
+ * @type {Array<TableColumnsInner>}
4717
+ * @memberof Table
4718
+ */
4719
+ 'columns': Array<TableColumnsInner>;
4720
+ /**
4721
+ * Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
4722
+ * @type {{ [key: string]: any; }}
4723
+ * @memberof Table
4724
+ */
4725
+ 'schema': {
4726
+ [key: string]: any;
4727
+ };
4728
+ /**
4729
+ * Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
4730
+ * @type {{ [key: string]: string; }}
4731
+ * @memberof Table
4732
+ */
4733
+ 'tags'?: {
4734
+ [key: string]: string;
4735
+ };
4736
+ /**
4737
+ * Timestamp of table creation.
4738
+ * @type {string}
4739
+ * @memberof Table
4740
+ */
4741
+ 'createdAt'?: string;
4742
+ /**
4743
+ * Timestamp of the last table update.
4744
+ * @type {string}
4745
+ * @memberof Table
4746
+ */
4747
+ 'updatedAt'?: string;
4748
+ }
4749
+ /**
4750
+ *
4751
+ * @export
4752
+ * @interface TableColumnsInner
4753
+ */
4754
+ export interface TableColumnsInner {
4755
+ /**
4756
+ * Unique identifier for the column.
4757
+ * @type {string}
4758
+ * @memberof TableColumnsInner
4759
+ */
4760
+ 'id'?: string;
4761
+ /**
4762
+ * Name of the column, must be within length limits.
4763
+ * @type {string}
4764
+ * @memberof TableColumnsInner
4765
+ */
4766
+ 'name': string;
4767
+ /**
4768
+ * Optional descriptive text about the column.
4769
+ * @type {string}
4770
+ * @memberof TableColumnsInner
4771
+ */
4772
+ 'description'?: string;
4773
+ /**
4774
+ * Indicates if the column is vectorized and searchable.
4775
+ * @type {boolean}
4776
+ * @memberof TableColumnsInner
4777
+ */
4778
+ 'searchable'?: boolean;
4779
+ /**
4780
+ * Specifies the data type of the column. Use \"object\" for complex data structures.
4781
+ * @type {string}
4782
+ * @memberof TableColumnsInner
4783
+ */
4784
+ 'type': TableColumnsInnerTypeEnum;
4785
+ /**
4786
+ * TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
4787
+ * @type {string}
4788
+ * @memberof TableColumnsInner
4789
+ */
4790
+ 'typings'?: string;
4791
+ /**
4792
+ *
4793
+ * @type {{ [key: string]: any; }}
4794
+ * @memberof TableColumnsInner
4795
+ */
4796
+ 'schema'?: {
4797
+ [key: string]: any;
4798
+ };
4799
+ }
4800
+ export declare const TableColumnsInnerTypeEnum: {
4801
+ readonly String: "string";
4802
+ readonly Number: "number";
4803
+ readonly Boolean: "boolean";
4804
+ readonly Date: "date";
4805
+ readonly Object: "object";
4806
+ };
4807
+ export type TableColumnsInnerTypeEnum = typeof TableColumnsInnerTypeEnum[keyof typeof TableColumnsInnerTypeEnum];
4394
4808
  /**
4395
4809
  *
4396
4810
  * @export
@@ -4434,6 +4848,12 @@ export interface UpdateBotBody {
4434
4848
  * @memberof UpdateBotBody
4435
4849
  */
4436
4850
  'blocked'?: boolean;
4851
+ /**
4852
+ * Indicates if the [Bot](#schema_bot) should be in always alive mode
4853
+ * @type {boolean}
4854
+ * @memberof UpdateBotBody
4855
+ */
4856
+ 'alwaysAlive'?: boolean;
4437
4857
  /**
4438
4858
  *
4439
4859
  * @type {UpdateBotBodyUser}
@@ -4484,6 +4904,12 @@ export interface UpdateBotBody {
4484
4904
  'integrations'?: {
4485
4905
  [key: string]: UpdateBotBodyIntegrationsValue | null;
4486
4906
  };
4907
+ /**
4908
+ *
4909
+ * @type {UpdateBotBodySubscriptions}
4910
+ * @memberof UpdateBotBody
4911
+ */
4912
+ 'subscriptions'?: UpdateBotBodySubscriptions;
4487
4913
  /**
4488
4914
  * JavaScript code of the bot
4489
4915
  * @type {string}
@@ -4502,12 +4928,6 @@ export interface UpdateBotBody {
4502
4928
  * @memberof UpdateBotBody
4503
4929
  */
4504
4930
  'medias'?: Array<CreateBotBodyMediasInner>;
4505
- /**
4506
- * Indicates if the [Bot](#schema_bot) should be in always alive mode
4507
- * @type {boolean}
4508
- * @memberof UpdateBotBody
4509
- */
4510
- 'alwaysAlive'?: boolean;
4511
4931
  }
4512
4932
  export declare const UpdateBotBodyAuthenticationEnum: {
4513
4933
  readonly Iam: "iam";
@@ -4621,6 +5041,23 @@ export declare const UpdateBotBodyStatesValueTypeEnum: {
4621
5041
  readonly Bot: "bot";
4622
5042
  };
4623
5043
  export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTypeEnum[keyof typeof UpdateBotBodyStatesValueTypeEnum];
5044
+ /**
5045
+ *
5046
+ * @export
5047
+ * @interface UpdateBotBodySubscriptions
5048
+ */
5049
+ export interface UpdateBotBodySubscriptions {
5050
+ /**
5051
+ *
5052
+ * @type {{ [key: string]: { [key: string]: any; } | null; }}
5053
+ * @memberof UpdateBotBodySubscriptions
5054
+ */
5055
+ 'events': {
5056
+ [key: string]: {
5057
+ [key: string]: any;
5058
+ } | null;
5059
+ } | null;
5060
+ }
4624
5061
  /**
4625
5062
  *
4626
5063
  * @export
@@ -4752,6 +5189,14 @@ export interface UpdateIntegrationBody {
4752
5189
  * @memberof UpdateIntegrationBody
4753
5190
  */
4754
5191
  'user'?: UpdateIntegrationBodyUser;
5192
+ /**
5193
+ * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
5194
+ * @type {{ [key: string]: string | null; }}
5195
+ * @memberof UpdateIntegrationBody
5196
+ */
5197
+ 'secrets'?: {
5198
+ [key: string]: string | null;
5199
+ };
4755
5200
  /**
4756
5201
  * JavaScript code of the integration
4757
5202
  * @type {string}
@@ -5101,6 +5546,42 @@ export interface UpdateWorkspaceBody {
5101
5546
  * @memberof UpdateWorkspaceBody
5102
5547
  */
5103
5548
  'spendingLimit'?: number;
5549
+ /**
5550
+ *
5551
+ * @type {string}
5552
+ * @memberof UpdateWorkspaceBody
5553
+ */
5554
+ 'about'?: string;
5555
+ /**
5556
+ *
5557
+ * @type {string}
5558
+ * @memberof UpdateWorkspaceBody
5559
+ */
5560
+ 'profilePicture'?: string;
5561
+ /**
5562
+ *
5563
+ * @type {string}
5564
+ * @memberof UpdateWorkspaceBody
5565
+ */
5566
+ 'contactEmail'?: string;
5567
+ /**
5568
+ *
5569
+ * @type {string}
5570
+ * @memberof UpdateWorkspaceBody
5571
+ */
5572
+ 'website'?: string;
5573
+ /**
5574
+ *
5575
+ * @type {Array<string>}
5576
+ * @memberof UpdateWorkspaceBody
5577
+ */
5578
+ 'socialAccounts'?: Array<string>;
5579
+ /**
5580
+ *
5581
+ * @type {boolean}
5582
+ * @memberof UpdateWorkspaceBody
5583
+ */
5584
+ 'isPublic'?: boolean;
5104
5585
  }
5105
5586
  /**
5106
5587
  *
@@ -5148,6 +5629,12 @@ export interface UpdateWorkspaceMemberResponse {
5148
5629
  * @memberof UpdateWorkspaceMemberResponse
5149
5630
  */
5150
5631
  'email': string;
5632
+ /**
5633
+ *
5634
+ * @type {string}
5635
+ * @memberof UpdateWorkspaceMemberResponse
5636
+ */
5637
+ 'createdAt': string;
5151
5638
  /**
5152
5639
  *
5153
5640
  * @type {string}
@@ -5236,6 +5723,42 @@ export interface UpdateWorkspaceResponse {
5236
5723
  * @memberof UpdateWorkspaceResponse
5237
5724
  */
5238
5725
  'spendingLimit': number;
5726
+ /**
5727
+ *
5728
+ * @type {string}
5729
+ * @memberof UpdateWorkspaceResponse
5730
+ */
5731
+ 'about'?: string;
5732
+ /**
5733
+ *
5734
+ * @type {string}
5735
+ * @memberof UpdateWorkspaceResponse
5736
+ */
5737
+ 'profilePicture'?: string;
5738
+ /**
5739
+ *
5740
+ * @type {string}
5741
+ * @memberof UpdateWorkspaceResponse
5742
+ */
5743
+ 'contactEmail'?: string;
5744
+ /**
5745
+ *
5746
+ * @type {string}
5747
+ * @memberof UpdateWorkspaceResponse
5748
+ */
5749
+ 'website'?: string;
5750
+ /**
5751
+ *
5752
+ * @type {Array<string>}
5753
+ * @memberof UpdateWorkspaceResponse
5754
+ */
5755
+ 'socialAccounts'?: Array<string>;
5756
+ /**
5757
+ *
5758
+ * @type {boolean}
5759
+ * @memberof UpdateWorkspaceResponse
5760
+ */
5761
+ 'isPublic'?: boolean;
5239
5762
  }
5240
5763
  export declare const UpdateWorkspaceResponseAccountTypeEnum: {
5241
5764
  readonly Free: "free";
@@ -5325,6 +5848,42 @@ export interface UpdateWorkspaceResponse1 {
5325
5848
  * @memberof UpdateWorkspaceResponse1
5326
5849
  */
5327
5850
  'spendingLimit': number;
5851
+ /**
5852
+ *
5853
+ * @type {string}
5854
+ * @memberof UpdateWorkspaceResponse1
5855
+ */
5856
+ 'about'?: string;
5857
+ /**
5858
+ *
5859
+ * @type {string}
5860
+ * @memberof UpdateWorkspaceResponse1
5861
+ */
5862
+ 'profilePicture'?: string;
5863
+ /**
5864
+ *
5865
+ * @type {string}
5866
+ * @memberof UpdateWorkspaceResponse1
5867
+ */
5868
+ 'contactEmail'?: string;
5869
+ /**
5870
+ *
5871
+ * @type {string}
5872
+ * @memberof UpdateWorkspaceResponse1
5873
+ */
5874
+ 'website'?: string;
5875
+ /**
5876
+ *
5877
+ * @type {Array<string>}
5878
+ * @memberof UpdateWorkspaceResponse1
5879
+ */
5880
+ 'socialAccounts'?: Array<string>;
5881
+ /**
5882
+ *
5883
+ * @type {boolean}
5884
+ * @memberof UpdateWorkspaceResponse1
5885
+ */
5886
+ 'isPublic'?: boolean;
5328
5887
  }
5329
5888
  export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
5330
5889
  readonly Free: "free";
@@ -5512,6 +6071,42 @@ export interface Workspace {
5512
6071
  * @memberof Workspace
5513
6072
  */
5514
6073
  'spendingLimit': number;
6074
+ /**
6075
+ *
6076
+ * @type {string}
6077
+ * @memberof Workspace
6078
+ */
6079
+ 'about'?: string;
6080
+ /**
6081
+ *
6082
+ * @type {string}
6083
+ * @memberof Workspace
6084
+ */
6085
+ 'profilePicture'?: string;
6086
+ /**
6087
+ *
6088
+ * @type {string}
6089
+ * @memberof Workspace
6090
+ */
6091
+ 'contactEmail'?: string;
6092
+ /**
6093
+ *
6094
+ * @type {string}
6095
+ * @memberof Workspace
6096
+ */
6097
+ 'website'?: string;
6098
+ /**
6099
+ *
6100
+ * @type {Array<string>}
6101
+ * @memberof Workspace
6102
+ */
6103
+ 'socialAccounts'?: Array<string>;
6104
+ /**
6105
+ *
6106
+ * @type {boolean}
6107
+ * @memberof Workspace
6108
+ */
6109
+ 'isPublic'?: boolean;
5515
6110
  }
5516
6111
  export declare const WorkspaceAccountTypeEnum: {
5517
6112
  readonly Free: "free";
@@ -5553,6 +6148,12 @@ export interface WorkspaceMember {
5553
6148
  * @memberof WorkspaceMember
5554
6149
  */
5555
6150
  'email': string;
6151
+ /**
6152
+ *
6153
+ * @type {string}
6154
+ * @memberof WorkspaceMember
6155
+ */
6156
+ 'createdAt': string;
5556
6157
  /**
5557
6158
  *
5558
6159
  * @type {string}
@@ -5782,6 +6383,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
5782
6383
  * @throws {RequiredError}
5783
6384
  */
5784
6385
  getAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
6386
+ /**
6387
+ * Get a preference of the account
6388
+ * @param {string} key Preference key
6389
+ * @param {*} [options] Override http request option.
6390
+ * @throws {RequiredError}
6391
+ */
6392
+ getAccountPreference: (key: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5785
6393
  /**
5786
6394
  * For a user, gets a map of workspace IDs to their highest quota completion rate
5787
6395
  * @param {*} [options] Override http request option.
@@ -6018,7 +6626,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
6018
6626
  [key: string]: string;
6019
6627
  } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6020
6628
  /**
6021
- * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
6629
+ * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
6022
6630
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
6023
6631
  * @param {string} [type] Filter by event type
6024
6632
  * @param {string} [conversationId] Filter by conversation id
@@ -6162,6 +6770,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
6162
6770
  * @throws {RequiredError}
6163
6771
  */
6164
6772
  runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6773
+ /**
6774
+ * Set a preference for the account
6775
+ * @param {string} key Preference key
6776
+ * @param {SetAccountPreferenceBody} [setAccountPreferenceBody] Preference value
6777
+ * @param {*} [options] Override http request option.
6778
+ * @throws {RequiredError}
6779
+ */
6780
+ setAccountPreference: (key: string, setAccountPreferenceBody?: SetAccountPreferenceBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6165
6781
  /**
6166
6782
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
6167
6783
  * @param {SetStateTypeEnum} type State type
@@ -6458,6 +7074,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
6458
7074
  * @throws {RequiredError}
6459
7075
  */
6460
7076
  getAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
7077
+ /**
7078
+ * Get a preference of the account
7079
+ * @param {string} key Preference key
7080
+ * @param {*} [options] Override http request option.
7081
+ * @throws {RequiredError}
7082
+ */
7083
+ getAccountPreference(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountPreferenceResponse>>;
6461
7084
  /**
6462
7085
  * For a user, gets a map of workspace IDs to their highest quota completion rate
6463
7086
  * @param {*} [options] Override http request option.
@@ -6696,7 +7319,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
6696
7319
  [key: string]: string;
6697
7320
  } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
6698
7321
  /**
6699
- * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
7322
+ * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
6700
7323
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
6701
7324
  * @param {string} [type] Filter by event type
6702
7325
  * @param {string} [conversationId] Filter by conversation id
@@ -6840,6 +7463,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
6840
7463
  * @throws {RequiredError}
6841
7464
  */
6842
7465
  runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
7466
+ /**
7467
+ * Set a preference for the account
7468
+ * @param {string} key Preference key
7469
+ * @param {SetAccountPreferenceBody} [setAccountPreferenceBody] Preference value
7470
+ * @param {*} [options] Override http request option.
7471
+ * @throws {RequiredError}
7472
+ */
7473
+ setAccountPreference(key: string, setAccountPreferenceBody?: SetAccountPreferenceBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
6843
7474
  /**
6844
7475
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
6845
7476
  * @param {SetStateTypeEnum} type State type
@@ -7130,6 +7761,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
7130
7761
  * @throws {RequiredError}
7131
7762
  */
7132
7763
  getAccount(options?: AxiosRequestConfig): AxiosPromise<GetAccountResponse>;
7764
+ /**
7765
+ * Get a preference of the account
7766
+ * @param {DefaultApiGetAccountPreferenceRequest} requestParameters Request parameters.
7767
+ * @param {*} [options] Override http request option.
7768
+ * @throws {RequiredError}
7769
+ */
7770
+ getAccountPreference(requestParameters: DefaultApiGetAccountPreferenceRequest, options?: AxiosRequestConfig): AxiosPromise<GetAccountPreferenceResponse>;
7133
7771
  /**
7134
7772
  * For a user, gets a map of workspace IDs to their highest quota completion rate
7135
7773
  * @param {*} [options] Override http request option.
@@ -7342,7 +7980,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
7342
7980
  */
7343
7981
  listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
7344
7982
  /**
7345
- * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
7983
+ * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
7346
7984
  * @param {DefaultApiListEventsRequest} requestParameters Request parameters.
7347
7985
  * @param {*} [options] Override http request option.
7348
7986
  * @throws {RequiredError}
@@ -7459,6 +8097,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
7459
8097
  * @throws {RequiredError}
7460
8098
  */
7461
8099
  runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): AxiosPromise<RunVrlResponse>;
8100
+ /**
8101
+ * Set a preference for the account
8102
+ * @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
8103
+ * @param {*} [options] Override http request option.
8104
+ * @throws {RequiredError}
8105
+ */
8106
+ setAccountPreference(requestParameters: DefaultApiSetAccountPreferenceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
7462
8107
  /**
7463
8108
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
7464
8109
  * @param {DefaultApiSetStateRequest} requestParameters Request parameters.
@@ -7930,6 +8575,19 @@ export interface DefaultApiDownloadFileRequest {
7930
8575
  */
7931
8576
  readonly id: string;
7932
8577
  }
8578
+ /**
8579
+ * Request parameters for getAccountPreference operation in DefaultApi.
8580
+ * @export
8581
+ * @interface DefaultApiGetAccountPreferenceRequest
8582
+ */
8583
+ export interface DefaultApiGetAccountPreferenceRequest {
8584
+ /**
8585
+ * Preference key
8586
+ * @type {string}
8587
+ * @memberof DefaultApiGetAccountPreference
8588
+ */
8589
+ readonly key: string;
8590
+ }
7933
8591
  /**
7934
8592
  * Request parameters for getAuditRecords operation in DefaultApi.
7935
8593
  * @export
@@ -8803,6 +9461,25 @@ export interface DefaultApiRunVrlRequest {
8803
9461
  */
8804
9462
  readonly runVrlBody?: RunVrlBody;
8805
9463
  }
9464
+ /**
9465
+ * Request parameters for setAccountPreference operation in DefaultApi.
9466
+ * @export
9467
+ * @interface DefaultApiSetAccountPreferenceRequest
9468
+ */
9469
+ export interface DefaultApiSetAccountPreferenceRequest {
9470
+ /**
9471
+ * Preference key
9472
+ * @type {string}
9473
+ * @memberof DefaultApiSetAccountPreference
9474
+ */
9475
+ readonly key: string;
9476
+ /**
9477
+ * Preference value
9478
+ * @type {SetAccountPreferenceBody}
9479
+ * @memberof DefaultApiSetAccountPreference
9480
+ */
9481
+ readonly setAccountPreferenceBody?: SetAccountPreferenceBody;
9482
+ }
8806
9483
  /**
8807
9484
  * Request parameters for setState operation in DefaultApi.
8808
9485
  * @export
@@ -9243,6 +9920,14 @@ export declare class DefaultApi extends BaseAPI {
9243
9920
  * @memberof DefaultApi
9244
9921
  */
9245
9922
  getAccount(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponse, any>>;
9923
+ /**
9924
+ * Get a preference of the account
9925
+ * @param {DefaultApiGetAccountPreferenceRequest} requestParameters Request parameters.
9926
+ * @param {*} [options] Override http request option.
9927
+ * @throws {RequiredError}
9928
+ * @memberof DefaultApi
9929
+ */
9930
+ getAccountPreference(requestParameters: DefaultApiGetAccountPreferenceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountPreferenceResponse, any>>;
9246
9931
  /**
9247
9932
  * For a user, gets a map of workspace IDs to their highest quota completion rate
9248
9933
  * @param {*} [options] Override http request option.
@@ -9485,7 +10170,7 @@ export declare class DefaultApi extends BaseAPI {
9485
10170
  */
9486
10171
  listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConversationsResponse, any>>;
9487
10172
  /**
9488
- * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
10173
+ * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
9489
10174
  * @param {DefaultApiListEventsRequest} requestParameters Request parameters.
9490
10175
  * @param {*} [options] Override http request option.
9491
10176
  * @throws {RequiredError}
@@ -9619,6 +10304,14 @@ export declare class DefaultApi extends BaseAPI {
9619
10304
  * @memberof DefaultApi
9620
10305
  */
9621
10306
  runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunVrlResponse, any>>;
10307
+ /**
10308
+ * Set a preference for the account
10309
+ * @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
10310
+ * @param {*} [options] Override http request option.
10311
+ * @throws {RequiredError}
10312
+ * @memberof DefaultApi
10313
+ */
10314
+ setAccountPreference(requestParameters: DefaultApiSetAccountPreferenceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
9622
10315
  /**
9623
10316
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
9624
10317
  * @param {DefaultApiSetStateRequest} requestParameters Request parameters.