@botpress/client 1.33.0 → 1.34.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/index.d.ts CHANGED
@@ -3752,6 +3752,10 @@ interface GetPublicIntegrationByIdResponse$1 {
3752
3752
  * URL of the [Integration](#schema_integration)
3753
3753
  */
3754
3754
  url: string;
3755
+ /**
3756
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
3757
+ */
3758
+ signingSecret: string;
3755
3759
  /**
3756
3760
  * Name of the [Integration](#schema_integration)
3757
3761
  */
@@ -4168,6 +4172,10 @@ interface GetPublicIntegrationResponse$1 {
4168
4172
  * URL of the [Integration](#schema_integration)
4169
4173
  */
4170
4174
  url: string;
4175
+ /**
4176
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
4177
+ */
4178
+ signingSecret: string;
4171
4179
  /**
4172
4180
  * Name of the [Integration](#schema_integration)
4173
4181
  */
@@ -5907,7 +5915,7 @@ interface CreateBotResponse$1 {
5907
5915
  */
5908
5916
  updatedAt: string;
5909
5917
  /**
5910
- * Signing secret of the [Bot](#schema_bot)
5918
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
5911
5919
  */
5912
5920
  signingSecret: string;
5913
5921
  /**
@@ -6321,9 +6329,9 @@ interface UpdateBotRequestBody$1 {
6321
6329
  */
6322
6330
  url?: string | null;
6323
6331
  /**
6324
- * Type of the [Bot](#schema_bot) authentication (`iam`)
6332
+ * Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)
6325
6333
  */
6326
- authentication?: "iam";
6334
+ authentication?: "iam" | "hmac-sha256";
6327
6335
  configuration?: {
6328
6336
  /**
6329
6337
  * Configuration data
@@ -6587,7 +6595,7 @@ interface UpdateBotResponse$1 {
6587
6595
  */
6588
6596
  updatedAt: string;
6589
6597
  /**
6590
- * Signing secret of the [Bot](#schema_bot)
6598
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
6591
6599
  */
6592
6600
  signingSecret: string;
6593
6601
  /**
@@ -6988,6 +6996,23 @@ interface UpdateBotResponse$1 {
6988
6996
  };
6989
6997
  }
6990
6998
 
6999
+ interface RotateBotSigningSecretsRequestHeaders$1 {
7000
+ }
7001
+ interface RotateBotSigningSecretsRequestQuery$1 {
7002
+ }
7003
+ interface RotateBotSigningSecretsRequestParams$1 {
7004
+ id: string;
7005
+ }
7006
+ interface RotateBotSigningSecretsRequestBody$1 {
7007
+ }
7008
+ type RotateBotSigningSecretsInput$1 = RotateBotSigningSecretsRequestBody$1 & RotateBotSigningSecretsRequestHeaders$1 & RotateBotSigningSecretsRequestQuery$1 & RotateBotSigningSecretsRequestParams$1;
7009
+ interface RotateBotSigningSecretsResponse$1 {
7010
+ /**
7011
+ * The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition.
7012
+ */
7013
+ newSigningSecret: string;
7014
+ }
7015
+
6991
7016
  interface TransferBotRequestHeaders$1 {
6992
7017
  }
6993
7018
  interface TransferBotRequestQuery$1 {
@@ -7078,7 +7103,7 @@ interface GetBotResponse$1 {
7078
7103
  */
7079
7104
  updatedAt: string;
7080
7105
  /**
7081
- * Signing secret of the [Bot](#schema_bot)
7106
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
7082
7107
  */
7083
7108
  signingSecret: string;
7084
7109
  /**
@@ -9130,6 +9155,10 @@ interface CreateIntegrationResponse$1 {
9130
9155
  * URL of the [Integration](#schema_integration)
9131
9156
  */
9132
9157
  url: string;
9158
+ /**
9159
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
9160
+ */
9161
+ signingSecret: string;
9133
9162
  /**
9134
9163
  * Name of the [Integration](#schema_integration)
9135
9164
  */
@@ -10210,6 +10239,10 @@ interface UpdateIntegrationResponse$1 {
10210
10239
  * URL of the [Integration](#schema_integration)
10211
10240
  */
10212
10241
  url: string;
10242
+ /**
10243
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
10244
+ */
10245
+ signingSecret: string;
10213
10246
  /**
10214
10247
  * Name of the [Integration](#schema_integration)
10215
10248
  */
@@ -10561,6 +10594,23 @@ interface UpdateIntegrationResponse$1 {
10561
10594
  };
10562
10595
  }
10563
10596
 
10597
+ interface RotateIntegrationSigningSecretsRequestHeaders$1 {
10598
+ }
10599
+ interface RotateIntegrationSigningSecretsRequestQuery$1 {
10600
+ }
10601
+ interface RotateIntegrationSigningSecretsRequestParams$1 {
10602
+ id: string;
10603
+ }
10604
+ interface RotateIntegrationSigningSecretsRequestBody$1 {
10605
+ }
10606
+ type RotateIntegrationSigningSecretsInput$1 = RotateIntegrationSigningSecretsRequestBody$1 & RotateIntegrationSigningSecretsRequestHeaders$1 & RotateIntegrationSigningSecretsRequestQuery$1 & RotateIntegrationSigningSecretsRequestParams$1;
10607
+ interface RotateIntegrationSigningSecretsResponse$1 {
10608
+ /**
10609
+ * The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition.
10610
+ */
10611
+ newSigningSecret: string;
10612
+ }
10613
+
10564
10614
  interface ValidateIntegrationUpdateRequestHeaders$1 {
10565
10615
  }
10566
10616
  interface ValidateIntegrationUpdateRequestQuery$1 {
@@ -11065,6 +11115,10 @@ interface GetIntegrationResponse$1 {
11065
11115
  * URL of the [Integration](#schema_integration)
11066
11116
  */
11067
11117
  url: string;
11118
+ /**
11119
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
11120
+ */
11121
+ signingSecret: string;
11068
11122
  /**
11069
11123
  * Name of the [Integration](#schema_integration)
11070
11124
  */
@@ -11501,6 +11555,10 @@ interface GetIntegrationByNameResponse$1 {
11501
11555
  * URL of the [Integration](#schema_integration)
11502
11556
  */
11503
11557
  url: string;
11558
+ /**
11559
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
11560
+ */
11561
+ signingSecret: string;
11504
11562
  /**
11505
11563
  * Name of the [Integration](#schema_integration)
11506
11564
  */
@@ -14777,6 +14835,7 @@ declare class Client$9 {
14777
14835
  readonly getPublicInterface: (input: GetPublicInterfaceInput$1) => Promise<GetPublicInterfaceResponse$1>;
14778
14836
  readonly createBot: (input: CreateBotInput$1) => Promise<CreateBotResponse$1>;
14779
14837
  readonly updateBot: (input: UpdateBotInput$1) => Promise<UpdateBotResponse$1>;
14838
+ readonly rotateBotSigningSecrets: (input: RotateBotSigningSecretsInput$1) => Promise<RotateBotSigningSecretsResponse$1>;
14780
14839
  readonly transferBot: (input: TransferBotInput$1) => Promise<TransferBotResponse$1>;
14781
14840
  readonly listBots: (input: ListBotsInput$1) => Promise<ListBotsResponse$1>;
14782
14841
  readonly getBot: (input: GetBotInput$1) => Promise<GetBotResponse$1>;
@@ -14834,6 +14893,7 @@ declare class Client$9 {
14834
14893
  readonly createIntegration: (input: CreateIntegrationInput$1) => Promise<CreateIntegrationResponse$1>;
14835
14894
  readonly validateIntegrationCreation: (input: ValidateIntegrationCreationInput$1) => Promise<ValidateIntegrationCreationResponse$1>;
14836
14895
  readonly updateIntegration: (input: UpdateIntegrationInput$1) => Promise<UpdateIntegrationResponse$1>;
14896
+ readonly rotateIntegrationSigningSecrets: (input: RotateIntegrationSigningSecretsInput$1) => Promise<RotateIntegrationSigningSecretsResponse$1>;
14837
14897
  readonly validateIntegrationUpdate: (input: ValidateIntegrationUpdateInput$1) => Promise<ValidateIntegrationUpdateResponse$1>;
14838
14898
  readonly listIntegrations: (input: ListIntegrationsInput$1) => Promise<ListIntegrationsResponse$1>;
14839
14899
  readonly getIntegration: (input: GetIntegrationInput$1) => Promise<GetIntegrationResponse$1>;
@@ -15252,9 +15312,6 @@ interface GetCurrentSubscriptionResponse {
15252
15312
  } | null;
15253
15313
  };
15254
15314
  };
15255
- yearlyTotal: number;
15256
- monthlyTotal: number;
15257
- proratedTotal: number;
15258
15315
  }
15259
15316
 
15260
15317
  interface GetNextSubscriptionRequestHeaders {
@@ -15298,9 +15355,6 @@ interface GetNextSubscriptionResponse {
15298
15355
  } | null;
15299
15356
  };
15300
15357
  };
15301
- yearlyTotal: number;
15302
- monthlyTotal: number;
15303
- proratedTotal: number;
15304
15358
  }
15305
15359
 
15306
15360
  interface PreviewSubscriptionUpdateRequestHeaders {
@@ -15440,9 +15494,6 @@ interface SetPlanResponse {
15440
15494
  } | null;
15441
15495
  };
15442
15496
  };
15443
- yearlyTotal: number;
15444
- monthlyTotal: number;
15445
- proratedTotal: number;
15446
15497
  }
15447
15498
 
15448
15499
  interface SetAddonsRequestHeaders {
@@ -15495,9 +15546,6 @@ interface SetAddonsResponse {
15495
15546
  } | null;
15496
15547
  };
15497
15548
  };
15498
- yearlyTotal: number;
15499
- monthlyTotal: number;
15500
- proratedTotal: number;
15501
15549
  }
15502
15550
 
15503
15551
  interface ListInvoicesRequestHeaders {
@@ -22112,6 +22160,10 @@ interface GetPublicIntegrationByIdResponse {
22112
22160
  * URL of the [Integration](#schema_integration)
22113
22161
  */
22114
22162
  url: string;
22163
+ /**
22164
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
22165
+ */
22166
+ signingSecret: string;
22115
22167
  /**
22116
22168
  * Name of the [Integration](#schema_integration)
22117
22169
  */
@@ -22528,6 +22580,10 @@ interface GetPublicIntegrationResponse {
22528
22580
  * URL of the [Integration](#schema_integration)
22529
22581
  */
22530
22582
  url: string;
22583
+ /**
22584
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
22585
+ */
22586
+ signingSecret: string;
22531
22587
  /**
22532
22588
  * Name of the [Integration](#schema_integration)
22533
22589
  */
@@ -24267,7 +24323,7 @@ interface CreateBotResponse {
24267
24323
  */
24268
24324
  updatedAt: string;
24269
24325
  /**
24270
- * Signing secret of the [Bot](#schema_bot)
24326
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
24271
24327
  */
24272
24328
  signingSecret: string;
24273
24329
  /**
@@ -24681,9 +24737,9 @@ interface UpdateBotRequestBody {
24681
24737
  */
24682
24738
  url?: string | null;
24683
24739
  /**
24684
- * Type of the [Bot](#schema_bot) authentication (`iam`)
24740
+ * Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)
24685
24741
  */
24686
- authentication?: "iam";
24742
+ authentication?: "iam" | "hmac-sha256";
24687
24743
  configuration?: {
24688
24744
  /**
24689
24745
  * Configuration data
@@ -24947,7 +25003,7 @@ interface UpdateBotResponse {
24947
25003
  */
24948
25004
  updatedAt: string;
24949
25005
  /**
24950
- * Signing secret of the [Bot](#schema_bot)
25006
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
24951
25007
  */
24952
25008
  signingSecret: string;
24953
25009
  /**
@@ -25348,6 +25404,23 @@ interface UpdateBotResponse {
25348
25404
  };
25349
25405
  }
25350
25406
 
25407
+ interface RotateBotSigningSecretsRequestHeaders {
25408
+ }
25409
+ interface RotateBotSigningSecretsRequestQuery {
25410
+ }
25411
+ interface RotateBotSigningSecretsRequestParams {
25412
+ id: string;
25413
+ }
25414
+ interface RotateBotSigningSecretsRequestBody {
25415
+ }
25416
+ type RotateBotSigningSecretsInput = RotateBotSigningSecretsRequestBody & RotateBotSigningSecretsRequestHeaders & RotateBotSigningSecretsRequestQuery & RotateBotSigningSecretsRequestParams;
25417
+ interface RotateBotSigningSecretsResponse {
25418
+ /**
25419
+ * The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition.
25420
+ */
25421
+ newSigningSecret: string;
25422
+ }
25423
+
25351
25424
  interface TransferBotRequestHeaders {
25352
25425
  }
25353
25426
  interface TransferBotRequestQuery {
@@ -25438,7 +25511,7 @@ interface GetBotResponse {
25438
25511
  */
25439
25512
  updatedAt: string;
25440
25513
  /**
25441
- * Signing secret of the [Bot](#schema_bot)
25514
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
25442
25515
  */
25443
25516
  signingSecret: string;
25444
25517
  /**
@@ -27491,6 +27564,10 @@ interface CreateIntegrationResponse {
27491
27564
  * URL of the [Integration](#schema_integration)
27492
27565
  */
27493
27566
  url: string;
27567
+ /**
27568
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
27569
+ */
27570
+ signingSecret: string;
27494
27571
  /**
27495
27572
  * Name of the [Integration](#schema_integration)
27496
27573
  */
@@ -28571,6 +28648,10 @@ interface UpdateIntegrationResponse {
28571
28648
  * URL of the [Integration](#schema_integration)
28572
28649
  */
28573
28650
  url: string;
28651
+ /**
28652
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
28653
+ */
28654
+ signingSecret: string;
28574
28655
  /**
28575
28656
  * Name of the [Integration](#schema_integration)
28576
28657
  */
@@ -28922,6 +29003,23 @@ interface UpdateIntegrationResponse {
28922
29003
  };
28923
29004
  }
28924
29005
 
29006
+ interface RotateIntegrationSigningSecretsRequestHeaders {
29007
+ }
29008
+ interface RotateIntegrationSigningSecretsRequestQuery {
29009
+ }
29010
+ interface RotateIntegrationSigningSecretsRequestParams {
29011
+ id: string;
29012
+ }
29013
+ interface RotateIntegrationSigningSecretsRequestBody {
29014
+ }
29015
+ type RotateIntegrationSigningSecretsInput = RotateIntegrationSigningSecretsRequestBody & RotateIntegrationSigningSecretsRequestHeaders & RotateIntegrationSigningSecretsRequestQuery & RotateIntegrationSigningSecretsRequestParams;
29016
+ interface RotateIntegrationSigningSecretsResponse {
29017
+ /**
29018
+ * The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition.
29019
+ */
29020
+ newSigningSecret: string;
29021
+ }
29022
+
28925
29023
  interface ValidateIntegrationUpdateRequestHeaders {
28926
29024
  }
28927
29025
  interface ValidateIntegrationUpdateRequestQuery {
@@ -29426,6 +29524,10 @@ interface GetIntegrationResponse {
29426
29524
  * URL of the [Integration](#schema_integration)
29427
29525
  */
29428
29526
  url: string;
29527
+ /**
29528
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
29529
+ */
29530
+ signingSecret: string;
29429
29531
  /**
29430
29532
  * Name of the [Integration](#schema_integration)
29431
29533
  */
@@ -29862,6 +29964,10 @@ interface GetIntegrationByNameResponse {
29862
29964
  * URL of the [Integration](#schema_integration)
29863
29965
  */
29864
29966
  url: string;
29967
+ /**
29968
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
29969
+ */
29970
+ signingSecret: string;
29865
29971
  /**
29866
29972
  * Name of the [Integration](#schema_integration)
29867
29973
  */
@@ -35882,7 +35988,7 @@ interface Bot {
35882
35988
  */
35883
35989
  updatedAt: string;
35884
35990
  /**
35885
- * Signing secret of the [Bot](#schema_bot)
35991
+ * Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot.
35886
35992
  */
35887
35993
  signingSecret: string;
35888
35994
  /**
@@ -36325,6 +36431,10 @@ interface Integration {
36325
36431
  * URL of the [Integration](#schema_integration)
36326
36432
  */
36327
36433
  url: string;
36434
+ /**
36435
+ * Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration.
36436
+ */
36437
+ signingSecret: string;
36328
36438
  /**
36329
36439
  * Name of the [Integration](#schema_integration)
36330
36440
  */
@@ -37864,6 +37974,7 @@ declare class Client$1 {
37864
37974
  readonly getPublicInterface: (input: GetPublicInterfaceInput) => Promise<GetPublicInterfaceResponse>;
37865
37975
  readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
37866
37976
  readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
37977
+ readonly rotateBotSigningSecrets: (input: RotateBotSigningSecretsInput) => Promise<RotateBotSigningSecretsResponse>;
37867
37978
  readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
37868
37979
  readonly listBots: (input: ListBotsInput) => Promise<ListBotsResponse>;
37869
37980
  readonly getBot: (input: GetBotInput) => Promise<GetBotResponse>;
@@ -37921,6 +38032,7 @@ declare class Client$1 {
37921
38032
  readonly createIntegration: (input: CreateIntegrationInput) => Promise<CreateIntegrationResponse>;
37922
38033
  readonly validateIntegrationCreation: (input: ValidateIntegrationCreationInput) => Promise<ValidateIntegrationCreationResponse>;
37923
38034
  readonly updateIntegration: (input: UpdateIntegrationInput) => Promise<UpdateIntegrationResponse>;
38035
+ readonly rotateIntegrationSigningSecrets: (input: RotateIntegrationSigningSecretsInput) => Promise<RotateIntegrationSigningSecretsResponse>;
37924
38036
  readonly validateIntegrationUpdate: (input: ValidateIntegrationUpdateInput) => Promise<ValidateIntegrationUpdateResponse>;
37925
38037
  readonly listIntegrations: (input: ListIntegrationsInput) => Promise<ListIntegrationsResponse>;
37926
38038
  readonly getIntegration: (input: GetIntegrationInput) => Promise<GetIntegrationResponse>;