@turnkey/http 2.14.2 → 2.16.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.
@@ -239,6 +239,10 @@ export type paths = {
239
239
  /** Initializes a new wallet import */
240
240
  post: operations["PublicApiService_InitImportWallet"];
241
241
  };
242
+ "/public/v1/submit/init_otp_auth": {
243
+ /** Initiate an OTP auth activity */
244
+ post: operations["PublicApiService_InitOtpAuth"];
245
+ };
242
246
  "/public/v1/submit/init_user_email_recovery": {
243
247
  /** Initializes a new email recovery */
244
248
  post: operations["PublicApiService_InitUserEmailRecovery"];
@@ -247,6 +251,10 @@ export type paths = {
247
251
  /** Authenticate a user with an Oidc token (Oauth) - BETA */
248
252
  post: operations["PublicApiService_Oauth"];
249
253
  };
254
+ "/public/v1/submit/otp_auth": {
255
+ /** Authenticate a user with an OTP code sent via email or SMS */
256
+ post: operations["PublicApiService_OtpAuth"];
257
+ };
250
258
  "/public/v1/submit/recover_user": {
251
259
  /** Completes the process of recovering a user by adding an authenticator */
252
260
  post: operations["PublicApiService_RecoverUser"];
@@ -256,11 +264,11 @@ export type paths = {
256
264
  post: operations["PublicApiService_RejectActivity"];
257
265
  };
258
266
  "/public/v1/submit/remove_organization_feature": {
259
- /** Removes an organization feature */
267
+ /** Removes an organization feature. This activity must be approved by the current root quorum. */
260
268
  post: operations["PublicApiService_RemoveOrganizationFeature"];
261
269
  };
262
270
  "/public/v1/submit/set_organization_feature": {
263
- /** Sets an organization feature */
271
+ /** Sets an organization feature. This activity must be approved by the current root quorum. */
264
272
  post: operations["PublicApiService_SetOrganizationFeature"];
265
273
  };
266
274
  "/public/v1/submit/sign_raw_payload": {
@@ -284,7 +292,7 @@ export type paths = {
284
292
  post: operations["PublicApiService_UpdatePrivateKeyTag"];
285
293
  };
286
294
  "/public/v1/submit/update_root_quorum": {
287
- /** Set the threshold and members of the root quorum. This must be approved by the current root quorum. */
295
+ /** Set the threshold and members of the root quorum. This activity must be approved by the current root quorum. */
288
296
  post: operations["PublicApiService_UpdateRootQuorum"];
289
297
  };
290
298
  "/public/v1/submit/update_user": {
@@ -455,9 +463,9 @@ export type definitions = {
455
463
  /** @enum {string} */
456
464
  v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
457
465
  /** @enum {string} */
458
- 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" | "ACTIVITY_TYPE_EMAIL_AUTH" | "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT" | "ACTIVITY_TYPE_INIT_IMPORT_WALLET" | "ACTIVITY_TYPE_IMPORT_WALLET" | "ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_CREATE_POLICIES" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS" | "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION" | "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5" | "ACTIVITY_TYPE_OAUTH" | "ACTIVITY_TYPE_CREATE_API_KEYS_V2" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION" | "ACTIVITY_TYPE_EMAIL_AUTH_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEYS" | "ACTIVITY_TYPE_DELETE_WALLETS" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2" | "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION";
466
+ 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" | "ACTIVITY_TYPE_EMAIL_AUTH" | "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT" | "ACTIVITY_TYPE_INIT_IMPORT_WALLET" | "ACTIVITY_TYPE_IMPORT_WALLET" | "ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_CREATE_POLICIES" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS" | "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION" | "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5" | "ACTIVITY_TYPE_OAUTH" | "ACTIVITY_TYPE_CREATE_API_KEYS_V2" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION" | "ACTIVITY_TYPE_EMAIL_AUTH_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEYS" | "ACTIVITY_TYPE_DELETE_WALLETS" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2" | "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_INIT_OTP_AUTH" | "ACTIVITY_TYPE_OTP_AUTH" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7";
459
467
  /** @enum {string} */
460
- v1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM" | "ADDRESS_FORMAT_SOLANA" | "ADDRESS_FORMAT_COSMOS" | "ADDRESS_FORMAT_TRON" | "ADDRESS_FORMAT_SUI" | "ADDRESS_FORMAT_APTOS" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR";
468
+ v1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM" | "ADDRESS_FORMAT_SOLANA" | "ADDRESS_FORMAT_COSMOS" | "ADDRESS_FORMAT_TRON" | "ADDRESS_FORMAT_SUI" | "ADDRESS_FORMAT_APTOS" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR" | "ADDRESS_FORMAT_SEI" | "ADDRESS_FORMAT_XLM" | "ADDRESS_FORMAT_DOGE_MAINNET" | "ADDRESS_FORMAT_DOGE_TESTNET" | "ADDRESS_FORMAT_TON_V3R2" | "ADDRESS_FORMAT_TON_V4R2";
461
469
  v1ApiKey: {
462
470
  /** @description A User credential that can be used to authenticate to Turnkey. */
463
471
  credential: definitions["externaldatav1Credential"];
@@ -966,14 +974,35 @@ export type definitions = {
966
974
  /** @description Disable email auth for the sub-organization */
967
975
  disableEmailAuth?: boolean;
968
976
  };
977
+ v1CreateSubOrganizationIntentV7: {
978
+ /** @description Name for this sub-organization */
979
+ subOrganizationName: string;
980
+ /** @description Root users to create within this sub-organization */
981
+ rootUsers: definitions["v1RootUserParamsV4"][];
982
+ /**
983
+ * Format: int32
984
+ * @description The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
985
+ */
986
+ rootQuorumThreshold: number;
987
+ /** @description The wallet to create for the sub-organization */
988
+ wallet?: definitions["v1WalletParams"];
989
+ /** @description Disable email recovery for the sub-organization */
990
+ disableEmailRecovery?: boolean;
991
+ /** @description Disable email auth for the sub-organization */
992
+ disableEmailAuth?: boolean;
993
+ /** @description Disable OTP SMS auth for the sub-organization */
994
+ disableSmsAuth?: boolean;
995
+ /** @description Disable OTP email auth for the sub-organization */
996
+ disableOtpEmailAuth?: boolean;
997
+ };
969
998
  v1CreateSubOrganizationRequest: {
970
999
  /** @enum {string} */
971
- type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6";
1000
+ type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7";
972
1001
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
973
1002
  timestampMs: string;
974
1003
  /** @description Unique identifier for a given Organization. */
975
1004
  organizationId: string;
976
- parameters: definitions["v1CreateSubOrganizationIntentV6"];
1005
+ parameters: definitions["v1CreateSubOrganizationIntentV7"];
977
1006
  };
978
1007
  v1CreateSubOrganizationResult: {
979
1008
  subOrganizationId: string;
@@ -1000,6 +1029,11 @@ export type definitions = {
1000
1029
  wallet?: definitions["v1WalletResult"];
1001
1030
  rootUserIds?: string[];
1002
1031
  };
1032
+ v1CreateSubOrganizationResultV7: {
1033
+ subOrganizationId: string;
1034
+ wallet?: definitions["v1WalletResult"];
1035
+ rootUserIds?: string[];
1036
+ };
1003
1037
  v1CreateUserTagIntent: {
1004
1038
  /** @description Human-readable name for a User Tag. */
1005
1039
  userTagName: string;
@@ -1091,7 +1125,7 @@ export type definitions = {
1091
1125
  rk: boolean;
1092
1126
  };
1093
1127
  /** @enum {string} */
1094
- v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256" | "CREDENTIAL_TYPE_RECOVER_USER_KEY_P256" | "CREDENTIAL_TYPE_API_KEY_SECP256K1" | "CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256" | "CREDENTIAL_TYPE_API_KEY_ED25519";
1128
+ v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256" | "CREDENTIAL_TYPE_RECOVER_USER_KEY_P256" | "CREDENTIAL_TYPE_API_KEY_SECP256K1" | "CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256" | "CREDENTIAL_TYPE_API_KEY_ED25519" | "CREDENTIAL_TYPE_OTP_AUTH_KEY_P256";
1095
1129
  /** @enum {string} */
1096
1130
  v1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
1097
1131
  v1DeleteApiKeysIntent: {
@@ -1438,7 +1472,7 @@ export type definitions = {
1438
1472
  value?: string;
1439
1473
  };
1440
1474
  /** @enum {string} */
1441
- v1FeatureName: "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK";
1475
+ v1FeatureName: "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK" | "FEATURE_NAME_SMS_AUTH" | "FEATURE_NAME_OTP_EMAIL_AUTH";
1442
1476
  v1GetActivitiesRequest: {
1443
1477
  /** @description Unique identifier for a given Organization. */
1444
1478
  organizationId: string;
@@ -1738,6 +1772,27 @@ export type definitions = {
1738
1772
  /** @description Import bundle containing a public key and signature to use for importing client data. */
1739
1773
  importBundle: string;
1740
1774
  };
1775
+ v1InitOtpAuthIntent: {
1776
+ /** @description Enum to specifiy whether to send OTP via SMS or email */
1777
+ otpType: string;
1778
+ /** @description Email or phone number to send the OTP code to */
1779
+ contact: string;
1780
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
1781
+ emailCustomization?: definitions["v1EmailCustomizationParams"];
1782
+ };
1783
+ v1InitOtpAuthRequest: {
1784
+ /** @enum {string} */
1785
+ type: "ACTIVITY_TYPE_INIT_OTP_AUTH";
1786
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1787
+ timestampMs: string;
1788
+ /** @description Unique identifier for a given Organization. */
1789
+ organizationId: string;
1790
+ parameters: definitions["v1InitOtpAuthIntent"];
1791
+ };
1792
+ v1InitOtpAuthResult: {
1793
+ /** @description Unique identifier for an OTP authentication */
1794
+ otpId: string;
1795
+ };
1741
1796
  v1InitUserEmailRecoveryIntent: {
1742
1797
  /** @description Email of the user starting recovery */
1743
1798
  email: string;
@@ -1838,6 +1893,9 @@ export type definitions = {
1838
1893
  deleteWalletsIntent?: definitions["v1DeleteWalletsIntent"];
1839
1894
  createReadWriteSessionIntentV2?: definitions["v1CreateReadWriteSessionIntentV2"];
1840
1895
  deleteSubOrganizationIntent?: definitions["v1DeleteSubOrganizationIntent"];
1896
+ initOtpAuthIntent?: definitions["v1InitOtpAuthIntent"];
1897
+ otpAuthIntent?: definitions["v1OtpAuthIntent"];
1898
+ createSubOrganizationIntentV7?: definitions["v1CreateSubOrganizationIntentV7"];
1841
1899
  };
1842
1900
  v1Invitation: {
1843
1901
  /** @description Unique identifier for a given Invitation object. */
@@ -1953,6 +2011,37 @@ export type definitions = {
1953
2011
  features?: definitions["v1Feature"][];
1954
2012
  wallets?: definitions["v1Wallet"][];
1955
2013
  };
2014
+ v1OtpAuthIntent: {
2015
+ /** @description ID representing the result of an init OTP activity. */
2016
+ otpId: string;
2017
+ /** @description 6 digit OTP code sent out to a user's contact (email or SMS) */
2018
+ otpCode: string;
2019
+ /** @description Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted. */
2020
+ targetPublicKey?: string;
2021
+ /** @description Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp> */
2022
+ apiKeyName?: string;
2023
+ /** @description Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used. */
2024
+ expirationSeconds?: string;
2025
+ /** @description Invalidate all other previously generated OTP Auth API keys */
2026
+ invalidateExisting?: boolean;
2027
+ };
2028
+ v1OtpAuthRequest: {
2029
+ /** @enum {string} */
2030
+ type: "ACTIVITY_TYPE_OTP_AUTH";
2031
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
2032
+ timestampMs: string;
2033
+ /** @description Unique identifier for a given Organization. */
2034
+ organizationId: string;
2035
+ parameters: definitions["v1OtpAuthIntent"];
2036
+ };
2037
+ v1OtpAuthResult: {
2038
+ /** @description Unique identifier for the authenticating User. */
2039
+ userId: string;
2040
+ /** @description Unique identifier for the created API key. */
2041
+ apiKeyId?: string;
2042
+ /** @description HPKE encrypted credential bundle */
2043
+ credentialBundle?: string;
2044
+ };
1956
2045
  v1Pagination: {
1957
2046
  /** @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10. */
1958
2047
  limit?: string;
@@ -2137,6 +2226,9 @@ export type definitions = {
2137
2226
  deleteWalletsResult?: definitions["v1DeleteWalletsResult"];
2138
2227
  createReadWriteSessionResultV2?: definitions["v1CreateReadWriteSessionResultV2"];
2139
2228
  deleteSubOrganizationResult?: definitions["v1DeleteSubOrganizationResult"];
2229
+ initOtpAuthResult?: definitions["v1InitOtpAuthResult"];
2230
+ otpAuthResult?: definitions["v1OtpAuthResult"];
2231
+ createSubOrganizationResultV7?: definitions["v1CreateSubOrganizationResultV7"];
2140
2232
  };
2141
2233
  v1RootUserParams: {
2142
2234
  /** @description Human-readable name for a User. */
@@ -2172,6 +2264,20 @@ export type definitions = {
2172
2264
  /** @description A list of Oauth providers. */
2173
2265
  oauthProviders: definitions["v1OauthProviderParams"][];
2174
2266
  };
2267
+ v1RootUserParamsV4: {
2268
+ /** @description Human-readable name for a User. */
2269
+ userName: string;
2270
+ /** @description The user's email address. */
2271
+ userEmail?: string;
2272
+ /** @description The user's phone number in E.164 format e.g. +13214567890 */
2273
+ userPhoneNumber?: string;
2274
+ /** @description A list of API Key parameters. */
2275
+ apiKeys: definitions["v1ApiKeyParamsV2"][];
2276
+ /** @description A list of Authenticator parameters. */
2277
+ authenticators: definitions["v1AuthenticatorParamsV2"][];
2278
+ /** @description A list of Oauth providers. */
2279
+ oauthProviders: definitions["v1OauthProviderParams"][];
2280
+ };
2175
2281
  v1Selector: {
2176
2282
  subject?: string;
2177
2283
  operator?: definitions["v1Operator"];
@@ -2382,6 +2488,8 @@ export type definitions = {
2382
2488
  userEmail?: string;
2383
2489
  /** @description An updated list of User Tags to apply to this User. */
2384
2490
  userTagIds?: string[];
2491
+ /** @description The user's phone number in E.164 format e.g. +13214567890 */
2492
+ userPhoneNumber?: string;
2385
2493
  };
2386
2494
  v1UpdateUserRequest: {
2387
2495
  /** @enum {string} */
@@ -2426,6 +2534,8 @@ export type definitions = {
2426
2534
  userName: string;
2427
2535
  /** @description The user's email address. */
2428
2536
  userEmail?: string;
2537
+ /** @description The user's phone number in E.164 format e.g. +13214567890 */
2538
+ userPhoneNumber?: string;
2429
2539
  /** @description A list of Authenticator parameters. */
2430
2540
  authenticators: definitions["v1Authenticator"][];
2431
2541
  /** @description A list of API Key parameters. */
@@ -3614,6 +3724,24 @@ export type operations = {
3614
3724
  };
3615
3725
  };
3616
3726
  };
3727
+ /** Initiate an OTP auth activity */
3728
+ PublicApiService_InitOtpAuth: {
3729
+ parameters: {
3730
+ body: {
3731
+ body: definitions["v1InitOtpAuthRequest"];
3732
+ };
3733
+ };
3734
+ responses: {
3735
+ /** A successful response. */
3736
+ 200: {
3737
+ schema: definitions["v1ActivityResponse"];
3738
+ };
3739
+ /** An unexpected error response. */
3740
+ default: {
3741
+ schema: definitions["rpcStatus"];
3742
+ };
3743
+ };
3744
+ };
3617
3745
  /** Initializes a new email recovery */
3618
3746
  PublicApiService_InitUserEmailRecovery: {
3619
3747
  parameters: {
@@ -3650,6 +3778,24 @@ export type operations = {
3650
3778
  };
3651
3779
  };
3652
3780
  };
3781
+ /** Authenticate a user with an OTP code sent via email or SMS */
3782
+ PublicApiService_OtpAuth: {
3783
+ parameters: {
3784
+ body: {
3785
+ body: definitions["v1OtpAuthRequest"];
3786
+ };
3787
+ };
3788
+ responses: {
3789
+ /** A successful response. */
3790
+ 200: {
3791
+ schema: definitions["v1ActivityResponse"];
3792
+ };
3793
+ /** An unexpected error response. */
3794
+ default: {
3795
+ schema: definitions["rpcStatus"];
3796
+ };
3797
+ };
3798
+ };
3653
3799
  /** Completes the process of recovering a user by adding an authenticator */
3654
3800
  PublicApiService_RecoverUser: {
3655
3801
  parameters: {
@@ -3686,7 +3832,7 @@ export type operations = {
3686
3832
  };
3687
3833
  };
3688
3834
  };
3689
- /** Removes an organization feature */
3835
+ /** Removes an organization feature. This activity must be approved by the current root quorum. */
3690
3836
  PublicApiService_RemoveOrganizationFeature: {
3691
3837
  parameters: {
3692
3838
  body: {
@@ -3704,7 +3850,7 @@ export type operations = {
3704
3850
  };
3705
3851
  };
3706
3852
  };
3707
- /** Sets an organization feature */
3853
+ /** Sets an organization feature. This activity must be approved by the current root quorum. */
3708
3854
  PublicApiService_SetOrganizationFeature: {
3709
3855
  parameters: {
3710
3856
  body: {
@@ -3812,7 +3958,7 @@ export type operations = {
3812
3958
  };
3813
3959
  };
3814
3960
  };
3815
- /** Set the threshold and members of the root quorum. This must be approved by the current root quorum. */
3961
+ /** Set the threshold and members of the root quorum. This activity must be approved by the current root quorum. */
3816
3962
  PublicApiService_UpdateRootQuorum: {
3817
3963
  parameters: {
3818
3964
  body: {