@botpress/client 1.33.0 → 1.35.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/bundle.cjs +14 -14
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +5 -5
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +565 -77
- package/dist/index.mjs +5 -5
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -438,6 +438,12 @@ interface ListParticipantsResponse$1 {
|
|
|
438
438
|
* Picture URL of the [User](#schema_user)
|
|
439
439
|
*/
|
|
440
440
|
pictureUrl?: string;
|
|
441
|
+
/**
|
|
442
|
+
* Optional attributes
|
|
443
|
+
*/
|
|
444
|
+
attributes?: {
|
|
445
|
+
[k: string]: string;
|
|
446
|
+
};
|
|
441
447
|
}[];
|
|
442
448
|
meta: {
|
|
443
449
|
/**
|
|
@@ -492,6 +498,12 @@ interface AddParticipantResponse$1 {
|
|
|
492
498
|
* Picture URL of the [User](#schema_user)
|
|
493
499
|
*/
|
|
494
500
|
pictureUrl?: string;
|
|
501
|
+
/**
|
|
502
|
+
* Optional attributes
|
|
503
|
+
*/
|
|
504
|
+
attributes?: {
|
|
505
|
+
[k: string]: string;
|
|
506
|
+
};
|
|
495
507
|
};
|
|
496
508
|
}
|
|
497
509
|
|
|
@@ -537,6 +549,12 @@ interface GetParticipantResponse$1 {
|
|
|
537
549
|
* Picture URL of the [User](#schema_user)
|
|
538
550
|
*/
|
|
539
551
|
pictureUrl?: string;
|
|
552
|
+
/**
|
|
553
|
+
* Optional attributes
|
|
554
|
+
*/
|
|
555
|
+
attributes?: {
|
|
556
|
+
[k: string]: string;
|
|
557
|
+
};
|
|
540
558
|
};
|
|
541
559
|
}
|
|
542
560
|
|
|
@@ -1223,6 +1241,12 @@ interface InitializeIncomingMessageRequestBody$1 {
|
|
|
1223
1241
|
* URI of the user picture
|
|
1224
1242
|
*/
|
|
1225
1243
|
pictureUrl?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* Optional attributes
|
|
1246
|
+
*/
|
|
1247
|
+
attributes?: {
|
|
1248
|
+
[k: string]: string;
|
|
1249
|
+
};
|
|
1226
1250
|
/**
|
|
1227
1251
|
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1228
1252
|
*/
|
|
@@ -1306,6 +1330,12 @@ interface InitializeIncomingMessageResponse$1 {
|
|
|
1306
1330
|
* Picture URL of the [User](#schema_user)
|
|
1307
1331
|
*/
|
|
1308
1332
|
pictureUrl?: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* Optional attributes
|
|
1335
|
+
*/
|
|
1336
|
+
attributes?: {
|
|
1337
|
+
[k: string]: string;
|
|
1338
|
+
};
|
|
1309
1339
|
};
|
|
1310
1340
|
/**
|
|
1311
1341
|
* The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
|
|
@@ -1518,6 +1548,12 @@ interface CreateUserRequestBody$1 {
|
|
|
1518
1548
|
* URI of the user picture
|
|
1519
1549
|
*/
|
|
1520
1550
|
pictureUrl?: string;
|
|
1551
|
+
/**
|
|
1552
|
+
* Optional attributes
|
|
1553
|
+
*/
|
|
1554
|
+
attributes?: {
|
|
1555
|
+
[k: string]: string;
|
|
1556
|
+
};
|
|
1521
1557
|
}
|
|
1522
1558
|
type CreateUserInput$1 = CreateUserRequestBody$1 & CreateUserRequestHeaders$1 & CreateUserRequestQuery$1 & CreateUserRequestParams$1;
|
|
1523
1559
|
interface CreateUserResponse$1 {
|
|
@@ -1551,6 +1587,12 @@ interface CreateUserResponse$1 {
|
|
|
1551
1587
|
* Picture URL of the [User](#schema_user)
|
|
1552
1588
|
*/
|
|
1553
1589
|
pictureUrl?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* Optional attributes
|
|
1592
|
+
*/
|
|
1593
|
+
attributes?: {
|
|
1594
|
+
[k: string]: string;
|
|
1595
|
+
};
|
|
1554
1596
|
};
|
|
1555
1597
|
}
|
|
1556
1598
|
|
|
@@ -1595,6 +1637,12 @@ interface GetUserResponse$1 {
|
|
|
1595
1637
|
* Picture URL of the [User](#schema_user)
|
|
1596
1638
|
*/
|
|
1597
1639
|
pictureUrl?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Optional attributes
|
|
1642
|
+
*/
|
|
1643
|
+
attributes?: {
|
|
1644
|
+
[k: string]: string;
|
|
1645
|
+
};
|
|
1598
1646
|
};
|
|
1599
1647
|
}
|
|
1600
1648
|
|
|
@@ -1645,6 +1693,12 @@ interface ListUsersResponse$1 {
|
|
|
1645
1693
|
* Picture URL of the [User](#schema_user)
|
|
1646
1694
|
*/
|
|
1647
1695
|
pictureUrl?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* Optional attributes
|
|
1698
|
+
*/
|
|
1699
|
+
attributes?: {
|
|
1700
|
+
[k: string]: string;
|
|
1701
|
+
};
|
|
1648
1702
|
}[];
|
|
1649
1703
|
meta: {
|
|
1650
1704
|
/**
|
|
@@ -1680,6 +1734,12 @@ interface GetOrCreateUserRequestBody$1 {
|
|
|
1680
1734
|
* URI of the user picture
|
|
1681
1735
|
*/
|
|
1682
1736
|
pictureUrl?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* Optional attributes
|
|
1739
|
+
*/
|
|
1740
|
+
attributes?: {
|
|
1741
|
+
[k: string]: string;
|
|
1742
|
+
};
|
|
1683
1743
|
/**
|
|
1684
1744
|
* Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1685
1745
|
*/
|
|
@@ -1717,6 +1777,12 @@ interface GetOrCreateUserResponse$1 {
|
|
|
1717
1777
|
* Picture URL of the [User](#schema_user)
|
|
1718
1778
|
*/
|
|
1719
1779
|
pictureUrl?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Optional attributes
|
|
1782
|
+
*/
|
|
1783
|
+
attributes?: {
|
|
1784
|
+
[k: string]: string;
|
|
1785
|
+
};
|
|
1720
1786
|
};
|
|
1721
1787
|
}
|
|
1722
1788
|
|
|
@@ -1742,6 +1808,12 @@ interface UpdateUserRequestBody$1 {
|
|
|
1742
1808
|
* URI of the user picture
|
|
1743
1809
|
*/
|
|
1744
1810
|
pictureUrl?: string | null;
|
|
1811
|
+
/**
|
|
1812
|
+
* Optional attributes. Set attributes to null to remove them
|
|
1813
|
+
*/
|
|
1814
|
+
attributes?: {
|
|
1815
|
+
[k: string]: string | null;
|
|
1816
|
+
};
|
|
1745
1817
|
}
|
|
1746
1818
|
type UpdateUserInput$1 = UpdateUserRequestBody$1 & UpdateUserRequestHeaders$1 & UpdateUserRequestQuery$1 & UpdateUserRequestParams$1;
|
|
1747
1819
|
interface UpdateUserResponse$1 {
|
|
@@ -1775,6 +1847,12 @@ interface UpdateUserResponse$1 {
|
|
|
1775
1847
|
* Picture URL of the [User](#schema_user)
|
|
1776
1848
|
*/
|
|
1777
1849
|
pictureUrl?: string;
|
|
1850
|
+
/**
|
|
1851
|
+
* Optional attributes
|
|
1852
|
+
*/
|
|
1853
|
+
attributes?: {
|
|
1854
|
+
[k: string]: string;
|
|
1855
|
+
};
|
|
1778
1856
|
};
|
|
1779
1857
|
}
|
|
1780
1858
|
|
|
@@ -3303,6 +3381,9 @@ declare class Client$a extends Client$b {
|
|
|
3303
3381
|
};
|
|
3304
3382
|
name?: string;
|
|
3305
3383
|
pictureUrl?: string;
|
|
3384
|
+
attributes?: {
|
|
3385
|
+
[k: string]: string;
|
|
3386
|
+
};
|
|
3306
3387
|
}>;
|
|
3307
3388
|
events: (props: {
|
|
3308
3389
|
status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
|
|
@@ -3366,6 +3447,9 @@ declare class Client$a extends Client$b {
|
|
|
3366
3447
|
};
|
|
3367
3448
|
name?: string;
|
|
3368
3449
|
pictureUrl?: string;
|
|
3450
|
+
attributes?: {
|
|
3451
|
+
[k: string]: string;
|
|
3452
|
+
};
|
|
3369
3453
|
}>;
|
|
3370
3454
|
tasks: (props: {
|
|
3371
3455
|
status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
|
|
@@ -3752,6 +3836,10 @@ interface GetPublicIntegrationByIdResponse$1 {
|
|
|
3752
3836
|
* URL of the [Integration](#schema_integration)
|
|
3753
3837
|
*/
|
|
3754
3838
|
url: string;
|
|
3839
|
+
/**
|
|
3840
|
+
* 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.
|
|
3841
|
+
*/
|
|
3842
|
+
signingSecret: string;
|
|
3755
3843
|
/**
|
|
3756
3844
|
* Name of the [Integration](#schema_integration)
|
|
3757
3845
|
*/
|
|
@@ -4168,6 +4256,10 @@ interface GetPublicIntegrationResponse$1 {
|
|
|
4168
4256
|
* URL of the [Integration](#schema_integration)
|
|
4169
4257
|
*/
|
|
4170
4258
|
url: string;
|
|
4259
|
+
/**
|
|
4260
|
+
* 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.
|
|
4261
|
+
*/
|
|
4262
|
+
signingSecret: string;
|
|
4171
4263
|
/**
|
|
4172
4264
|
* Name of the [Integration](#schema_integration)
|
|
4173
4265
|
*/
|
|
@@ -5907,7 +5999,7 @@ interface CreateBotResponse$1 {
|
|
|
5907
5999
|
*/
|
|
5908
6000
|
updatedAt: string;
|
|
5909
6001
|
/**
|
|
5910
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
6002
|
+
* 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
6003
|
*/
|
|
5912
6004
|
signingSecret: string;
|
|
5913
6005
|
/**
|
|
@@ -6321,9 +6413,9 @@ interface UpdateBotRequestBody$1 {
|
|
|
6321
6413
|
*/
|
|
6322
6414
|
url?: string | null;
|
|
6323
6415
|
/**
|
|
6324
|
-
* Type of the [Bot](#schema_bot) authentication (`iam`)
|
|
6416
|
+
* Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)
|
|
6325
6417
|
*/
|
|
6326
|
-
authentication?: "iam";
|
|
6418
|
+
authentication?: "iam" | "hmac-sha256";
|
|
6327
6419
|
configuration?: {
|
|
6328
6420
|
/**
|
|
6329
6421
|
* Configuration data
|
|
@@ -6587,7 +6679,7 @@ interface UpdateBotResponse$1 {
|
|
|
6587
6679
|
*/
|
|
6588
6680
|
updatedAt: string;
|
|
6589
6681
|
/**
|
|
6590
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
6682
|
+
* 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
6683
|
*/
|
|
6592
6684
|
signingSecret: string;
|
|
6593
6685
|
/**
|
|
@@ -6988,6 +7080,23 @@ interface UpdateBotResponse$1 {
|
|
|
6988
7080
|
};
|
|
6989
7081
|
}
|
|
6990
7082
|
|
|
7083
|
+
interface RotateBotSigningSecretsRequestHeaders$1 {
|
|
7084
|
+
}
|
|
7085
|
+
interface RotateBotSigningSecretsRequestQuery$1 {
|
|
7086
|
+
}
|
|
7087
|
+
interface RotateBotSigningSecretsRequestParams$1 {
|
|
7088
|
+
id: string;
|
|
7089
|
+
}
|
|
7090
|
+
interface RotateBotSigningSecretsRequestBody$1 {
|
|
7091
|
+
}
|
|
7092
|
+
type RotateBotSigningSecretsInput$1 = RotateBotSigningSecretsRequestBody$1 & RotateBotSigningSecretsRequestHeaders$1 & RotateBotSigningSecretsRequestQuery$1 & RotateBotSigningSecretsRequestParams$1;
|
|
7093
|
+
interface RotateBotSigningSecretsResponse$1 {
|
|
7094
|
+
/**
|
|
7095
|
+
* 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.
|
|
7096
|
+
*/
|
|
7097
|
+
newSigningSecret: string;
|
|
7098
|
+
}
|
|
7099
|
+
|
|
6991
7100
|
interface TransferBotRequestHeaders$1 {
|
|
6992
7101
|
}
|
|
6993
7102
|
interface TransferBotRequestQuery$1 {
|
|
@@ -7078,7 +7187,7 @@ interface GetBotResponse$1 {
|
|
|
7078
7187
|
*/
|
|
7079
7188
|
updatedAt: string;
|
|
7080
7189
|
/**
|
|
7081
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
7190
|
+
* 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
7191
|
*/
|
|
7083
7192
|
signingSecret: string;
|
|
7084
7193
|
/**
|
|
@@ -8546,7 +8655,7 @@ interface GetAuditRecordsResponse$1 {
|
|
|
8546
8655
|
resourceId: string | null;
|
|
8547
8656
|
resourceName?: string | null;
|
|
8548
8657
|
value?: string | null;
|
|
8549
|
-
action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
|
|
8658
|
+
action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
|
|
8550
8659
|
}[];
|
|
8551
8660
|
meta: {
|
|
8552
8661
|
/**
|
|
@@ -9130,6 +9239,10 @@ interface CreateIntegrationResponse$1 {
|
|
|
9130
9239
|
* URL of the [Integration](#schema_integration)
|
|
9131
9240
|
*/
|
|
9132
9241
|
url: string;
|
|
9242
|
+
/**
|
|
9243
|
+
* 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.
|
|
9244
|
+
*/
|
|
9245
|
+
signingSecret: string;
|
|
9133
9246
|
/**
|
|
9134
9247
|
* Name of the [Integration](#schema_integration)
|
|
9135
9248
|
*/
|
|
@@ -10210,6 +10323,10 @@ interface UpdateIntegrationResponse$1 {
|
|
|
10210
10323
|
* URL of the [Integration](#schema_integration)
|
|
10211
10324
|
*/
|
|
10212
10325
|
url: string;
|
|
10326
|
+
/**
|
|
10327
|
+
* 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.
|
|
10328
|
+
*/
|
|
10329
|
+
signingSecret: string;
|
|
10213
10330
|
/**
|
|
10214
10331
|
* Name of the [Integration](#schema_integration)
|
|
10215
10332
|
*/
|
|
@@ -10561,6 +10678,23 @@ interface UpdateIntegrationResponse$1 {
|
|
|
10561
10678
|
};
|
|
10562
10679
|
}
|
|
10563
10680
|
|
|
10681
|
+
interface RotateIntegrationSigningSecretsRequestHeaders$1 {
|
|
10682
|
+
}
|
|
10683
|
+
interface RotateIntegrationSigningSecretsRequestQuery$1 {
|
|
10684
|
+
}
|
|
10685
|
+
interface RotateIntegrationSigningSecretsRequestParams$1 {
|
|
10686
|
+
id: string;
|
|
10687
|
+
}
|
|
10688
|
+
interface RotateIntegrationSigningSecretsRequestBody$1 {
|
|
10689
|
+
}
|
|
10690
|
+
type RotateIntegrationSigningSecretsInput$1 = RotateIntegrationSigningSecretsRequestBody$1 & RotateIntegrationSigningSecretsRequestHeaders$1 & RotateIntegrationSigningSecretsRequestQuery$1 & RotateIntegrationSigningSecretsRequestParams$1;
|
|
10691
|
+
interface RotateIntegrationSigningSecretsResponse$1 {
|
|
10692
|
+
/**
|
|
10693
|
+
* 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.
|
|
10694
|
+
*/
|
|
10695
|
+
newSigningSecret: string;
|
|
10696
|
+
}
|
|
10697
|
+
|
|
10564
10698
|
interface ValidateIntegrationUpdateRequestHeaders$1 {
|
|
10565
10699
|
}
|
|
10566
10700
|
interface ValidateIntegrationUpdateRequestQuery$1 {
|
|
@@ -11065,6 +11199,10 @@ interface GetIntegrationResponse$1 {
|
|
|
11065
11199
|
* URL of the [Integration](#schema_integration)
|
|
11066
11200
|
*/
|
|
11067
11201
|
url: string;
|
|
11202
|
+
/**
|
|
11203
|
+
* 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.
|
|
11204
|
+
*/
|
|
11205
|
+
signingSecret: string;
|
|
11068
11206
|
/**
|
|
11069
11207
|
* Name of the [Integration](#schema_integration)
|
|
11070
11208
|
*/
|
|
@@ -11501,6 +11639,10 @@ interface GetIntegrationByNameResponse$1 {
|
|
|
11501
11639
|
* URL of the [Integration](#schema_integration)
|
|
11502
11640
|
*/
|
|
11503
11641
|
url: string;
|
|
11642
|
+
/**
|
|
11643
|
+
* 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.
|
|
11644
|
+
*/
|
|
11645
|
+
signingSecret: string;
|
|
11504
11646
|
/**
|
|
11505
11647
|
* Name of the [Integration](#schema_integration)
|
|
11506
11648
|
*/
|
|
@@ -14777,6 +14919,7 @@ declare class Client$9 {
|
|
|
14777
14919
|
readonly getPublicInterface: (input: GetPublicInterfaceInput$1) => Promise<GetPublicInterfaceResponse$1>;
|
|
14778
14920
|
readonly createBot: (input: CreateBotInput$1) => Promise<CreateBotResponse$1>;
|
|
14779
14921
|
readonly updateBot: (input: UpdateBotInput$1) => Promise<UpdateBotResponse$1>;
|
|
14922
|
+
readonly rotateBotSigningSecrets: (input: RotateBotSigningSecretsInput$1) => Promise<RotateBotSigningSecretsResponse$1>;
|
|
14780
14923
|
readonly transferBot: (input: TransferBotInput$1) => Promise<TransferBotResponse$1>;
|
|
14781
14924
|
readonly listBots: (input: ListBotsInput$1) => Promise<ListBotsResponse$1>;
|
|
14782
14925
|
readonly getBot: (input: GetBotInput$1) => Promise<GetBotResponse$1>;
|
|
@@ -14834,6 +14977,7 @@ declare class Client$9 {
|
|
|
14834
14977
|
readonly createIntegration: (input: CreateIntegrationInput$1) => Promise<CreateIntegrationResponse$1>;
|
|
14835
14978
|
readonly validateIntegrationCreation: (input: ValidateIntegrationCreationInput$1) => Promise<ValidateIntegrationCreationResponse$1>;
|
|
14836
14979
|
readonly updateIntegration: (input: UpdateIntegrationInput$1) => Promise<UpdateIntegrationResponse$1>;
|
|
14980
|
+
readonly rotateIntegrationSigningSecrets: (input: RotateIntegrationSigningSecretsInput$1) => Promise<RotateIntegrationSigningSecretsResponse$1>;
|
|
14837
14981
|
readonly validateIntegrationUpdate: (input: ValidateIntegrationUpdateInput$1) => Promise<ValidateIntegrationUpdateResponse$1>;
|
|
14838
14982
|
readonly listIntegrations: (input: ListIntegrationsInput$1) => Promise<ListIntegrationsResponse$1>;
|
|
14839
14983
|
readonly getIntegration: (input: GetIntegrationInput$1) => Promise<GetIntegrationResponse$1>;
|
|
@@ -15100,7 +15244,46 @@ interface GetBillingReadonlyRequestBody {
|
|
|
15100
15244
|
}
|
|
15101
15245
|
type GetBillingReadonlyInput = GetBillingReadonlyRequestBody & GetBillingReadonlyRequestHeaders & GetBillingReadonlyRequestQuery & GetBillingReadonlyRequestParams;
|
|
15102
15246
|
interface GetBillingReadonlyResponse {
|
|
15103
|
-
|
|
15247
|
+
planReadonly: boolean;
|
|
15248
|
+
addonsReadonly: boolean;
|
|
15249
|
+
}
|
|
15250
|
+
|
|
15251
|
+
interface GetBillingAddressRequestHeaders {
|
|
15252
|
+
}
|
|
15253
|
+
interface GetBillingAddressRequestQuery {
|
|
15254
|
+
}
|
|
15255
|
+
interface GetBillingAddressRequestParams {
|
|
15256
|
+
}
|
|
15257
|
+
interface GetBillingAddressRequestBody {
|
|
15258
|
+
}
|
|
15259
|
+
type GetBillingAddressInput = GetBillingAddressRequestBody & GetBillingAddressRequestHeaders & GetBillingAddressRequestQuery & GetBillingAddressRequestParams;
|
|
15260
|
+
interface GetBillingAddressResponse {
|
|
15261
|
+
address: {
|
|
15262
|
+
lineOne?: string;
|
|
15263
|
+
lineTwo?: string;
|
|
15264
|
+
city?: string;
|
|
15265
|
+
state?: string;
|
|
15266
|
+
postalCode?: string;
|
|
15267
|
+
country?: string;
|
|
15268
|
+
} | null;
|
|
15269
|
+
}
|
|
15270
|
+
|
|
15271
|
+
interface SetBillingAddressRequestHeaders {
|
|
15272
|
+
}
|
|
15273
|
+
interface SetBillingAddressRequestQuery {
|
|
15274
|
+
}
|
|
15275
|
+
interface SetBillingAddressRequestParams {
|
|
15276
|
+
}
|
|
15277
|
+
interface SetBillingAddressRequestBody {
|
|
15278
|
+
lineOne?: string;
|
|
15279
|
+
lineTwo?: string;
|
|
15280
|
+
city?: string;
|
|
15281
|
+
state?: string;
|
|
15282
|
+
postalCode?: string;
|
|
15283
|
+
country?: string;
|
|
15284
|
+
}
|
|
15285
|
+
type SetBillingAddressInput = SetBillingAddressRequestBody & SetBillingAddressRequestHeaders & SetBillingAddressRequestQuery & SetBillingAddressRequestParams;
|
|
15286
|
+
interface SetBillingAddressResponse {
|
|
15104
15287
|
}
|
|
15105
15288
|
|
|
15106
15289
|
interface GetPlanRequestHeaders {
|
|
@@ -15211,62 +15394,16 @@ interface GetAddonResponse {
|
|
|
15211
15394
|
};
|
|
15212
15395
|
}
|
|
15213
15396
|
|
|
15214
|
-
interface
|
|
15215
|
-
}
|
|
15216
|
-
interface GetCurrentSubscriptionRequestQuery {
|
|
15217
|
-
}
|
|
15218
|
-
interface GetCurrentSubscriptionRequestParams {
|
|
15219
|
-
}
|
|
15220
|
-
interface GetCurrentSubscriptionRequestBody {
|
|
15221
|
-
}
|
|
15222
|
-
type GetCurrentSubscriptionInput = GetCurrentSubscriptionRequestBody & GetCurrentSubscriptionRequestHeaders & GetCurrentSubscriptionRequestQuery & GetCurrentSubscriptionRequestParams;
|
|
15223
|
-
interface GetCurrentSubscriptionResponse {
|
|
15224
|
-
plan: {
|
|
15225
|
-
current: {
|
|
15226
|
-
status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
|
|
15227
|
-
planId: string;
|
|
15228
|
-
interval: "month" | "year";
|
|
15229
|
-
price: number;
|
|
15230
|
-
proratedPrice?: number;
|
|
15231
|
-
cancelAtPeriodEnd: boolean;
|
|
15232
|
-
periodEnd: string;
|
|
15233
|
-
};
|
|
15234
|
-
next: {
|
|
15235
|
-
planId: string;
|
|
15236
|
-
interval: "month" | "year";
|
|
15237
|
-
price: number | null;
|
|
15238
|
-
effectiveDate: string;
|
|
15239
|
-
} | null;
|
|
15240
|
-
};
|
|
15241
|
-
addons: {
|
|
15242
|
-
[k: string]: {
|
|
15243
|
-
current: {
|
|
15244
|
-
quantity: number;
|
|
15245
|
-
price: number;
|
|
15246
|
-
proratedPrice?: number;
|
|
15247
|
-
};
|
|
15248
|
-
next: {
|
|
15249
|
-
quantity: number;
|
|
15250
|
-
price: number;
|
|
15251
|
-
effectiveDate: string;
|
|
15252
|
-
} | null;
|
|
15253
|
-
};
|
|
15254
|
-
};
|
|
15255
|
-
yearlyTotal: number;
|
|
15256
|
-
monthlyTotal: number;
|
|
15257
|
-
proratedTotal: number;
|
|
15258
|
-
}
|
|
15259
|
-
|
|
15260
|
-
interface GetNextSubscriptionRequestHeaders {
|
|
15397
|
+
interface GetSubscriptionRequestHeaders {
|
|
15261
15398
|
}
|
|
15262
|
-
interface
|
|
15399
|
+
interface GetSubscriptionRequestQuery {
|
|
15263
15400
|
}
|
|
15264
|
-
interface
|
|
15401
|
+
interface GetSubscriptionRequestParams {
|
|
15265
15402
|
}
|
|
15266
|
-
interface
|
|
15403
|
+
interface GetSubscriptionRequestBody {
|
|
15267
15404
|
}
|
|
15268
|
-
type
|
|
15269
|
-
interface
|
|
15405
|
+
type GetSubscriptionInput = GetSubscriptionRequestBody & GetSubscriptionRequestHeaders & GetSubscriptionRequestQuery & GetSubscriptionRequestParams;
|
|
15406
|
+
interface GetSubscriptionResponse {
|
|
15270
15407
|
plan: {
|
|
15271
15408
|
current: {
|
|
15272
15409
|
status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
|
|
@@ -15298,9 +15435,6 @@ interface GetNextSubscriptionResponse {
|
|
|
15298
15435
|
} | null;
|
|
15299
15436
|
};
|
|
15300
15437
|
};
|
|
15301
|
-
yearlyTotal: number;
|
|
15302
|
-
monthlyTotal: number;
|
|
15303
|
-
proratedTotal: number;
|
|
15304
15438
|
}
|
|
15305
15439
|
|
|
15306
15440
|
interface PreviewSubscriptionUpdateRequestHeaders {
|
|
@@ -15440,9 +15574,6 @@ interface SetPlanResponse {
|
|
|
15440
15574
|
} | null;
|
|
15441
15575
|
};
|
|
15442
15576
|
};
|
|
15443
|
-
yearlyTotal: number;
|
|
15444
|
-
monthlyTotal: number;
|
|
15445
|
-
proratedTotal: number;
|
|
15446
15577
|
}
|
|
15447
15578
|
|
|
15448
15579
|
interface SetAddonsRequestHeaders {
|
|
@@ -15495,9 +15626,205 @@ interface SetAddonsResponse {
|
|
|
15495
15626
|
} | null;
|
|
15496
15627
|
};
|
|
15497
15628
|
};
|
|
15498
|
-
|
|
15499
|
-
|
|
15500
|
-
|
|
15629
|
+
}
|
|
15630
|
+
|
|
15631
|
+
interface SetCancelAtPeriodEndRequestHeaders {
|
|
15632
|
+
}
|
|
15633
|
+
interface SetCancelAtPeriodEndRequestQuery {
|
|
15634
|
+
}
|
|
15635
|
+
interface SetCancelAtPeriodEndRequestParams {
|
|
15636
|
+
}
|
|
15637
|
+
interface SetCancelAtPeriodEndRequestBody {
|
|
15638
|
+
cancelAtPeriodEnd: boolean;
|
|
15639
|
+
}
|
|
15640
|
+
type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPeriodEndRequestHeaders & SetCancelAtPeriodEndRequestQuery & SetCancelAtPeriodEndRequestParams;
|
|
15641
|
+
/**
|
|
15642
|
+
* Subscription details including current plan, addons, and costs
|
|
15643
|
+
*/
|
|
15644
|
+
interface SetCancelAtPeriodEndResponse {
|
|
15645
|
+
plan: {
|
|
15646
|
+
current: {
|
|
15647
|
+
status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
|
|
15648
|
+
planId: string;
|
|
15649
|
+
interval: "month" | "year";
|
|
15650
|
+
price: number;
|
|
15651
|
+
proratedPrice?: number;
|
|
15652
|
+
cancelAtPeriodEnd: boolean;
|
|
15653
|
+
periodEnd: string;
|
|
15654
|
+
};
|
|
15655
|
+
next: {
|
|
15656
|
+
planId: string;
|
|
15657
|
+
interval: "month" | "year";
|
|
15658
|
+
price: number | null;
|
|
15659
|
+
effectiveDate: string;
|
|
15660
|
+
} | null;
|
|
15661
|
+
};
|
|
15662
|
+
addons: {
|
|
15663
|
+
[k: string]: {
|
|
15664
|
+
current: {
|
|
15665
|
+
quantity: number;
|
|
15666
|
+
price: number;
|
|
15667
|
+
proratedPrice?: number;
|
|
15668
|
+
};
|
|
15669
|
+
next: {
|
|
15670
|
+
quantity: number;
|
|
15671
|
+
price: number;
|
|
15672
|
+
effectiveDate: string;
|
|
15673
|
+
} | null;
|
|
15674
|
+
};
|
|
15675
|
+
};
|
|
15676
|
+
}
|
|
15677
|
+
|
|
15678
|
+
interface GetAutoRechargeSettingsRequestHeaders {
|
|
15679
|
+
}
|
|
15680
|
+
interface GetAutoRechargeSettingsRequestQuery {
|
|
15681
|
+
}
|
|
15682
|
+
interface GetAutoRechargeSettingsRequestParams {
|
|
15683
|
+
}
|
|
15684
|
+
interface GetAutoRechargeSettingsRequestBody {
|
|
15685
|
+
}
|
|
15686
|
+
type GetAutoRechargeSettingsInput = GetAutoRechargeSettingsRequestBody & GetAutoRechargeSettingsRequestHeaders & GetAutoRechargeSettingsRequestQuery & GetAutoRechargeSettingsRequestParams;
|
|
15687
|
+
interface GetAutoRechargeSettingsResponse {
|
|
15688
|
+
settings: {
|
|
15689
|
+
table_row_count: {
|
|
15690
|
+
enabled: boolean;
|
|
15691
|
+
threshold?: number;
|
|
15692
|
+
limit?: number;
|
|
15693
|
+
disabledReason?: string;
|
|
15694
|
+
};
|
|
15695
|
+
invocation_calls: {
|
|
15696
|
+
enabled: boolean;
|
|
15697
|
+
threshold?: number;
|
|
15698
|
+
limit?: number;
|
|
15699
|
+
disabledReason?: string;
|
|
15700
|
+
};
|
|
15701
|
+
knowledgebase_vector_storage: {
|
|
15702
|
+
enabled: boolean;
|
|
15703
|
+
threshold?: number;
|
|
15704
|
+
limit?: number;
|
|
15705
|
+
disabledReason?: string;
|
|
15706
|
+
};
|
|
15707
|
+
storage_count: {
|
|
15708
|
+
enabled: boolean;
|
|
15709
|
+
threshold?: number;
|
|
15710
|
+
limit?: number;
|
|
15711
|
+
disabledReason?: string;
|
|
15712
|
+
};
|
|
15713
|
+
};
|
|
15714
|
+
}
|
|
15715
|
+
|
|
15716
|
+
interface SetAutoRechargeSettingsRequestHeaders {
|
|
15717
|
+
}
|
|
15718
|
+
interface SetAutoRechargeSettingsRequestQuery {
|
|
15719
|
+
}
|
|
15720
|
+
interface SetAutoRechargeSettingsRequestParams {
|
|
15721
|
+
}
|
|
15722
|
+
interface SetAutoRechargeSettingsRequestBody {
|
|
15723
|
+
settings: {
|
|
15724
|
+
table_row_count?: {
|
|
15725
|
+
enabled: boolean;
|
|
15726
|
+
threshold?: number;
|
|
15727
|
+
limit?: number;
|
|
15728
|
+
disabledReason?: string;
|
|
15729
|
+
};
|
|
15730
|
+
invocation_calls?: {
|
|
15731
|
+
enabled: boolean;
|
|
15732
|
+
threshold?: number;
|
|
15733
|
+
limit?: number;
|
|
15734
|
+
disabledReason?: string;
|
|
15735
|
+
};
|
|
15736
|
+
knowledgebase_vector_storage?: {
|
|
15737
|
+
enabled: boolean;
|
|
15738
|
+
threshold?: number;
|
|
15739
|
+
limit?: number;
|
|
15740
|
+
disabledReason?: string;
|
|
15741
|
+
};
|
|
15742
|
+
storage_count?: {
|
|
15743
|
+
enabled: boolean;
|
|
15744
|
+
threshold?: number;
|
|
15745
|
+
limit?: number;
|
|
15746
|
+
disabledReason?: string;
|
|
15747
|
+
};
|
|
15748
|
+
};
|
|
15749
|
+
}
|
|
15750
|
+
type SetAutoRechargeSettingsInput = SetAutoRechargeSettingsRequestBody & SetAutoRechargeSettingsRequestHeaders & SetAutoRechargeSettingsRequestQuery & SetAutoRechargeSettingsRequestParams;
|
|
15751
|
+
interface SetAutoRechargeSettingsResponse {
|
|
15752
|
+
settings: {
|
|
15753
|
+
table_row_count: {
|
|
15754
|
+
enabled: boolean;
|
|
15755
|
+
threshold?: number;
|
|
15756
|
+
limit?: number;
|
|
15757
|
+
disabledReason?: string;
|
|
15758
|
+
};
|
|
15759
|
+
invocation_calls: {
|
|
15760
|
+
enabled: boolean;
|
|
15761
|
+
threshold?: number;
|
|
15762
|
+
limit?: number;
|
|
15763
|
+
disabledReason?: string;
|
|
15764
|
+
};
|
|
15765
|
+
knowledgebase_vector_storage: {
|
|
15766
|
+
enabled: boolean;
|
|
15767
|
+
threshold?: number;
|
|
15768
|
+
limit?: number;
|
|
15769
|
+
disabledReason?: string;
|
|
15770
|
+
};
|
|
15771
|
+
storage_count: {
|
|
15772
|
+
enabled: boolean;
|
|
15773
|
+
threshold?: number;
|
|
15774
|
+
limit?: number;
|
|
15775
|
+
disabledReason?: string;
|
|
15776
|
+
};
|
|
15777
|
+
};
|
|
15778
|
+
}
|
|
15779
|
+
|
|
15780
|
+
interface GetTrialsRequestHeaders {
|
|
15781
|
+
}
|
|
15782
|
+
interface GetTrialsRequestQuery {
|
|
15783
|
+
}
|
|
15784
|
+
interface GetTrialsRequestParams {
|
|
15785
|
+
}
|
|
15786
|
+
interface GetTrialsRequestBody {
|
|
15787
|
+
}
|
|
15788
|
+
type GetTrialsInput = GetTrialsRequestBody & GetTrialsRequestHeaders & GetTrialsRequestQuery & GetTrialsRequestParams;
|
|
15789
|
+
interface GetTrialsResponse {
|
|
15790
|
+
trials: {
|
|
15791
|
+
id: string;
|
|
15792
|
+
trialPlan: string;
|
|
15793
|
+
fromPlan: string;
|
|
15794
|
+
endsAt: string;
|
|
15795
|
+
isActive: boolean;
|
|
15796
|
+
}[];
|
|
15797
|
+
}
|
|
15798
|
+
|
|
15799
|
+
interface CreateTrialRequestHeaders {
|
|
15800
|
+
}
|
|
15801
|
+
interface CreateTrialRequestQuery {
|
|
15802
|
+
}
|
|
15803
|
+
interface CreateTrialRequestParams {
|
|
15804
|
+
}
|
|
15805
|
+
interface CreateTrialRequestBody {
|
|
15806
|
+
lengthInDays: number;
|
|
15807
|
+
plan: string;
|
|
15808
|
+
}
|
|
15809
|
+
type CreateTrialInput = CreateTrialRequestBody & CreateTrialRequestHeaders & CreateTrialRequestQuery & CreateTrialRequestParams;
|
|
15810
|
+
interface CreateTrialResponse {
|
|
15811
|
+
id: string;
|
|
15812
|
+
trialPlan: string;
|
|
15813
|
+
fromPlan: string;
|
|
15814
|
+
endsAt: string;
|
|
15815
|
+
isActive: boolean;
|
|
15816
|
+
}
|
|
15817
|
+
|
|
15818
|
+
interface RemoveTrialRequestHeaders {
|
|
15819
|
+
}
|
|
15820
|
+
interface RemoveTrialRequestQuery {
|
|
15821
|
+
}
|
|
15822
|
+
interface RemoveTrialRequestParams {
|
|
15823
|
+
}
|
|
15824
|
+
interface RemoveTrialRequestBody {
|
|
15825
|
+
}
|
|
15826
|
+
type RemoveTrialInput = RemoveTrialRequestBody & RemoveTrialRequestHeaders & RemoveTrialRequestQuery & RemoveTrialRequestParams;
|
|
15827
|
+
interface RemoveTrialResponse {
|
|
15501
15828
|
}
|
|
15502
15829
|
|
|
15503
15830
|
interface ListInvoicesRequestHeaders {
|
|
@@ -15634,15 +15961,22 @@ declare class Client$7 {
|
|
|
15634
15961
|
private props;
|
|
15635
15962
|
constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps$7>);
|
|
15636
15963
|
readonly getBillingReadonly: (input: GetBillingReadonlyInput) => Promise<GetBillingReadonlyResponse>;
|
|
15964
|
+
readonly getBillingAddress: (input: GetBillingAddressInput) => Promise<GetBillingAddressResponse>;
|
|
15965
|
+
readonly setBillingAddress: (input: SetBillingAddressInput) => Promise<SetBillingAddressResponse>;
|
|
15637
15966
|
readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse$1>;
|
|
15638
15967
|
readonly listPlans: (input: ListPlansInput) => Promise<ListPlansResponse>;
|
|
15639
15968
|
readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse$1>;
|
|
15640
15969
|
readonly listAddons: (input: ListAddonsInput) => Promise<ListAddonsResponse>;
|
|
15641
|
-
readonly
|
|
15642
|
-
readonly getNextSubscription: (input: GetNextSubscriptionInput) => Promise<GetNextSubscriptionResponse>;
|
|
15970
|
+
readonly getSubscription: (input: GetSubscriptionInput) => Promise<GetSubscriptionResponse>;
|
|
15643
15971
|
readonly previewSubscriptionUpdate: (input: PreviewSubscriptionUpdateInput) => Promise<PreviewSubscriptionUpdateResponse>;
|
|
15644
15972
|
readonly setPlan: (input: SetPlanInput) => Promise<SetPlanResponse>;
|
|
15645
15973
|
readonly setAddons: (input: SetAddonsInput) => Promise<SetAddonsResponse>;
|
|
15974
|
+
readonly setCancelAtPeriodEnd: (input: SetCancelAtPeriodEndInput) => Promise<SetCancelAtPeriodEndResponse>;
|
|
15975
|
+
readonly getAutoRechargeSettings: (input: GetAutoRechargeSettingsInput) => Promise<GetAutoRechargeSettingsResponse>;
|
|
15976
|
+
readonly setAutoRechargeSettings: (input: SetAutoRechargeSettingsInput) => Promise<SetAutoRechargeSettingsResponse>;
|
|
15977
|
+
readonly getTrials: (input: GetTrialsInput) => Promise<GetTrialsResponse>;
|
|
15978
|
+
readonly createTrial: (input: CreateTrialInput) => Promise<CreateTrialResponse>;
|
|
15979
|
+
readonly removeTrial: (input: RemoveTrialInput) => Promise<RemoveTrialResponse>;
|
|
15646
15980
|
readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
|
|
15647
15981
|
readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
|
|
15648
15982
|
readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
|
|
@@ -19022,6 +19356,12 @@ interface ListParticipantsResponse {
|
|
|
19022
19356
|
* Picture URL of the [User](#schema_user)
|
|
19023
19357
|
*/
|
|
19024
19358
|
pictureUrl?: string;
|
|
19359
|
+
/**
|
|
19360
|
+
* Optional attributes
|
|
19361
|
+
*/
|
|
19362
|
+
attributes?: {
|
|
19363
|
+
[k: string]: string;
|
|
19364
|
+
};
|
|
19025
19365
|
}[];
|
|
19026
19366
|
meta: {
|
|
19027
19367
|
/**
|
|
@@ -19076,6 +19416,12 @@ interface AddParticipantResponse {
|
|
|
19076
19416
|
* Picture URL of the [User](#schema_user)
|
|
19077
19417
|
*/
|
|
19078
19418
|
pictureUrl?: string;
|
|
19419
|
+
/**
|
|
19420
|
+
* Optional attributes
|
|
19421
|
+
*/
|
|
19422
|
+
attributes?: {
|
|
19423
|
+
[k: string]: string;
|
|
19424
|
+
};
|
|
19079
19425
|
};
|
|
19080
19426
|
}
|
|
19081
19427
|
|
|
@@ -19121,6 +19467,12 @@ interface GetParticipantResponse {
|
|
|
19121
19467
|
* Picture URL of the [User](#schema_user)
|
|
19122
19468
|
*/
|
|
19123
19469
|
pictureUrl?: string;
|
|
19470
|
+
/**
|
|
19471
|
+
* Optional attributes
|
|
19472
|
+
*/
|
|
19473
|
+
attributes?: {
|
|
19474
|
+
[k: string]: string;
|
|
19475
|
+
};
|
|
19124
19476
|
};
|
|
19125
19477
|
}
|
|
19126
19478
|
|
|
@@ -19807,6 +20159,12 @@ interface InitializeIncomingMessageRequestBody {
|
|
|
19807
20159
|
* URI of the user picture
|
|
19808
20160
|
*/
|
|
19809
20161
|
pictureUrl?: string;
|
|
20162
|
+
/**
|
|
20163
|
+
* Optional attributes
|
|
20164
|
+
*/
|
|
20165
|
+
attributes?: {
|
|
20166
|
+
[k: string]: string;
|
|
20167
|
+
};
|
|
19810
20168
|
/**
|
|
19811
20169
|
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
19812
20170
|
*/
|
|
@@ -19890,6 +20248,12 @@ interface InitializeIncomingMessageResponse {
|
|
|
19890
20248
|
* Picture URL of the [User](#schema_user)
|
|
19891
20249
|
*/
|
|
19892
20250
|
pictureUrl?: string;
|
|
20251
|
+
/**
|
|
20252
|
+
* Optional attributes
|
|
20253
|
+
*/
|
|
20254
|
+
attributes?: {
|
|
20255
|
+
[k: string]: string;
|
|
20256
|
+
};
|
|
19893
20257
|
};
|
|
19894
20258
|
/**
|
|
19895
20259
|
* The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
|
|
@@ -20102,6 +20466,12 @@ interface CreateUserRequestBody {
|
|
|
20102
20466
|
* URI of the user picture
|
|
20103
20467
|
*/
|
|
20104
20468
|
pictureUrl?: string;
|
|
20469
|
+
/**
|
|
20470
|
+
* Optional attributes
|
|
20471
|
+
*/
|
|
20472
|
+
attributes?: {
|
|
20473
|
+
[k: string]: string;
|
|
20474
|
+
};
|
|
20105
20475
|
}
|
|
20106
20476
|
type CreateUserInput = CreateUserRequestBody & CreateUserRequestHeaders & CreateUserRequestQuery & CreateUserRequestParams;
|
|
20107
20477
|
interface CreateUserResponse {
|
|
@@ -20135,6 +20505,12 @@ interface CreateUserResponse {
|
|
|
20135
20505
|
* Picture URL of the [User](#schema_user)
|
|
20136
20506
|
*/
|
|
20137
20507
|
pictureUrl?: string;
|
|
20508
|
+
/**
|
|
20509
|
+
* Optional attributes
|
|
20510
|
+
*/
|
|
20511
|
+
attributes?: {
|
|
20512
|
+
[k: string]: string;
|
|
20513
|
+
};
|
|
20138
20514
|
};
|
|
20139
20515
|
}
|
|
20140
20516
|
|
|
@@ -20179,6 +20555,12 @@ interface GetUserResponse {
|
|
|
20179
20555
|
* Picture URL of the [User](#schema_user)
|
|
20180
20556
|
*/
|
|
20181
20557
|
pictureUrl?: string;
|
|
20558
|
+
/**
|
|
20559
|
+
* Optional attributes
|
|
20560
|
+
*/
|
|
20561
|
+
attributes?: {
|
|
20562
|
+
[k: string]: string;
|
|
20563
|
+
};
|
|
20182
20564
|
};
|
|
20183
20565
|
}
|
|
20184
20566
|
|
|
@@ -20229,6 +20611,12 @@ interface ListUsersResponse {
|
|
|
20229
20611
|
* Picture URL of the [User](#schema_user)
|
|
20230
20612
|
*/
|
|
20231
20613
|
pictureUrl?: string;
|
|
20614
|
+
/**
|
|
20615
|
+
* Optional attributes
|
|
20616
|
+
*/
|
|
20617
|
+
attributes?: {
|
|
20618
|
+
[k: string]: string;
|
|
20619
|
+
};
|
|
20232
20620
|
}[];
|
|
20233
20621
|
meta: {
|
|
20234
20622
|
/**
|
|
@@ -20264,6 +20652,12 @@ interface GetOrCreateUserRequestBody {
|
|
|
20264
20652
|
* URI of the user picture
|
|
20265
20653
|
*/
|
|
20266
20654
|
pictureUrl?: string;
|
|
20655
|
+
/**
|
|
20656
|
+
* Optional attributes
|
|
20657
|
+
*/
|
|
20658
|
+
attributes?: {
|
|
20659
|
+
[k: string]: string;
|
|
20660
|
+
};
|
|
20267
20661
|
/**
|
|
20268
20662
|
* Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
20269
20663
|
*/
|
|
@@ -20301,6 +20695,12 @@ interface GetOrCreateUserResponse {
|
|
|
20301
20695
|
* Picture URL of the [User](#schema_user)
|
|
20302
20696
|
*/
|
|
20303
20697
|
pictureUrl?: string;
|
|
20698
|
+
/**
|
|
20699
|
+
* Optional attributes
|
|
20700
|
+
*/
|
|
20701
|
+
attributes?: {
|
|
20702
|
+
[k: string]: string;
|
|
20703
|
+
};
|
|
20304
20704
|
};
|
|
20305
20705
|
}
|
|
20306
20706
|
|
|
@@ -20326,6 +20726,12 @@ interface UpdateUserRequestBody {
|
|
|
20326
20726
|
* URI of the user picture
|
|
20327
20727
|
*/
|
|
20328
20728
|
pictureUrl?: string | null;
|
|
20729
|
+
/**
|
|
20730
|
+
* Optional attributes. Set attributes to null to remove them
|
|
20731
|
+
*/
|
|
20732
|
+
attributes?: {
|
|
20733
|
+
[k: string]: string | null;
|
|
20734
|
+
};
|
|
20329
20735
|
}
|
|
20330
20736
|
type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
|
|
20331
20737
|
interface UpdateUserResponse {
|
|
@@ -20359,6 +20765,12 @@ interface UpdateUserResponse {
|
|
|
20359
20765
|
* Picture URL of the [User](#schema_user)
|
|
20360
20766
|
*/
|
|
20361
20767
|
pictureUrl?: string;
|
|
20768
|
+
/**
|
|
20769
|
+
* Optional attributes
|
|
20770
|
+
*/
|
|
20771
|
+
attributes?: {
|
|
20772
|
+
[k: string]: string;
|
|
20773
|
+
};
|
|
20362
20774
|
};
|
|
20363
20775
|
}
|
|
20364
20776
|
|
|
@@ -22112,6 +22524,10 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
22112
22524
|
* URL of the [Integration](#schema_integration)
|
|
22113
22525
|
*/
|
|
22114
22526
|
url: string;
|
|
22527
|
+
/**
|
|
22528
|
+
* 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.
|
|
22529
|
+
*/
|
|
22530
|
+
signingSecret: string;
|
|
22115
22531
|
/**
|
|
22116
22532
|
* Name of the [Integration](#schema_integration)
|
|
22117
22533
|
*/
|
|
@@ -22528,6 +22944,10 @@ interface GetPublicIntegrationResponse {
|
|
|
22528
22944
|
* URL of the [Integration](#schema_integration)
|
|
22529
22945
|
*/
|
|
22530
22946
|
url: string;
|
|
22947
|
+
/**
|
|
22948
|
+
* 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.
|
|
22949
|
+
*/
|
|
22950
|
+
signingSecret: string;
|
|
22531
22951
|
/**
|
|
22532
22952
|
* Name of the [Integration](#schema_integration)
|
|
22533
22953
|
*/
|
|
@@ -24267,7 +24687,7 @@ interface CreateBotResponse {
|
|
|
24267
24687
|
*/
|
|
24268
24688
|
updatedAt: string;
|
|
24269
24689
|
/**
|
|
24270
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
24690
|
+
* 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
24691
|
*/
|
|
24272
24692
|
signingSecret: string;
|
|
24273
24693
|
/**
|
|
@@ -24681,9 +25101,9 @@ interface UpdateBotRequestBody {
|
|
|
24681
25101
|
*/
|
|
24682
25102
|
url?: string | null;
|
|
24683
25103
|
/**
|
|
24684
|
-
* Type of the [Bot](#schema_bot) authentication (`iam`)
|
|
25104
|
+
* Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)
|
|
24685
25105
|
*/
|
|
24686
|
-
authentication?: "iam";
|
|
25106
|
+
authentication?: "iam" | "hmac-sha256";
|
|
24687
25107
|
configuration?: {
|
|
24688
25108
|
/**
|
|
24689
25109
|
* Configuration data
|
|
@@ -24947,7 +25367,7 @@ interface UpdateBotResponse {
|
|
|
24947
25367
|
*/
|
|
24948
25368
|
updatedAt: string;
|
|
24949
25369
|
/**
|
|
24950
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
25370
|
+
* 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
25371
|
*/
|
|
24952
25372
|
signingSecret: string;
|
|
24953
25373
|
/**
|
|
@@ -25348,6 +25768,23 @@ interface UpdateBotResponse {
|
|
|
25348
25768
|
};
|
|
25349
25769
|
}
|
|
25350
25770
|
|
|
25771
|
+
interface RotateBotSigningSecretsRequestHeaders {
|
|
25772
|
+
}
|
|
25773
|
+
interface RotateBotSigningSecretsRequestQuery {
|
|
25774
|
+
}
|
|
25775
|
+
interface RotateBotSigningSecretsRequestParams {
|
|
25776
|
+
id: string;
|
|
25777
|
+
}
|
|
25778
|
+
interface RotateBotSigningSecretsRequestBody {
|
|
25779
|
+
}
|
|
25780
|
+
type RotateBotSigningSecretsInput = RotateBotSigningSecretsRequestBody & RotateBotSigningSecretsRequestHeaders & RotateBotSigningSecretsRequestQuery & RotateBotSigningSecretsRequestParams;
|
|
25781
|
+
interface RotateBotSigningSecretsResponse {
|
|
25782
|
+
/**
|
|
25783
|
+
* 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.
|
|
25784
|
+
*/
|
|
25785
|
+
newSigningSecret: string;
|
|
25786
|
+
}
|
|
25787
|
+
|
|
25351
25788
|
interface TransferBotRequestHeaders {
|
|
25352
25789
|
}
|
|
25353
25790
|
interface TransferBotRequestQuery {
|
|
@@ -25438,7 +25875,7 @@ interface GetBotResponse {
|
|
|
25438
25875
|
*/
|
|
25439
25876
|
updatedAt: string;
|
|
25440
25877
|
/**
|
|
25441
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
25878
|
+
* 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
25879
|
*/
|
|
25443
25880
|
signingSecret: string;
|
|
25444
25881
|
/**
|
|
@@ -26906,7 +27343,7 @@ interface GetAuditRecordsResponse {
|
|
|
26906
27343
|
resourceId: string | null;
|
|
26907
27344
|
resourceName?: string | null;
|
|
26908
27345
|
value?: string | null;
|
|
26909
|
-
action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
|
|
27346
|
+
action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
|
|
26910
27347
|
}[];
|
|
26911
27348
|
meta: {
|
|
26912
27349
|
/**
|
|
@@ -27491,6 +27928,10 @@ interface CreateIntegrationResponse {
|
|
|
27491
27928
|
* URL of the [Integration](#schema_integration)
|
|
27492
27929
|
*/
|
|
27493
27930
|
url: string;
|
|
27931
|
+
/**
|
|
27932
|
+
* 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.
|
|
27933
|
+
*/
|
|
27934
|
+
signingSecret: string;
|
|
27494
27935
|
/**
|
|
27495
27936
|
* Name of the [Integration](#schema_integration)
|
|
27496
27937
|
*/
|
|
@@ -28571,6 +29012,10 @@ interface UpdateIntegrationResponse {
|
|
|
28571
29012
|
* URL of the [Integration](#schema_integration)
|
|
28572
29013
|
*/
|
|
28573
29014
|
url: string;
|
|
29015
|
+
/**
|
|
29016
|
+
* 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.
|
|
29017
|
+
*/
|
|
29018
|
+
signingSecret: string;
|
|
28574
29019
|
/**
|
|
28575
29020
|
* Name of the [Integration](#schema_integration)
|
|
28576
29021
|
*/
|
|
@@ -28922,6 +29367,23 @@ interface UpdateIntegrationResponse {
|
|
|
28922
29367
|
};
|
|
28923
29368
|
}
|
|
28924
29369
|
|
|
29370
|
+
interface RotateIntegrationSigningSecretsRequestHeaders {
|
|
29371
|
+
}
|
|
29372
|
+
interface RotateIntegrationSigningSecretsRequestQuery {
|
|
29373
|
+
}
|
|
29374
|
+
interface RotateIntegrationSigningSecretsRequestParams {
|
|
29375
|
+
id: string;
|
|
29376
|
+
}
|
|
29377
|
+
interface RotateIntegrationSigningSecretsRequestBody {
|
|
29378
|
+
}
|
|
29379
|
+
type RotateIntegrationSigningSecretsInput = RotateIntegrationSigningSecretsRequestBody & RotateIntegrationSigningSecretsRequestHeaders & RotateIntegrationSigningSecretsRequestQuery & RotateIntegrationSigningSecretsRequestParams;
|
|
29380
|
+
interface RotateIntegrationSigningSecretsResponse {
|
|
29381
|
+
/**
|
|
29382
|
+
* 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.
|
|
29383
|
+
*/
|
|
29384
|
+
newSigningSecret: string;
|
|
29385
|
+
}
|
|
29386
|
+
|
|
28925
29387
|
interface ValidateIntegrationUpdateRequestHeaders {
|
|
28926
29388
|
}
|
|
28927
29389
|
interface ValidateIntegrationUpdateRequestQuery {
|
|
@@ -29426,6 +29888,10 @@ interface GetIntegrationResponse {
|
|
|
29426
29888
|
* URL of the [Integration](#schema_integration)
|
|
29427
29889
|
*/
|
|
29428
29890
|
url: string;
|
|
29891
|
+
/**
|
|
29892
|
+
* 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.
|
|
29893
|
+
*/
|
|
29894
|
+
signingSecret: string;
|
|
29429
29895
|
/**
|
|
29430
29896
|
* Name of the [Integration](#schema_integration)
|
|
29431
29897
|
*/
|
|
@@ -29862,6 +30328,10 @@ interface GetIntegrationByNameResponse {
|
|
|
29862
30328
|
* URL of the [Integration](#schema_integration)
|
|
29863
30329
|
*/
|
|
29864
30330
|
url: string;
|
|
30331
|
+
/**
|
|
30332
|
+
* 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.
|
|
30333
|
+
*/
|
|
30334
|
+
signingSecret: string;
|
|
29865
30335
|
/**
|
|
29866
30336
|
* Name of the [Integration](#schema_integration)
|
|
29867
30337
|
*/
|
|
@@ -35882,7 +36352,7 @@ interface Bot {
|
|
|
35882
36352
|
*/
|
|
35883
36353
|
updatedAt: string;
|
|
35884
36354
|
/**
|
|
35885
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
36355
|
+
* 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
36356
|
*/
|
|
35887
36357
|
signingSecret: string;
|
|
35888
36358
|
/**
|
|
@@ -36325,6 +36795,10 @@ interface Integration {
|
|
|
36325
36795
|
* URL of the [Integration](#schema_integration)
|
|
36326
36796
|
*/
|
|
36327
36797
|
url: string;
|
|
36798
|
+
/**
|
|
36799
|
+
* 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.
|
|
36800
|
+
*/
|
|
36801
|
+
signingSecret: string;
|
|
36328
36802
|
/**
|
|
36329
36803
|
* Name of the [Integration](#schema_integration)
|
|
36330
36804
|
*/
|
|
@@ -37170,6 +37644,12 @@ interface User {
|
|
|
37170
37644
|
* Picture URL of the [User](#schema_user)
|
|
37171
37645
|
*/
|
|
37172
37646
|
pictureUrl?: string;
|
|
37647
|
+
/**
|
|
37648
|
+
* Optional attributes
|
|
37649
|
+
*/
|
|
37650
|
+
attributes?: {
|
|
37651
|
+
[k: string]: string;
|
|
37652
|
+
};
|
|
37173
37653
|
}
|
|
37174
37654
|
/**
|
|
37175
37655
|
* The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
|
|
@@ -37864,6 +38344,7 @@ declare class Client$1 {
|
|
|
37864
38344
|
readonly getPublicInterface: (input: GetPublicInterfaceInput) => Promise<GetPublicInterfaceResponse>;
|
|
37865
38345
|
readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
|
|
37866
38346
|
readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
|
|
38347
|
+
readonly rotateBotSigningSecrets: (input: RotateBotSigningSecretsInput) => Promise<RotateBotSigningSecretsResponse>;
|
|
37867
38348
|
readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
|
|
37868
38349
|
readonly listBots: (input: ListBotsInput) => Promise<ListBotsResponse>;
|
|
37869
38350
|
readonly getBot: (input: GetBotInput) => Promise<GetBotResponse>;
|
|
@@ -37921,6 +38402,7 @@ declare class Client$1 {
|
|
|
37921
38402
|
readonly createIntegration: (input: CreateIntegrationInput) => Promise<CreateIntegrationResponse>;
|
|
37922
38403
|
readonly validateIntegrationCreation: (input: ValidateIntegrationCreationInput) => Promise<ValidateIntegrationCreationResponse>;
|
|
37923
38404
|
readonly updateIntegration: (input: UpdateIntegrationInput) => Promise<UpdateIntegrationResponse>;
|
|
38405
|
+
readonly rotateIntegrationSigningSecrets: (input: RotateIntegrationSigningSecretsInput) => Promise<RotateIntegrationSigningSecretsResponse>;
|
|
37924
38406
|
readonly validateIntegrationUpdate: (input: ValidateIntegrationUpdateInput) => Promise<ValidateIntegrationUpdateResponse>;
|
|
37925
38407
|
readonly listIntegrations: (input: ListIntegrationsInput) => Promise<ListIntegrationsResponse>;
|
|
37926
38408
|
readonly getIntegration: (input: GetIntegrationInput) => Promise<GetIntegrationResponse>;
|
|
@@ -38036,6 +38518,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38036
38518
|
};
|
|
38037
38519
|
name?: string;
|
|
38038
38520
|
pictureUrl?: string;
|
|
38521
|
+
attributes?: {
|
|
38522
|
+
[k: string]: string;
|
|
38523
|
+
};
|
|
38039
38524
|
}>;
|
|
38040
38525
|
events: (props: {
|
|
38041
38526
|
status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
|
|
@@ -38099,6 +38584,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38099
38584
|
};
|
|
38100
38585
|
name?: string;
|
|
38101
38586
|
pictureUrl?: string;
|
|
38587
|
+
attributes?: {
|
|
38588
|
+
[k: string]: string;
|
|
38589
|
+
};
|
|
38102
38590
|
}>;
|
|
38103
38591
|
tasks: (props: {
|
|
38104
38592
|
status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
|