@turnkey/http 2.21.0 → 3.0.0

package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts

@@ -479,7 +479,7 @@ export type definitions = {
     /** @enum {string} */
     v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
     /** @enum {string} */
-    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" | "ACTIVITY_TYPE_UPDATE_WALLET";
+    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" | "ACTIVITY_TYPE_UPDATE_WALLET" | "ACTIVITY_TYPE_UPDATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_USERS_V3" | "ACTIVITY_TYPE_INIT_OTP_AUTH_V2";
     /** @enum {string} */
     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" | "ADDRESS_FORMAT_XRP";
     v1ApiKey: {
@@ -1081,14 +1081,18 @@ export type definitions = {
         /** @description A list of Users. */
         users: definitions["v1UserParamsV2"][];
     };
+    v1CreateUsersIntentV3: {
+        /** @description A list of Users. */
+        users: definitions["v1UserParamsV3"][];
+    };
     v1CreateUsersRequest: {
         /** @enum {string} */
-        type: "ACTIVITY_TYPE_CREATE_USERS_V2";
+        type: "ACTIVITY_TYPE_CREATE_USERS_V3";
         /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
         timestampMs: string;
         /** @description Unique identifier for a given Organization. */
         organizationId: string;
-        parameters: definitions["v1CreateUsersIntentV2"];
+        parameters: definitions["v1CreateUsersIntentV3"];
     };
     v1CreateUsersResult: {
         /** @description A list of User IDs. */
@@ -1380,6 +1384,8 @@ export type definitions = {
         invalidateExisting?: boolean;
         /** @description Optional custom email address from which to send the email */
         sendFromEmailAddress?: string;
+        /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
+        sendFromEmailSenderName?: string;
     };
     v1EmailAuthIntentV2: {
         /** @description Email of the authenticating user. */
@@ -1396,6 +1402,8 @@ export type definitions = {
         invalidateExisting?: boolean;
         /** @description Optional custom email address from which to send the email */
         sendFromEmailAddress?: string;
+        /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
+        sendFromEmailSenderName?: string;
     };
     v1EmailAuthRequest: {
         /** @enum {string} */
@@ -1835,20 +1843,49 @@ export type definitions = {
         userIdentifier?: string;
         /** @description Optional custom email address from which to send the OTP email */
         sendFromEmailAddress?: string;
+        /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
+        sendFromEmailSenderName?: string;
+    };
+    v1InitOtpAuthIntentV2: {
+        /** @description Enum to specifiy whether to send OTP via SMS or email */
+        otpType: string;
+        /** @description Email or phone number to send the OTP code to */
+        contact: string;
+        /**
+         * Format: int32
+         * @description Optional length of the OTP code. Default = 9
+         */
+        otpLength?: number;
+        /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
+        emailCustomization?: definitions["v1EmailCustomizationParams"];
+        /** @description Optional parameters for customizing SMS message. If not provided, the default sms message will be used. */
+        smsCustomization?: definitions["v1SmsCustomizationParams"];
+        /** @description Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address. */
+        userIdentifier?: string;
+        /** @description Optional custom email address from which to send the OTP email */
+        sendFromEmailAddress?: string;
+        /** @description Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true */
+        alphanumeric?: boolean;
+        /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
+        sendFromEmailSenderName?: string;
     };
     v1InitOtpAuthRequest: {
         /** @enum {string} */
-        type: "ACTIVITY_TYPE_INIT_OTP_AUTH";
+        type: "ACTIVITY_TYPE_INIT_OTP_AUTH_V2";
         /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
         timestampMs: string;
         /** @description Unique identifier for a given Organization. */
         organizationId: string;
-        parameters: definitions["v1InitOtpAuthIntent"];
+        parameters: definitions["v1InitOtpAuthIntentV2"];
     };
     v1InitOtpAuthResult: {
         /** @description Unique identifier for an OTP authentication */
         otpId: string;
     };
+    v1InitOtpAuthResultV2: {
+        /** @description Unique identifier for an OTP authentication */
+        otpId: string;
+    };
     v1InitUserEmailRecoveryIntent: {
         /** @description Email of the user starting recovery */
         email: string;
@@ -1953,6 +1990,9 @@ export type definitions = {
         otpAuthIntent?: definitions["v1OtpAuthIntent"];
         createSubOrganizationIntentV7?: definitions["v1CreateSubOrganizationIntentV7"];
         updateWalletIntent?: definitions["v1UpdateWalletIntent"];
+        updatePolicyIntentV2?: definitions["v1UpdatePolicyIntentV2"];
+        createUsersIntentV3?: definitions["v1CreateUsersIntentV3"];
+        initOtpAuthIntentV2?: definitions["v1InitOtpAuthIntentV2"];
     };
     v1Invitation: {
         /** @description Unique identifier for a given Invitation object. */
@@ -2073,10 +2113,10 @@ export type definitions = {
     v1OtpAuthIntent: {
         /** @description ID representing the result of an init OTP activity. */
         otpId: string;
-        /** @description 6 digit OTP code sent out to a user's contact (email or SMS) */
+        /** @description OTP sent out to a user's contact (email or SMS) */
         otpCode: string;
         /** @description Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted. */
-        targetPublicKey?: string;
+        targetPublicKey: string;
         /** @description Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp> */
         apiKeyName?: string;
         /** @description Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used. */
@@ -2289,6 +2329,8 @@ export type definitions = {
         otpAuthResult?: definitions["v1OtpAuthResult"];
         createSubOrganizationResultV7?: definitions["v1CreateSubOrganizationResultV7"];
         updateWalletResult?: definitions["v1UpdateWalletResult"];
+        updatePolicyResultV2?: definitions["v1UpdatePolicyResultV2"];
+        initOtpAuthResultV2?: definitions["v1InitOtpAuthResultV2"];
     };
     v1RootUserParams: {
         /** @description Human-readable name for a User. */
@@ -2500,19 +2542,37 @@ export type definitions = {
         /** @description Accompanying notes for a Policy (optional). */
         policyNotes?: string;
     };
+    v1UpdatePolicyIntentV2: {
+        /** @description Unique identifier for a given Policy. */
+        policyId: string;
+        /** @description Human-readable name for a Policy. */
+        policyName?: string;
+        /** @description The instruction to DENY or ALLOW an activity (optional). */
+        policyEffect?: definitions["v1Effect"];
+        /** @description The condition expression that triggers the Effect (optional). */
+        policyCondition?: string;
+        /** @description The consensus expression that triggers the Effect (optional). */
+        policyConsensus?: string;
+        /** @description Accompanying notes for a Policy (optional). */
+        policyNotes?: string;
+    };
     v1UpdatePolicyRequest: {
         /** @enum {string} */
-        type: "ACTIVITY_TYPE_UPDATE_POLICY";
+        type: "ACTIVITY_TYPE_UPDATE_POLICY_V2";
         /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
         timestampMs: string;
         /** @description Unique identifier for a given Organization. */
         organizationId: string;
-        parameters: definitions["v1UpdatePolicyIntent"];
+        parameters: definitions["v1UpdatePolicyIntentV2"];
     };
     v1UpdatePolicyResult: {
         /** @description Unique identifier for a given Policy. */
         policyId: string;
     };
+    v1UpdatePolicyResultV2: {
+        /** @description Unique identifier for a given Policy. */
+        policyId: string;
+    };
     v1UpdatePrivateKeyTagIntent: {
         /** @description Unique identifier for a given Private Key Tag. */
         privateKeyTagId: string;
@@ -2670,6 +2730,22 @@ export type definitions = {
         /** @description A list of User Tag IDs. This field, if not needed, should be an empty array in your request body. */
         userTags: string[];
     };
+    v1UserParamsV3: {
+        /** @description Human-readable name for a User. */
+        userName: string;
+        /** @description The user's email address. */
+        userEmail?: string;
+        /** @description The user's phone number in E.164 format e.g. +13214567890 */
+        userPhoneNumber?: string;
+        /** @description A list of API Key parameters. This field, if not needed, should be an empty array in your request body. */
+        apiKeys: definitions["v1ApiKeyParamsV2"][];
+        /** @description A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. */
+        authenticators: definitions["v1AuthenticatorParamsV2"][];
+        /** @description A list of Oauth providers. This field, if not needed, should be an empty array in your request body. */
+        oauthProviders: definitions["v1OauthProviderParams"][];
+        /** @description A list of User Tag IDs. This field, if not needed, should be an empty array in your request body. */
+        userTags: string[];
+    };
     v1Vote: {
         /** @description Unique identifier for a given Vote object. */
         id: string;