@dfns/sdk 0.7.14-rc.0 → 0.7.14

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.
@@ -15,7 +15,7 @@ export type ActivatePersonalAccessTokenResponse = {
15
15
  dateCreated: string;
16
16
  credId: string;
17
17
  isActive: boolean;
18
- /** Access token kind */
18
+ /** Access token kind. */
19
19
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
20
20
  linkedUserId: string;
21
21
  linkedAppId: string;
@@ -38,7 +38,9 @@ export type ActivateServiceAccountResponse = {
38
38
  userInfo: {
39
39
  username: string;
40
40
  name: string;
41
+ /** User id. */
41
42
  userId: string;
43
+ /** User kind. */
42
44
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
43
45
  credentialUuid: string;
44
46
  orgId: string;
@@ -58,7 +60,7 @@ export type ActivateServiceAccountResponse = {
58
60
  dateCreated: string;
59
61
  credId: string;
60
62
  isActive: boolean;
61
- /** Access token kind */
63
+ /** Access token kind. */
62
64
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
63
65
  linkedUserId: string;
64
66
  linkedAppId: string;
@@ -81,7 +83,9 @@ export type ActivateUserParams = {
81
83
  export type ActivateUserResponse = {
82
84
  username: string;
83
85
  name: string;
86
+ /** User id. */
84
87
  userId: string;
88
+ /** User kind. */
85
89
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
86
90
  credentialUuid: string;
87
91
  orgId: string;
@@ -106,7 +110,7 @@ export type ArchivePersonalAccessTokenResponse = {
106
110
  dateCreated: string;
107
111
  credId: string;
108
112
  isActive: boolean;
109
- /** Access token kind */
113
+ /** Access token kind. */
110
114
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
111
115
  linkedUserId: string;
112
116
  linkedAppId: string;
@@ -129,7 +133,9 @@ export type ArchiveServiceAccountResponse = {
129
133
  userInfo: {
130
134
  username: string;
131
135
  name: string;
136
+ /** User id. */
132
137
  userId: string;
138
+ /** User kind. */
133
139
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
134
140
  credentialUuid: string;
135
141
  orgId: string;
@@ -149,7 +155,7 @@ export type ArchiveServiceAccountResponse = {
149
155
  dateCreated: string;
150
156
  credId: string;
151
157
  isActive: boolean;
152
- /** Access token kind */
158
+ /** Access token kind. */
153
159
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
154
160
  linkedUserId: string;
155
161
  linkedAppId: string;
@@ -172,7 +178,9 @@ export type ArchiveUserParams = {
172
178
  export type ArchiveUserResponse = {
173
179
  username: string;
174
180
  name: string;
181
+ /** User id. */
175
182
  userId: string;
183
+ /** User kind. */
176
184
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
177
185
  credentialUuid: string;
178
186
  orgId: string;
@@ -839,7 +847,9 @@ export type CreateServiceAccountResponse = {
839
847
  userInfo: {
840
848
  username: string;
841
849
  name: string;
850
+ /** User id. */
842
851
  userId: string;
852
+ /** User kind. */
843
853
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
844
854
  credentialUuid: string;
845
855
  orgId: string;
@@ -859,7 +869,7 @@ export type CreateServiceAccountResponse = {
859
869
  dateCreated: string;
860
870
  credId: string;
861
871
  isActive: boolean;
862
- /** Access token kind */
872
+ /** Access token kind. */
863
873
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
864
874
  linkedUserId: string;
865
875
  linkedAppId: string;
@@ -934,7 +944,9 @@ export type CreateUserBody = {
934
944
  export type CreateUserResponse = {
935
945
  username: string;
936
946
  name: string;
947
+ /** User id. */
937
948
  userId: string;
949
+ /** User kind. */
938
950
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
939
951
  credentialUuid: string;
940
952
  orgId: string;
@@ -1082,7 +1094,7 @@ export type DeactivatePersonalAccessTokenResponse = {
1082
1094
  dateCreated: string;
1083
1095
  credId: string;
1084
1096
  isActive: boolean;
1085
- /** Access token kind */
1097
+ /** Access token kind. */
1086
1098
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1087
1099
  linkedUserId: string;
1088
1100
  linkedAppId: string;
@@ -1105,7 +1117,9 @@ export type DeactivateServiceAccountResponse = {
1105
1117
  userInfo: {
1106
1118
  username: string;
1107
1119
  name: string;
1120
+ /** User id. */
1108
1121
  userId: string;
1122
+ /** User kind. */
1109
1123
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1110
1124
  credentialUuid: string;
1111
1125
  orgId: string;
@@ -1125,7 +1139,7 @@ export type DeactivateServiceAccountResponse = {
1125
1139
  dateCreated: string;
1126
1140
  credId: string;
1127
1141
  isActive: boolean;
1128
- /** Access token kind */
1142
+ /** Access token kind. */
1129
1143
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1130
1144
  linkedUserId: string;
1131
1145
  linkedAppId: string;
@@ -1148,7 +1162,9 @@ export type DeactivateUserParams = {
1148
1162
  export type DeactivateUserResponse = {
1149
1163
  username: string;
1150
1164
  name: string;
1165
+ /** User id. */
1151
1166
  userId: string;
1167
+ /** User kind. */
1152
1168
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1153
1169
  credentialUuid: string;
1154
1170
  orgId: string;
@@ -1196,7 +1212,7 @@ export type GetApplicationResponse = {
1196
1212
  dateCreated: string;
1197
1213
  credId: string;
1198
1214
  isActive: boolean;
1199
- /** Access token kind */
1215
+ /** Access token kind. */
1200
1216
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1201
1217
  linkedUserId: string;
1202
1218
  linkedAppId: string;
@@ -1243,7 +1259,7 @@ export type GetPersonalAccessTokenResponse = {
1243
1259
  dateCreated: string;
1244
1260
  credId: string;
1245
1261
  isActive: boolean;
1246
- /** Access token kind */
1262
+ /** Access token kind. */
1247
1263
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1248
1264
  linkedUserId: string;
1249
1265
  linkedAppId: string;
@@ -1266,7 +1282,9 @@ export type GetServiceAccountResponse = {
1266
1282
  userInfo: {
1267
1283
  username: string;
1268
1284
  name: string;
1285
+ /** User id. */
1269
1286
  userId: string;
1287
+ /** User kind. */
1270
1288
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1271
1289
  credentialUuid: string;
1272
1290
  orgId: string;
@@ -1286,7 +1304,7 @@ export type GetServiceAccountResponse = {
1286
1304
  dateCreated: string;
1287
1305
  credId: string;
1288
1306
  isActive: boolean;
1289
- /** Access token kind */
1307
+ /** Access token kind. */
1290
1308
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1291
1309
  linkedUserId: string;
1292
1310
  linkedAppId: string;
@@ -1309,7 +1327,9 @@ export type GetUserParams = {
1309
1327
  export type GetUserResponse = {
1310
1328
  username: string;
1311
1329
  name: string;
1330
+ /** User id. */
1312
1331
  userId: string;
1332
+ /** User kind. */
1313
1333
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1314
1334
  credentialUuid: string;
1315
1335
  orgId: string;
@@ -1346,7 +1366,7 @@ export type ListApplicationsResponse = {
1346
1366
  dateCreated: string;
1347
1367
  credId: string;
1348
1368
  isActive: boolean;
1349
- /** Access token kind */
1369
+ /** Access token kind. */
1350
1370
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1351
1371
  linkedUserId: string;
1352
1372
  linkedAppId: string;
@@ -1391,7 +1411,7 @@ export type ListPersonalAccessTokensResponse = {
1391
1411
  dateCreated: string;
1392
1412
  credId: string;
1393
1413
  isActive: boolean;
1394
- /** Access token kind */
1414
+ /** Access token kind. */
1395
1415
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1396
1416
  linkedUserId: string;
1397
1417
  linkedAppId: string;
@@ -1412,7 +1432,9 @@ export type ListServiceAccountsResponse = {
1412
1432
  userInfo: {
1413
1433
  username: string;
1414
1434
  name: string;
1435
+ /** User id. */
1415
1436
  userId: string;
1437
+ /** User kind. */
1416
1438
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1417
1439
  credentialUuid: string;
1418
1440
  orgId: string;
@@ -1432,7 +1454,7 @@ export type ListServiceAccountsResponse = {
1432
1454
  dateCreated: string;
1433
1455
  credId: string;
1434
1456
  isActive: boolean;
1435
- /** Access token kind */
1457
+ /** Access token kind. */
1436
1458
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1437
1459
  linkedUserId: string;
1438
1460
  linkedAppId: string;
@@ -1458,7 +1480,9 @@ export type ListUsersResponse = {
1458
1480
  items: {
1459
1481
  username: string;
1460
1482
  name: string;
1483
+ /** User id. */
1461
1484
  userId: string;
1485
+ /** User kind. */
1462
1486
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
1463
1487
  credentialUuid: string;
1464
1488
  orgId: string;
@@ -1861,6 +1885,7 @@ export type RegisterEndUserResponse = {
1861
1885
  address?: string | undefined;
1862
1886
  /** Details about the key underlying the wallet. */
1863
1887
  signingKey: {
1888
+ /** Key id. */
1864
1889
  id: string;
1865
1890
  /** Key scheme. */
1866
1891
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
@@ -1874,6 +1899,8 @@ export type RegisterEndUserResponse = {
1874
1899
  status: "Active" | "Archived";
1875
1900
  /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
1876
1901
  dateCreated: string;
1902
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was deleted. */
1903
+ dateDeleted?: string | undefined;
1877
1904
  /** Wallet nickname. */
1878
1905
  name?: string | undefined;
1879
1906
  /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
@@ -1943,6 +1970,7 @@ export type SSOLoginRequest = {
1943
1970
  body: SSOLoginBody;
1944
1971
  };
1945
1972
  export type SSOLoginInitBody = {
1973
+ /** Organization id. */
1946
1974
  orgId: string;
1947
1975
  /** Client Id obtained from the IdP */
1948
1976
  clientId: string;
@@ -1968,7 +1996,7 @@ export type UpdatePersonalAccessTokenResponse = {
1968
1996
  dateCreated: string;
1969
1997
  credId: string;
1970
1998
  isActive: boolean;
1971
- /** Access token kind */
1999
+ /** Access token kind. */
1972
2000
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1973
2001
  linkedUserId: string;
1974
2002
  linkedAppId: string;
@@ -1997,7 +2025,9 @@ export type UpdateServiceAccountResponse = {
1997
2025
  userInfo: {
1998
2026
  username: string;
1999
2027
  name: string;
2028
+ /** User id. */
2000
2029
  userId: string;
2030
+ /** User kind. */
2001
2031
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
2002
2032
  credentialUuid: string;
2003
2033
  orgId: string;
@@ -2017,7 +2047,7 @@ export type UpdateServiceAccountResponse = {
2017
2047
  dateCreated: string;
2018
2048
  credId: string;
2019
2049
  isActive: boolean;
2020
- /** Access token kind */
2050
+ /** Access token kind. */
2021
2051
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
2022
2052
  linkedUserId: string;
2023
2053
  linkedAppId: string;
@@ -2045,7 +2075,9 @@ export type UpdateUserParams = {
2045
2075
  export type UpdateUserResponse = {
2046
2076
  username: string;
2047
2077
  name: string;
2078
+ /** User id. */
2048
2079
  userId: string;
2080
+ /** User kind. */
2049
2081
  kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
2050
2082
  credentialUuid: string;
2051
2083
  orgId: string;
@@ -983,14 +983,18 @@ export type ListAccountAssetsParams = {
983
983
  accountId: string;
984
984
  };
985
985
  export type ListAccountAssetsQuery = {
986
+ /** Maximum number of items to return. */
986
987
  limit?: number | undefined;
988
+ /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
987
989
  paginationToken?: string | undefined;
988
990
  };
989
991
  export type ListAccountAssetsResponse = {
992
+ /** Current page items. */
990
993
  items: {
991
994
  symbol: string;
992
995
  balance: string;
993
996
  }[];
997
+ /** token to use as `paginationToken` to request the next page. */
994
998
  nextPageToken?: string | undefined;
995
999
  };
996
1000
  export type ListAccountAssetsRequest = ListAccountAssetsParams & {
@@ -1000,16 +1004,20 @@ export type ListAccountsParams = {
1000
1004
  exchangeId: string;
1001
1005
  };
1002
1006
  export type ListAccountsQuery = {
1007
+ /** Maximum number of items to return. */
1003
1008
  limit?: number | undefined;
1009
+ /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
1004
1010
  paginationToken?: string | undefined;
1005
1011
  };
1006
1012
  export type ListAccountsResponse = {
1013
+ /** Current page items. */
1007
1014
  items: {
1008
1015
  id: string;
1009
1016
  name?: string | undefined;
1010
1017
  exchangeId: string;
1011
1018
  exchangeName?: string | undefined;
1012
1019
  }[];
1020
+ /** token to use as `paginationToken` to request the next page. */
1013
1021
  nextPageToken?: string | undefined;
1014
1022
  };
1015
1023
  export type ListAccountsRequest = ListAccountsParams & {
@@ -1059,16 +1067,20 @@ export type ListAssetWithdrawalNetworksResponse = (({
1059
1067
  })[];
1060
1068
  export type ListAssetWithdrawalNetworksRequest = ListAssetWithdrawalNetworksParams;
1061
1069
  export type ListExchangesQuery = {
1070
+ /** Maximum number of items to return. */
1062
1071
  limit?: number | undefined;
1072
+ /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
1063
1073
  paginationToken?: string | undefined;
1064
1074
  };
1065
1075
  export type ListExchangesResponse = {
1076
+ /** Current page items. */
1066
1077
  items: {
1067
1078
  id: string;
1068
1079
  name?: string | undefined;
1069
1080
  kind: "Binance" | "Kraken" | "CoinbaseApp" | "CoinbasePrime";
1070
1081
  dateCreated: string;
1071
1082
  }[];
1083
+ /** token to use as `paginationToken` to request the next page. */
1072
1084
  nextPageToken?: string | undefined;
1073
1085
  };
1074
1086
  export type ListExchangesRequest = {
@@ -2,6 +2,7 @@ export type CreateKeyBody = {
2
2
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
3
3
  curve: "ed25519" | "secp256k1" | "stark";
4
4
  name?: string | undefined;
5
+ storeId?: string | undefined;
5
6
  delegateTo?: string | undefined;
6
7
  delayDelegation?: boolean | undefined;
7
8
  };
@@ -17,6 +18,7 @@ export type CreateKeyResponse = {
17
18
  imported?: boolean | undefined;
18
19
  exported?: boolean | undefined;
19
20
  dateExported?: string | undefined;
21
+ dateDeleted?: string | undefined;
20
22
  };
21
23
  export type CreateKeyRequest = {
22
24
  body: CreateKeyBody;
@@ -49,6 +51,7 @@ export type DeleteKeyResponse = {
49
51
  imported?: boolean | undefined;
50
52
  exported?: boolean | undefined;
51
53
  dateExported?: string | undefined;
54
+ dateDeleted?: string | undefined;
52
55
  };
53
56
  export type DeleteKeyRequest = DeleteKeyParams;
54
57
  export type DeriveKeyBody = {
@@ -470,11 +473,13 @@ export type GetKeyResponse = {
470
473
  imported?: boolean | undefined;
471
474
  exported?: boolean | undefined;
472
475
  dateExported?: string | undefined;
476
+ dateDeleted?: string | undefined;
473
477
  wallets: {
474
478
  id: string;
475
479
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
476
480
  }[];
477
481
  store: {
482
+ id: string;
478
483
  kind: "Hsm" | "Mpc";
479
484
  keyId: string;
480
485
  };
@@ -702,6 +707,7 @@ export type ImportKeyResponse = {
702
707
  imported?: boolean | undefined;
703
708
  exported?: boolean | undefined;
704
709
  dateExported?: string | undefined;
710
+ dateDeleted?: string | undefined;
705
711
  };
706
712
  export type ImportKeyRequest = {
707
713
  body: ImportKeyBody;
@@ -724,6 +730,7 @@ export type ListKeysResponse = {
724
730
  imported?: boolean | undefined;
725
731
  exported?: boolean | undefined;
726
732
  dateExported?: string | undefined;
733
+ dateDeleted?: string | undefined;
727
734
  }[];
728
735
  nextPageToken?: string | undefined;
729
736
  };
@@ -957,6 +964,7 @@ export type UpdateKeyResponse = {
957
964
  imported?: boolean | undefined;
958
965
  exported?: boolean | undefined;
959
966
  dateExported?: string | undefined;
967
+ dateDeleted?: string | undefined;
960
968
  };
961
969
  export type UpdateKeyRequest = UpdateKeyParams & {
962
970
  body: UpdateKeyBody;
@@ -48,6 +48,7 @@ export type CreateCantonValidatorParams = {
48
48
  };
49
49
  export type CreateCantonValidatorResponse = {
50
50
  id: string;
51
+ /** Organization id. */
51
52
  orgId: string;
52
53
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
53
54
  name?: string | undefined;
@@ -64,6 +65,7 @@ export type DeleteCantonValidatorParams = {
64
65
  };
65
66
  export type DeleteCantonValidatorResponse = {
66
67
  id: string;
68
+ /** Organization id. */
67
69
  orgId: string;
68
70
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
69
71
  name?: string | undefined;
@@ -78,6 +80,7 @@ export type GetCantonValidatorParams = {
78
80
  };
79
81
  export type GetCantonValidatorResponse = {
80
82
  id: string;
83
+ /** Organization id. */
81
84
  orgId: string;
82
85
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
83
86
  name?: string | undefined;
@@ -130,12 +133,16 @@ export type ListCantonValidatorsParams = {
130
133
  network: "canton" | "canton-devnet" | "canton-testnet";
131
134
  };
132
135
  export type ListCantonValidatorsQuery = {
136
+ /** Maximum number of items to return. */
133
137
  limit?: number | undefined;
138
+ /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
134
139
  paginationToken?: string | undefined;
135
140
  };
136
141
  export type ListCantonValidatorsResponse = {
142
+ /** Current page items. */
137
143
  items: {
138
144
  id: string;
145
+ /** Organization id. */
139
146
  orgId: string;
140
147
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
141
148
  name?: string | undefined;
@@ -143,6 +150,7 @@ export type ListCantonValidatorsResponse = {
143
150
  dateCreated: string;
144
151
  partyHint: string;
145
152
  }[];
153
+ /** token to use as `paginationToken` to request the next page. */
146
154
  nextPageToken?: string | undefined;
147
155
  };
148
156
  export type ListCantonValidatorsRequest = ListCantonValidatorsParams & {
@@ -208,6 +216,7 @@ export type UpdateCantonValidatorParams = {
208
216
  };
209
217
  export type UpdateCantonValidatorResponse = {
210
218
  id: string;
219
+ /** Organization id. */
211
220
  orgId: string;
212
221
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
213
222
  name?: string | undefined;
@@ -36,7 +36,7 @@ export type CreateAssignmentRequest = CreateAssignmentParams & {
36
36
  };
37
37
  export type CreatePermissionBody = {
38
38
  name: string;
39
- operations: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[];
39
+ operations: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "KeyStores:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[];
40
40
  };
41
41
  export type CreatePermissionResponse = {
42
42
  id: string;
@@ -183,7 +183,7 @@ export type ListPermissionsRequest = {
183
183
  };
184
184
  export type UpdatePermissionBody = {
185
185
  name?: string | undefined;
186
- operations?: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[] | undefined;
186
+ operations?: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "KeyStores:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[] | undefined;
187
187
  };
188
188
  export type UpdatePermissionParams = {
189
189
  permissionId: string;