@turnkey/http 1.3.0 → 2.1.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.
@@ -31,6 +31,10 @@ export type paths = {
31
31
  /** Get details about a User */
32
32
  post: operations["PublicApiService_GetUser"];
33
33
  };
34
+ "/public/v1/query/get_wallet": {
35
+ /** Get details about a Wallet */
36
+ post: operations["PublicApiService_GetWallet"];
37
+ };
34
38
  "/public/v1/query/list_activities": {
35
39
  /** List all Activities within an Organization */
36
40
  post: operations["PublicApiService_GetActivities"];
@@ -47,6 +51,14 @@ export type paths = {
47
51
  /** List all Users within an Organization */
48
52
  post: operations["PublicApiService_GetUsers"];
49
53
  };
54
+ "/public/v1/query/list_wallet_accounts": {
55
+ /** List all Accounts wirhin a Wallet */
56
+ post: operations["PublicApiService_GetWalletAccounts"];
57
+ };
58
+ "/public/v1/query/list_wallets": {
59
+ /** List all Wallets within an Organization */
60
+ post: operations["PublicApiService_GetWallets"];
61
+ };
50
62
  "/public/v1/query/whoami": {
51
63
  /** Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN users. */
52
64
  post: operations["PublicApiService_GetWhoami"];
@@ -96,11 +108,11 @@ export type paths = {
96
108
  post: operations["PublicApiService_CreateUsers"];
97
109
  };
98
110
  "/public/v1/submit/create_wallet": {
99
- /** Create a Wallet */
111
+ /** Create a Wallet and derive addresses */
100
112
  post: operations["PublicApiService_CreateWallet"];
101
113
  };
102
114
  "/public/v1/submit/create_wallet_accounts": {
103
- /** Create Wallet accounts */
115
+ /** Derive additional addresses using an existing wallet */
104
116
  post: operations["PublicApiService_CreateWalletAccounts"];
105
117
  };
106
118
  "/public/v1/submit/delete_api_keys": {
@@ -111,7 +123,7 @@ export type paths = {
111
123
  /** Remove authenticators from a User */
112
124
  post: operations["PublicApiService_DeleteAuthenticators"];
113
125
  };
114
- "/public/v1/submit/delete_invitations": {
126
+ "/public/v1/submit/delete_invitation": {
115
127
  /** Delete an existing Invitation */
116
128
  post: operations["PublicApiService_DeleteInvitation"];
117
129
  };
@@ -123,10 +135,18 @@ export type paths = {
123
135
  /** Exports a Private Key */
124
136
  post: operations["PublicApiService_ExportPrivateKey"];
125
137
  };
138
+ "/public/v1/submit/export_wallet": {
139
+ /** Exports a Wallet */
140
+ post: operations["PublicApiService_ExportWallet"];
141
+ };
126
142
  "/public/v1/submit/init_user_email_recovery": {
127
- /** Initializes a new recovery */
143
+ /** Initializes a new email recovery */
128
144
  post: operations["PublicApiService_InitUserEmailRecovery"];
129
145
  };
146
+ "/public/v1/submit/recover_user": {
147
+ /** Completes the process of recovering a user by adding an authenticator */
148
+ post: operations["PublicApiService_RecoverUser"];
149
+ };
130
150
  "/public/v1/submit/reject_activity": {
131
151
  /** Reject an Activity */
132
152
  post: operations["PublicApiService_RejectActivity"];
@@ -140,23 +160,15 @@ export type paths = {
140
160
  post: operations["PublicApiService_SetOrganizationFeature"];
141
161
  };
142
162
  "/public/v1/submit/sign_raw_payload": {
143
- /** Sign a raw payload with a Private Key */
163
+ /** Sign a raw payload */
144
164
  post: operations["PublicApiService_SignRawPayload"];
145
165
  };
146
- "/public/v1/submit/sign_raw_payload_v2": {
147
- /** Sign a raw payload with a Private Key id or address */
148
- post: operations["PublicApiService_SignRawPayloadV2"];
149
- };
150
166
  "/public/v1/submit/sign_transaction": {
151
- /** Sign a transaction with a Private Key */
167
+ /** Sign a transaction */
152
168
  post: operations["PublicApiService_SignTransaction"];
153
169
  };
154
- "/public/v1/submit/sign_transaction_v2": {
155
- /** Sign a transaction with a Private Key id or address */
156
- post: operations["PublicApiService_SignTransactionV2"];
157
- };
158
170
  "/public/v1/submit/update_allowed_origins": {
159
- /** Update the allowable origins for credentials and requests */
171
+ /** Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations. */
160
172
  post: operations["PublicApiService_UpdateAllowedOrigins"];
161
173
  };
162
174
  "/public/v1/submit/update_policy": {
@@ -332,7 +344,7 @@ export type definitions = {
332
344
  /** @enum {string} */
333
345
  v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
334
346
  /** @enum {string} */
335
- v1ActivityType: "ACTIVITY_TYPE_CREATE_API_KEYS" | "ACTIVITY_TYPE_CREATE_USERS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD" | "ACTIVITY_TYPE_CREATE_INVITATIONS" | "ACTIVITY_TYPE_ACCEPT_INVITATION" | "ACTIVITY_TYPE_CREATE_POLICY" | "ACTIVITY_TYPE_DISABLE_PRIVATE_KEY" | "ACTIVITY_TYPE_DELETE_USERS" | "ACTIVITY_TYPE_DELETE_API_KEYS" | "ACTIVITY_TYPE_DELETE_INVITATION" | "ACTIVITY_TYPE_DELETE_ORGANIZATION" | "ACTIVITY_TYPE_DELETE_POLICY" | "ACTIVITY_TYPE_CREATE_USER_TAG" | "ACTIVITY_TYPE_DELETE_USER_TAGS" | "ACTIVITY_TYPE_CREATE_ORGANIZATION" | "ACTIVITY_TYPE_SIGN_TRANSACTION" | "ACTIVITY_TYPE_APPROVE_ACTIVITY" | "ACTIVITY_TYPE_REJECT_ACTIVITY" | "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD" | "ACTIVITY_TYPE_ACTIVATE_BILLING_TIER" | "ACTIVITY_TYPE_DELETE_PAYMENT_METHOD" | "ACTIVITY_TYPE_CREATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_POLICY_V3" | "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" | "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" | "ACTIVITY_TYPE_UPDATE_USER_TAG" | "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2" | "ACTIVITY_TYPE_CREATE_ORGANIZATION_V2" | "ACTIVITY_TYPE_CREATE_USERS_V2" | "ACTIVITY_TYPE_ACCEPT_INVITATION_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2" | "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" | "ACTIVITY_TYPE_UPDATE_USER" | "ACTIVITY_TYPE_UPDATE_POLICY" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3" | "ACTIVITY_TYPE_CREATE_WALLET" | "ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY" | "ACTIVITY_TYPE_RECOVER_USER" | "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2" | "ACTIVITY_TYPE_SIGN_TRANSACTION_V2" | "ACTIVITY_TYPE_EXPORT_PRIVATE_KEY";
347
+ v1ActivityType: "ACTIVITY_TYPE_CREATE_API_KEYS" | "ACTIVITY_TYPE_CREATE_USERS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD" | "ACTIVITY_TYPE_CREATE_INVITATIONS" | "ACTIVITY_TYPE_ACCEPT_INVITATION" | "ACTIVITY_TYPE_CREATE_POLICY" | "ACTIVITY_TYPE_DISABLE_PRIVATE_KEY" | "ACTIVITY_TYPE_DELETE_USERS" | "ACTIVITY_TYPE_DELETE_API_KEYS" | "ACTIVITY_TYPE_DELETE_INVITATION" | "ACTIVITY_TYPE_DELETE_ORGANIZATION" | "ACTIVITY_TYPE_DELETE_POLICY" | "ACTIVITY_TYPE_CREATE_USER_TAG" | "ACTIVITY_TYPE_DELETE_USER_TAGS" | "ACTIVITY_TYPE_CREATE_ORGANIZATION" | "ACTIVITY_TYPE_SIGN_TRANSACTION" | "ACTIVITY_TYPE_APPROVE_ACTIVITY" | "ACTIVITY_TYPE_REJECT_ACTIVITY" | "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD" | "ACTIVITY_TYPE_ACTIVATE_BILLING_TIER" | "ACTIVITY_TYPE_DELETE_PAYMENT_METHOD" | "ACTIVITY_TYPE_CREATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_POLICY_V3" | "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" | "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" | "ACTIVITY_TYPE_UPDATE_USER_TAG" | "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2" | "ACTIVITY_TYPE_CREATE_ORGANIZATION_V2" | "ACTIVITY_TYPE_CREATE_USERS_V2" | "ACTIVITY_TYPE_ACCEPT_INVITATION_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2" | "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" | "ACTIVITY_TYPE_UPDATE_USER" | "ACTIVITY_TYPE_UPDATE_POLICY" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3" | "ACTIVITY_TYPE_CREATE_WALLET" | "ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY" | "ACTIVITY_TYPE_RECOVER_USER" | "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2" | "ACTIVITY_TYPE_SIGN_TRANSACTION_V2" | "ACTIVITY_TYPE_EXPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_EXPORT_WALLET" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4";
336
348
  v1ApiKey: {
337
349
  /** @description A User credential that can be used to authenticate to Turnkey. */
338
350
  credential: definitions["externaldatav1Credential"];
@@ -645,14 +657,29 @@ export type definitions = {
645
657
  /** @description A list of Private Keys. */
646
658
  privateKeys: definitions["v1PrivateKeyParams"][];
647
659
  };
660
+ v1CreateSubOrganizationIntentV4: {
661
+ /** @description Name for this sub-organization */
662
+ subOrganizationName: string;
663
+ /** @description Root users to create within this sub-organization */
664
+ rootUsers: definitions["v1RootUserParams"][];
665
+ /**
666
+ * Format: int32
667
+ * @description The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
668
+ */
669
+ rootQuorumThreshold: number;
670
+ /** @description The wallet to create for the sub-organization */
671
+ wallet?: definitions["v1WalletParams"];
672
+ /** @description Disable email recovery for the sub-organization */
673
+ disableEmailRecovery?: boolean;
674
+ };
648
675
  v1CreateSubOrganizationRequest: {
649
676
  /** @enum {string} */
650
- type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3";
677
+ type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4";
651
678
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
652
679
  timestampMs: string;
653
680
  /** @description Unique identifier for a given Organization. */
654
681
  organizationId: string;
655
- parameters: definitions["v1CreateSubOrganizationIntentV3"];
682
+ parameters: definitions["v1CreateSubOrganizationIntentV4"];
656
683
  };
657
684
  v1CreateSubOrganizationResult: {
658
685
  subOrganizationId: string;
@@ -662,6 +689,10 @@ export type definitions = {
662
689
  /** @description A list of Private Key IDs and addresses. */
663
690
  privateKeys: definitions["v1PrivateKeyResult"][];
664
691
  };
692
+ v1CreateSubOrganizationResultV4: {
693
+ subOrganizationId: string;
694
+ wallet?: definitions["v1WalletResult"];
695
+ };
665
696
  v1CreateUserTagIntent: {
666
697
  /** @description Human-readable name for a User Tag. */
667
698
  userTagName: string;
@@ -892,6 +923,29 @@ export type definitions = {
892
923
  /** @description Export bundle containing a private key encrypted to the client's target public key. */
893
924
  exportBundle: string;
894
925
  };
926
+ v1ExportWalletIntent: {
927
+ /** @description Unique identifier for a given Wallet. */
928
+ walletId: string;
929
+ /** @description Client-side public key generated by the user, to which the export bundle will be encrypted. */
930
+ targetPublicKey: string;
931
+ /** @description The language of the mnemonic to export. Defaults to English. */
932
+ language?: definitions["v1MnemonicLanguage"];
933
+ };
934
+ v1ExportWalletRequest: {
935
+ /** @enum {string} */
936
+ type: "ACTIVITY_TYPE_EXPORT_WALLET";
937
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
938
+ timestampMs: string;
939
+ /** @description Unique identifier for a given Organization. */
940
+ organizationId: string;
941
+ parameters: definitions["v1ExportWalletIntent"];
942
+ };
943
+ v1ExportWalletResult: {
944
+ /** @description Unique identifier for a given Wallet. */
945
+ walletId: string;
946
+ /** @description Export bundle containing a wallet mnemonic + optional newline passphrase encrypted by the client's target public key. */
947
+ exportBundle: string;
948
+ };
895
949
  v1Feature: {
896
950
  name?: definitions["v1FeatureName"];
897
951
  value?: string;
@@ -1000,6 +1054,34 @@ export type definitions = {
1000
1054
  /** @description A list of Users. */
1001
1055
  users: definitions["v1User"][];
1002
1056
  };
1057
+ v1GetWalletAccountsRequest: {
1058
+ /** @description Unique identifier for a given Organization. */
1059
+ organizationId: string;
1060
+ /** @description Unique identifier for a given Wallet. */
1061
+ walletId: string;
1062
+ };
1063
+ v1GetWalletAccountsResponse: {
1064
+ /** @description A list of Accounts generated from a Wallet that share a common seed */
1065
+ accounts: definitions["v1WalletAccount"][];
1066
+ };
1067
+ v1GetWalletRequest: {
1068
+ /** @description Unique identifier for a given Organization. */
1069
+ organizationId: string;
1070
+ /** @description Unique identifier for a given Wallet. */
1071
+ walletId: string;
1072
+ };
1073
+ v1GetWalletResponse: {
1074
+ /** @description A collection of deterministically generated cryptographic public / private key pairs that share a common seed */
1075
+ wallet: definitions["v1Wallet"];
1076
+ };
1077
+ v1GetWalletsRequest: {
1078
+ /** @description Unique identifier for a given Organization. */
1079
+ organizationId: string;
1080
+ };
1081
+ v1GetWalletsResponse: {
1082
+ /** @description A list of Wallets. */
1083
+ wallets: definitions["v1Wallet"][];
1084
+ };
1003
1085
  v1GetWhoamiRequest: {
1004
1086
  /** @description Unique identifier for a given Organization. If the request is being made by a WebAuthN user and their Sub-Organization ID is unknown, this can be the Parent Organization ID; using the Sub-Organization ID when possible is preferred due to performance reasons. */
1005
1087
  organizationId: string;
@@ -1087,6 +1169,8 @@ export type definitions = {
1087
1169
  signRawPayloadIntentV2?: definitions["v1SignRawPayloadIntentV2"];
1088
1170
  signTransactionIntentV2?: definitions["v1SignTransactionIntentV2"];
1089
1171
  exportPrivateKeyIntent?: definitions["v1ExportPrivateKeyIntent"];
1172
+ exportWalletIntent?: definitions["v1ExportWalletIntent"];
1173
+ createSubOrganizationIntentV4?: definitions["v1CreateSubOrganizationIntentV4"];
1090
1174
  };
1091
1175
  v1Invitation: {
1092
1176
  /** @description Unique identifier for a given Invitation object. */
@@ -1120,6 +1204,8 @@ export type definitions = {
1120
1204
  };
1121
1205
  /** @enum {string} */
1122
1206
  v1InvitationStatus: "INVITATION_STATUS_CREATED" | "INVITATION_STATUS_ACCEPTED" | "INVITATION_STATUS_REVOKED";
1207
+ /** @enum {string} */
1208
+ v1MnemonicLanguage: "MNEMONIC_LANGUAGE_ENGLISH" | "MNEMONIC_LANGUAGE_SIMPLIFIED_CHINESE" | "MNEMONIC_LANGUAGE_TRADITIONAL_CHINESE" | "MNEMONIC_LANGUAGE_CZECH" | "MNEMONIC_LANGUAGE_FRENCH" | "MNEMONIC_LANGUAGE_ITALIAN" | "MNEMONIC_LANGUAGE_JAPANESE" | "MNEMONIC_LANGUAGE_KOREAN" | "MNEMONIC_LANGUAGE_SPANISH";
1123
1209
  v1NOOPCodegenAnchorResponse: {
1124
1210
  stamp: definitions["v1WebAuthnStamp"];
1125
1211
  };
@@ -1135,6 +1221,7 @@ export type definitions = {
1135
1221
  rootQuorum?: definitions["externaldatav1Quorum"];
1136
1222
  allowedOrigins?: string[];
1137
1223
  features?: definitions["v1Feature"][];
1224
+ wallets?: definitions["v1Wallet"][];
1138
1225
  };
1139
1226
  v1Pagination: {
1140
1227
  /** @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10. */
@@ -1178,6 +1265,9 @@ export type definitions = {
1178
1265
  /** @description A list of Private Key Tag IDs. */
1179
1266
  privateKeyTags: string[];
1180
1267
  createdAt: definitions["externaldatav1Timestamp"];
1268
+ updatedAt: definitions["externaldatav1Timestamp"];
1269
+ /** @description True when a given Private Key is exported, false otherwise. */
1270
+ exported: boolean;
1181
1271
  };
1182
1272
  v1PrivateKeyParams: {
1183
1273
  /** @description Human-readable name for a Private Key. */
@@ -1209,6 +1299,15 @@ export type definitions = {
1209
1299
  /** @description Unique identifier for the user performing recovery. */
1210
1300
  userId: string;
1211
1301
  };
1302
+ v1RecoverUserRequest: {
1303
+ /** @enum {string} */
1304
+ type: "ACTIVITY_TYPE_RECOVER_USER";
1305
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1306
+ timestampMs: string;
1307
+ /** @description Unique identifier for a given Organization. */
1308
+ organizationId: string;
1309
+ parameters: definitions["v1RecoverUserIntent"];
1310
+ };
1212
1311
  v1RecoverUserResult: {
1213
1312
  /** @description ID of the authenticator created. */
1214
1313
  authenticatorId: string[];
@@ -1285,6 +1384,8 @@ export type definitions = {
1285
1384
  setOrganizationFeatureResult?: definitions["v1SetOrganizationFeatureResult"];
1286
1385
  removeOrganizationFeatureResult?: definitions["v1RemoveOrganizationFeatureResult"];
1287
1386
  exportPrivateKeyResult?: definitions["v1ExportPrivateKeyResult"];
1387
+ exportWalletResult?: definitions["v1ExportWalletResult"];
1388
+ createSubOrganizationResultV4?: definitions["v1CreateSubOrganizationResultV4"];
1288
1389
  };
1289
1390
  v1RootUserParams: {
1290
1391
  /** @description Human-readable name for a User. */
@@ -1361,7 +1462,7 @@ export type definitions = {
1361
1462
  hashFunction: definitions["immutableactivityv1HashFunction"];
1362
1463
  };
1363
1464
  v1SignRawPayloadIntentV2: {
1364
- /** @description The Private Key identifier or address. */
1465
+ /** @description A Wallet account address, Private Key address, or Private Key identifier. */
1365
1466
  signWith: string;
1366
1467
  /** @description Raw unsigned payload to be signed. */
1367
1468
  payload: string;
@@ -1372,12 +1473,12 @@ export type definitions = {
1372
1473
  };
1373
1474
  v1SignRawPayloadRequest: {
1374
1475
  /** @enum {string} */
1375
- type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD";
1476
+ type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2";
1376
1477
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1377
1478
  timestampMs: string;
1378
1479
  /** @description Unique identifier for a given Organization. */
1379
1480
  organizationId: string;
1380
- parameters: definitions["v1SignRawPayloadIntent"];
1481
+ parameters: definitions["v1SignRawPayloadIntentV2"];
1381
1482
  };
1382
1483
  v1SignRawPayloadResult: {
1383
1484
  /** @description Component of an ECSDA signature. */
@@ -1387,15 +1488,6 @@ export type definitions = {
1387
1488
  /** @description Component of an ECSDA signature. */
1388
1489
  v: string;
1389
1490
  };
1390
- v1SignRawPayloadV2Request: {
1391
- /** @enum {string} */
1392
- type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2";
1393
- /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1394
- timestampMs: string;
1395
- /** @description Unique identifier for a given Organization. */
1396
- organizationId: string;
1397
- parameters: definitions["v1SignRawPayloadIntentV2"];
1398
- };
1399
1491
  v1SignTransactionIntent: {
1400
1492
  /** @description Unique identifier for a given Private Key. */
1401
1493
  privateKeyId: string;
@@ -1404,7 +1496,7 @@ export type definitions = {
1404
1496
  type: definitions["v1TransactionType"];
1405
1497
  };
1406
1498
  v1SignTransactionIntentV2: {
1407
- /** @description The Private Key identifier or address. */
1499
+ /** @description A Wallet account address, Private Key address, or Private Key identifier. */
1408
1500
  signWith: string;
1409
1501
  /** @description Raw unsigned transaction to be signed */
1410
1502
  unsignedTransaction: string;
@@ -1412,25 +1504,16 @@ export type definitions = {
1412
1504
  };
1413
1505
  v1SignTransactionRequest: {
1414
1506
  /** @enum {string} */
1415
- type: "ACTIVITY_TYPE_SIGN_TRANSACTION";
1507
+ type: "ACTIVITY_TYPE_SIGN_TRANSACTION_V2";
1416
1508
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1417
1509
  timestampMs: string;
1418
1510
  /** @description Unique identifier for a given Organization. */
1419
1511
  organizationId: string;
1420
- parameters: definitions["v1SignTransactionIntent"];
1512
+ parameters: definitions["v1SignTransactionIntentV2"];
1421
1513
  };
1422
1514
  v1SignTransactionResult: {
1423
1515
  signedTransaction: string;
1424
1516
  };
1425
- v1SignTransactionV2Request: {
1426
- /** @enum {string} */
1427
- type: "ACTIVITY_TYPE_SIGN_TRANSACTION_V2";
1428
- /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1429
- timestampMs: string;
1430
- /** @description Unique identifier for a given Organization. */
1431
- organizationId: string;
1432
- parameters: definitions["v1SignTransactionIntentV2"];
1433
- };
1434
1517
  v1SimpleClientExtensionResults: {
1435
1518
  appid?: boolean;
1436
1519
  appidExclude?: boolean;
@@ -1640,6 +1723,34 @@ export type definitions = {
1640
1723
  scheme: string;
1641
1724
  createdAt: definitions["externaldatav1Timestamp"];
1642
1725
  };
1726
+ v1Wallet: {
1727
+ /** @description Unique identifier for a given Wallet. */
1728
+ walletId: string;
1729
+ /** @description Human-readable name for a Wallet. */
1730
+ walletName: string;
1731
+ createdAt: definitions["externaldatav1Timestamp"];
1732
+ updatedAt: definitions["externaldatav1Timestamp"];
1733
+ /** @description True when a given Wallet is exported, false otherwise. */
1734
+ exported: boolean;
1735
+ };
1736
+ v1WalletAccount: {
1737
+ /** @description The Organization the Account belongs to. */
1738
+ organizationId: string;
1739
+ /** @description The Wallet the Account was derived from. */
1740
+ walletId: string;
1741
+ /** @description Cryptographic curve used to generate the Account. */
1742
+ curve: definitions["immutablecommonv1Curve"];
1743
+ /** @description Path format used to generate the Account. */
1744
+ pathFormat: definitions["v1PathFormat"];
1745
+ /** @description Path used to generate the Account. */
1746
+ path: string;
1747
+ /** @description Address format used to generate the Acccount. */
1748
+ addressFormat: definitions["immutablecommonv1AddressFormat"];
1749
+ /** @description Address generated using the Wallet seed and Account parameters. */
1750
+ address: string;
1751
+ createdAt: definitions["externaldatav1Timestamp"];
1752
+ updatedAt: definitions["externaldatav1Timestamp"];
1753
+ };
1643
1754
  v1WalletAccountParams: {
1644
1755
  /** @description Cryptographic curve used to generate a wallet Account. */
1645
1756
  curve: definitions["immutablecommonv1Curve"];
@@ -1650,6 +1761,17 @@ export type definitions = {
1650
1761
  /** @description Address format used to generate a wallet Acccount. */
1651
1762
  addressFormat: definitions["immutablecommonv1AddressFormat"];
1652
1763
  };
1764
+ v1WalletParams: {
1765
+ /** @description Human-readable name for a Wallet. */
1766
+ walletName: string;
1767
+ /** @description A list of wallet Accounts. */
1768
+ accounts: definitions["v1WalletAccountParams"][];
1769
+ };
1770
+ v1WalletResult: {
1771
+ walletId: string;
1772
+ /** @description A list of account addresses. */
1773
+ addresses: string[];
1774
+ };
1653
1775
  v1WebAuthnStamp: {
1654
1776
  /** @description A base64 url encoded Unique identifier for a given credential. */
1655
1777
  credentialId: string;
@@ -1788,6 +1910,24 @@ export type operations = {
1788
1910
  };
1789
1911
  };
1790
1912
  };
1913
+ /** Get details about a Wallet */
1914
+ PublicApiService_GetWallet: {
1915
+ parameters: {
1916
+ body: {
1917
+ body: definitions["v1GetWalletRequest"];
1918
+ };
1919
+ };
1920
+ responses: {
1921
+ /** A successful response. */
1922
+ 200: {
1923
+ schema: definitions["v1GetWalletResponse"];
1924
+ };
1925
+ /** An unexpected error response. */
1926
+ default: {
1927
+ schema: definitions["rpcStatus"];
1928
+ };
1929
+ };
1930
+ };
1791
1931
  /** List all Activities within an Organization */
1792
1932
  PublicApiService_GetActivities: {
1793
1933
  parameters: {
@@ -1860,6 +2000,42 @@ export type operations = {
1860
2000
  };
1861
2001
  };
1862
2002
  };
2003
+ /** List all Accounts wirhin a Wallet */
2004
+ PublicApiService_GetWalletAccounts: {
2005
+ parameters: {
2006
+ body: {
2007
+ body: definitions["v1GetWalletAccountsRequest"];
2008
+ };
2009
+ };
2010
+ responses: {
2011
+ /** A successful response. */
2012
+ 200: {
2013
+ schema: definitions["v1GetWalletAccountsResponse"];
2014
+ };
2015
+ /** An unexpected error response. */
2016
+ default: {
2017
+ schema: definitions["rpcStatus"];
2018
+ };
2019
+ };
2020
+ };
2021
+ /** List all Wallets within an Organization */
2022
+ PublicApiService_GetWallets: {
2023
+ parameters: {
2024
+ body: {
2025
+ body: definitions["v1GetWalletsRequest"];
2026
+ };
2027
+ };
2028
+ responses: {
2029
+ /** A successful response. */
2030
+ 200: {
2031
+ schema: definitions["v1GetWalletsResponse"];
2032
+ };
2033
+ /** An unexpected error response. */
2034
+ default: {
2035
+ schema: definitions["rpcStatus"];
2036
+ };
2037
+ };
2038
+ };
1863
2039
  /** Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN users. */
1864
2040
  PublicApiService_GetWhoami: {
1865
2041
  parameters: {
@@ -2076,7 +2252,7 @@ export type operations = {
2076
2252
  };
2077
2253
  };
2078
2254
  };
2079
- /** Create a Wallet */
2255
+ /** Create a Wallet and derive addresses */
2080
2256
  PublicApiService_CreateWallet: {
2081
2257
  parameters: {
2082
2258
  body: {
@@ -2094,7 +2270,7 @@ export type operations = {
2094
2270
  };
2095
2271
  };
2096
2272
  };
2097
- /** Create Wallet accounts */
2273
+ /** Derive additional addresses using an existing wallet */
2098
2274
  PublicApiService_CreateWalletAccounts: {
2099
2275
  parameters: {
2100
2276
  body: {
@@ -2202,11 +2378,11 @@ export type operations = {
2202
2378
  };
2203
2379
  };
2204
2380
  };
2205
- /** Initializes a new recovery */
2206
- PublicApiService_InitUserEmailRecovery: {
2381
+ /** Exports a Wallet */
2382
+ PublicApiService_ExportWallet: {
2207
2383
  parameters: {
2208
2384
  body: {
2209
- body: definitions["v1InitUserEmailRecoveryRequest"];
2385
+ body: definitions["v1ExportWalletRequest"];
2210
2386
  };
2211
2387
  };
2212
2388
  responses: {
@@ -2220,11 +2396,11 @@ export type operations = {
2220
2396
  };
2221
2397
  };
2222
2398
  };
2223
- /** Reject an Activity */
2224
- PublicApiService_RejectActivity: {
2399
+ /** Initializes a new email recovery */
2400
+ PublicApiService_InitUserEmailRecovery: {
2225
2401
  parameters: {
2226
2402
  body: {
2227
- body: definitions["v1RejectActivityRequest"];
2403
+ body: definitions["v1InitUserEmailRecoveryRequest"];
2228
2404
  };
2229
2405
  };
2230
2406
  responses: {
@@ -2238,11 +2414,11 @@ export type operations = {
2238
2414
  };
2239
2415
  };
2240
2416
  };
2241
- /** Removes an organization feature */
2242
- PublicApiService_RemoveOrganizationFeature: {
2417
+ /** Completes the process of recovering a user by adding an authenticator */
2418
+ PublicApiService_RecoverUser: {
2243
2419
  parameters: {
2244
2420
  body: {
2245
- body: definitions["v1RemoveOrganizationFeatureRequest"];
2421
+ body: definitions["v1RecoverUserRequest"];
2246
2422
  };
2247
2423
  };
2248
2424
  responses: {
@@ -2256,11 +2432,11 @@ export type operations = {
2256
2432
  };
2257
2433
  };
2258
2434
  };
2259
- /** Sets an organization feature */
2260
- PublicApiService_SetOrganizationFeature: {
2435
+ /** Reject an Activity */
2436
+ PublicApiService_RejectActivity: {
2261
2437
  parameters: {
2262
2438
  body: {
2263
- body: definitions["v1SetOrganizationFeatureRequest"];
2439
+ body: definitions["v1RejectActivityRequest"];
2264
2440
  };
2265
2441
  };
2266
2442
  responses: {
@@ -2274,11 +2450,11 @@ export type operations = {
2274
2450
  };
2275
2451
  };
2276
2452
  };
2277
- /** Sign a raw payload with a Private Key */
2278
- PublicApiService_SignRawPayload: {
2453
+ /** Removes an organization feature */
2454
+ PublicApiService_RemoveOrganizationFeature: {
2279
2455
  parameters: {
2280
2456
  body: {
2281
- body: definitions["v1SignRawPayloadRequest"];
2457
+ body: definitions["v1RemoveOrganizationFeatureRequest"];
2282
2458
  };
2283
2459
  };
2284
2460
  responses: {
@@ -2292,11 +2468,11 @@ export type operations = {
2292
2468
  };
2293
2469
  };
2294
2470
  };
2295
- /** Sign a raw payload with a Private Key id or address */
2296
- PublicApiService_SignRawPayloadV2: {
2471
+ /** Sets an organization feature */
2472
+ PublicApiService_SetOrganizationFeature: {
2297
2473
  parameters: {
2298
2474
  body: {
2299
- body: definitions["v1SignRawPayloadV2Request"];
2475
+ body: definitions["v1SetOrganizationFeatureRequest"];
2300
2476
  };
2301
2477
  };
2302
2478
  responses: {
@@ -2310,11 +2486,11 @@ export type operations = {
2310
2486
  };
2311
2487
  };
2312
2488
  };
2313
- /** Sign a transaction with a Private Key */
2314
- PublicApiService_SignTransaction: {
2489
+ /** Sign a raw payload */
2490
+ PublicApiService_SignRawPayload: {
2315
2491
  parameters: {
2316
2492
  body: {
2317
- body: definitions["v1SignTransactionRequest"];
2493
+ body: definitions["v1SignRawPayloadRequest"];
2318
2494
  };
2319
2495
  };
2320
2496
  responses: {
@@ -2328,11 +2504,11 @@ export type operations = {
2328
2504
  };
2329
2505
  };
2330
2506
  };
2331
- /** Sign a transaction with a Private Key id or address */
2332
- PublicApiService_SignTransactionV2: {
2507
+ /** Sign a transaction */
2508
+ PublicApiService_SignTransaction: {
2333
2509
  parameters: {
2334
2510
  body: {
2335
- body: definitions["v1SignTransactionV2Request"];
2511
+ body: definitions["v1SignTransactionRequest"];
2336
2512
  };
2337
2513
  };
2338
2514
  responses: {
@@ -2346,7 +2522,7 @@ export type operations = {
2346
2522
  };
2347
2523
  };
2348
2524
  };
2349
- /** Update the allowable origins for credentials and requests */
2525
+ /** Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations. */
2350
2526
  PublicApiService_UpdateAllowedOrigins: {
2351
2527
  parameters: {
2352
2528
  body: {