@turnkey/core 1.8.3 → 1.9.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.
@@ -67,6 +67,10 @@ export type paths = {
67
67
  /** Get details about a private key. */
68
68
  post: operations["PublicApiService_GetPrivateKey"];
69
69
  };
70
+ "/public/v1/query/get_send_transaction_status": {
71
+ /** Get the status of a send transaction request. */
72
+ post: operations["PublicApiService_GetSendTransactionStatus"];
73
+ };
70
74
  "/public/v1/query/get_smart_contract_interface": {
71
75
  /** Get details about a smart contract interface. */
72
76
  post: operations["PublicApiService_GetSmartContractInterface"];
@@ -626,7 +630,7 @@ export type definitions = {
626
630
  /** @enum {string} */
627
631
  v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
628
632
  /** @enum {string} */
629
- 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" | "ACTIVITY_TYPE_INIT_OTP" | "ACTIVITY_TYPE_VERIFY_OTP" | "ACTIVITY_TYPE_OTP_LOGIN" | "ACTIVITY_TYPE_STAMP_LOGIN" | "ACTIVITY_TYPE_OAUTH_LOGIN" | "ACTIVITY_TYPE_UPDATE_USER_NAME" | "ACTIVITY_TYPE_UPDATE_USER_EMAIL" | "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER" | "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP" | "ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_DELETE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_ENABLE_AUTH_PROXY" | "ACTIVITY_TYPE_DISABLE_AUTH_PROXY" | "ACTIVITY_TYPE_UPDATE_AUTH_PROXY_CONFIG" | "ACTIVITY_TYPE_CREATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_DELETE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_OAUTH2_AUTHENTICATE" | "ACTIVITY_TYPE_DELETE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_DELETE_POLICIES" | "ACTIVITY_TYPE_ETH_SEND_RAW_TRANSACTION" | "ACTIVITY_TYPE_ETH_SEND_TRANSACTION" | "ACTIVITY_TYPE_CREATE_FIAT_ON_RAMP_CREDENTIAL" | "ACTIVITY_TYPE_UPDATE_FIAT_ON_RAMP_CREDENTIAL" | "ACTIVITY_TYPE_DELETE_FIAT_ON_RAMP_CREDENTIAL";
633
+ 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" | "ACTIVITY_TYPE_INIT_OTP" | "ACTIVITY_TYPE_VERIFY_OTP" | "ACTIVITY_TYPE_OTP_LOGIN" | "ACTIVITY_TYPE_STAMP_LOGIN" | "ACTIVITY_TYPE_OAUTH_LOGIN" | "ACTIVITY_TYPE_UPDATE_USER_NAME" | "ACTIVITY_TYPE_UPDATE_USER_EMAIL" | "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER" | "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP" | "ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_DELETE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_ENABLE_AUTH_PROXY" | "ACTIVITY_TYPE_DISABLE_AUTH_PROXY" | "ACTIVITY_TYPE_UPDATE_AUTH_PROXY_CONFIG" | "ACTIVITY_TYPE_CREATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_DELETE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_OAUTH2_AUTHENTICATE" | "ACTIVITY_TYPE_DELETE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_DELETE_POLICIES" | "ACTIVITY_TYPE_ETH_SEND_RAW_TRANSACTION" | "ACTIVITY_TYPE_ETH_SEND_TRANSACTION" | "ACTIVITY_TYPE_CREATE_FIAT_ON_RAMP_CREDENTIAL" | "ACTIVITY_TYPE_UPDATE_FIAT_ON_RAMP_CREDENTIAL" | "ACTIVITY_TYPE_DELETE_FIAT_ON_RAMP_CREDENTIAL" | "ACTIVITY_TYPE_EMAIL_AUTH_V3" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY_V2" | "ACTIVITY_TYPE_INIT_OTP_AUTH_V3" | "ACTIVITY_TYPE_INIT_OTP_V2";
630
634
  /** @enum {string} */
631
635
  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_TON_V5R1" | "ADDRESS_FORMAT_XRP";
632
636
  v1ApiKey: {
@@ -1755,14 +1759,36 @@ export type definitions = {
1755
1759
  /** @description Optional custom email address to use as reply-to */
1756
1760
  replyToEmailAddress?: string;
1757
1761
  };
1762
+ v1EmailAuthIntentV3: {
1763
+ /** @description Email of the authenticating user. */
1764
+ email: string;
1765
+ /** @description Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted. */
1766
+ targetPublicKey: string;
1767
+ /** @description The name of the application. */
1768
+ appName: string;
1769
+ /** @description Optional human-readable name for an API Key. If none provided, default to Email Auth - <Timestamp> */
1770
+ apiKeyName?: string;
1771
+ /** @description Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. */
1772
+ expirationSeconds?: string;
1773
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
1774
+ emailCustomization?: definitions["v1EmailCustomizationParams"];
1775
+ /** @description Invalidate all other previously generated Email Auth API keys */
1776
+ invalidateExisting?: boolean;
1777
+ /** @description Optional custom email address from which to send the email */
1778
+ sendFromEmailAddress?: string;
1779
+ /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
1780
+ sendFromEmailSenderName?: string;
1781
+ /** @description Optional custom email address to use as reply-to */
1782
+ replyToEmailAddress?: string;
1783
+ };
1758
1784
  v1EmailAuthRequest: {
1759
1785
  /** @enum {string} */
1760
- type: "ACTIVITY_TYPE_EMAIL_AUTH_V2";
1786
+ type: "ACTIVITY_TYPE_EMAIL_AUTH_V3";
1761
1787
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1762
1788
  timestampMs: string;
1763
1789
  /** @description Unique identifier for a given Organization. */
1764
1790
  organizationId: string;
1765
- parameters: definitions["v1EmailAuthIntentV2"];
1791
+ parameters: definitions["v1EmailAuthIntentV3"];
1766
1792
  };
1767
1793
  v1EmailAuthResult: {
1768
1794
  /** @description Unique identifier for the authenticating User. */
@@ -1827,16 +1853,18 @@ export type definitions = {
1827
1853
  value?: string;
1828
1854
  /** @description Hex-encoded call data for contract interactions. */
1829
1855
  data?: string;
1830
- /** @description Transaction nonce. */
1831
- nonce: string;
1832
- /** @description Maximum amount of gas to use for this transaction. */
1833
- gasLimit: string;
1834
- /** @description Maximum total fee per gas unit (base fee + priority fee) in wei, for EIP-1559 transactions. */
1835
- maxFeePerGas: string;
1836
- /** @description Maximum priority fee (tip) per gas unit in wei, for EIP-1559 transactions. */
1837
- maxPriorityFeePerGas: string;
1856
+ /** @description Transaction nonce, for EIP-1559 and Turnkey Gas Station authorizations. */
1857
+ nonce?: string;
1858
+ /** @description Maximum amount of gas to use for this transaction, for EIP-1559 transactions. */
1859
+ gasLimit?: string;
1860
+ /** @description Maximum total fee per gas unit (base fee + priority fee) in wei. Required for non-sponsored (EIP-1559) transactions. Not used for sponsored transactions. */
1861
+ maxFeePerGas?: string;
1862
+ /** @description Maximum priority fee (tip) per gas unit in wei. Required for non-sponsored (EIP-1559) transactions. Not used for sponsored transactions. */
1863
+ maxPriorityFeePerGas?: string;
1838
1864
  /** @description Unix timestamp after which the Gas Station meta-transaction is no longer valid. Only used when sponsor=true. */
1839
1865
  deadline?: string;
1866
+ /** @description The gas station delegate contract nonce. Only used when sponsor=true. */
1867
+ gasStationNonce?: string;
1840
1868
  };
1841
1869
  v1EthSendTransactionRequest: {
1842
1870
  /** @enum {string} */
@@ -1848,8 +1876,8 @@ export type definitions = {
1848
1876
  parameters: definitions["v1EthSendTransactionIntent"];
1849
1877
  };
1850
1878
  v1EthSendTransactionResult: {
1851
- /** @description The transaction hash of the sent transaction */
1852
- transactionHash: string;
1879
+ /** @description The send_transaction_status ID associated with the transaction submission for sponsored transactions */
1880
+ sendTransactionStatusId: string;
1853
1881
  };
1854
1882
  v1ExportPrivateKeyIntent: {
1855
1883
  /** @description Unique identifier for a given Private Key. */
@@ -2138,6 +2166,20 @@ export type definitions = {
2138
2166
  /** @description A list of private keys. */
2139
2167
  privateKeys: definitions["v1PrivateKey"][];
2140
2168
  };
2169
+ v1GetSendTransactionStatusRequest: {
2170
+ /** @description Unique identifier for a given organization. */
2171
+ organizationId: string;
2172
+ /** @description The unique identifier of a send transaction request. */
2173
+ sendTransactionStatusId: string;
2174
+ };
2175
+ v1GetSendTransactionStatusResponse: {
2176
+ /** @description The current status of the send transaction. */
2177
+ txStatus: string;
2178
+ /** @description The blockchain transaction hash, if available. */
2179
+ txHash?: string;
2180
+ /** @description The error encountered when broadcasting or confirming the transaction, if any. */
2181
+ txError?: string;
2182
+ };
2141
2183
  v1GetSmartContractInterfaceRequest: {
2142
2184
  /** @description Unique identifier for a given organization. */
2143
2185
  organizationId: string;
@@ -2434,14 +2476,41 @@ export type definitions = {
2434
2476
  /** @description Optional custom email address to use as reply-to */
2435
2477
  replyToEmailAddress?: string;
2436
2478
  };
2479
+ v1InitOtpAuthIntentV3: {
2480
+ /** @description Enum to specifiy whether to send OTP via SMS or email */
2481
+ otpType: string;
2482
+ /** @description Email or phone number to send the OTP code to */
2483
+ contact: string;
2484
+ /** @description The name of the application. */
2485
+ appName: string;
2486
+ /**
2487
+ * Format: int32
2488
+ * @description Optional length of the OTP code. Default = 9
2489
+ */
2490
+ otpLength?: number;
2491
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
2492
+ emailCustomization?: definitions["v1EmailCustomizationParams"];
2493
+ /** @description Optional parameters for customizing SMS message. If not provided, the default sms message will be used. */
2494
+ smsCustomization?: definitions["v1SmsCustomizationParams"];
2495
+ /** @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. */
2496
+ userIdentifier?: string;
2497
+ /** @description Optional custom email address from which to send the OTP email */
2498
+ sendFromEmailAddress?: string;
2499
+ /** @description Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true */
2500
+ alphanumeric?: boolean;
2501
+ /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
2502
+ sendFromEmailSenderName?: string;
2503
+ /** @description Optional custom email address to use as reply-to */
2504
+ replyToEmailAddress?: string;
2505
+ };
2437
2506
  v1InitOtpAuthRequest: {
2438
2507
  /** @enum {string} */
2439
- type: "ACTIVITY_TYPE_INIT_OTP_AUTH_V2";
2508
+ type: "ACTIVITY_TYPE_INIT_OTP_AUTH_V3";
2440
2509
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
2441
2510
  timestampMs: string;
2442
2511
  /** @description Unique identifier for a given Organization. */
2443
2512
  organizationId: string;
2444
- parameters: definitions["v1InitOtpAuthIntentV2"];
2513
+ parameters: definitions["v1InitOtpAuthIntentV3"];
2445
2514
  };
2446
2515
  v1InitOtpAuthResult: {
2447
2516
  /** @description Unique identifier for an OTP authentication */
@@ -2478,14 +2547,43 @@ export type definitions = {
2478
2547
  /** @description Optional custom email address to use as reply-to */
2479
2548
  replyToEmailAddress?: string;
2480
2549
  };
2550
+ v1InitOtpIntentV2: {
2551
+ /** @description Whether to send OTP via SMS or email. Possible values: OTP_TYPE_SMS, OTP_TYPE_EMAIL */
2552
+ otpType: string;
2553
+ /** @description Email or phone number to send the OTP code to */
2554
+ contact: string;
2555
+ /** @description The name of the application. */
2556
+ appName: string;
2557
+ /**
2558
+ * Format: int32
2559
+ * @description Optional length of the OTP code. Default = 9
2560
+ */
2561
+ otpLength?: number;
2562
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
2563
+ emailCustomization?: definitions["v1EmailCustomizationParams"];
2564
+ /** @description Optional parameters for customizing SMS message. If not provided, the default sms message will be used. */
2565
+ smsCustomization?: definitions["v1SmsCustomizationParams"];
2566
+ /** @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. */
2567
+ userIdentifier?: string;
2568
+ /** @description Optional custom email address from which to send the OTP email */
2569
+ sendFromEmailAddress?: string;
2570
+ /** @description Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true */
2571
+ alphanumeric?: boolean;
2572
+ /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
2573
+ sendFromEmailSenderName?: string;
2574
+ /** @description Expiration window (in seconds) indicating how long the OTP is valid for. If not provided, a default of 5 minutes will be used. Maximum value is 600 seconds (10 minutes) */
2575
+ expirationSeconds?: string;
2576
+ /** @description Optional custom email address to use as reply-to */
2577
+ replyToEmailAddress?: string;
2578
+ };
2481
2579
  v1InitOtpRequest: {
2482
2580
  /** @enum {string} */
2483
- type: "ACTIVITY_TYPE_INIT_OTP";
2581
+ type: "ACTIVITY_TYPE_INIT_OTP_V2";
2484
2582
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
2485
2583
  timestampMs: string;
2486
2584
  /** @description Unique identifier for a given Organization. */
2487
2585
  organizationId: string;
2488
- parameters: definitions["v1InitOtpIntent"];
2586
+ parameters: definitions["v1InitOtpIntentV2"];
2489
2587
  };
2490
2588
  v1InitOtpResult: {
2491
2589
  /** @description Unique identifier for an OTP authentication */
@@ -2507,14 +2605,32 @@ export type definitions = {
2507
2605
  /** @description Optional custom email address to use as reply-to */
2508
2606
  replyToEmailAddress?: string;
2509
2607
  };
2608
+ v1InitUserEmailRecoveryIntentV2: {
2609
+ /** @description Email of the user starting recovery */
2610
+ email: string;
2611
+ /** @description Client-side public key generated by the user, to which the recovery bundle will be encrypted. */
2612
+ targetPublicKey: string;
2613
+ /** @description The name of the application. */
2614
+ appName: string;
2615
+ /** @description Expiration window (in seconds) indicating how long the recovery credential is valid for. If not provided, a default of 15 minutes will be used. */
2616
+ expirationSeconds?: string;
2617
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
2618
+ emailCustomization?: definitions["v1EmailCustomizationParams"];
2619
+ /** @description Optional custom email address from which to send the OTP email */
2620
+ sendFromEmailAddress?: string;
2621
+ /** @description Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' */
2622
+ sendFromEmailSenderName?: string;
2623
+ /** @description Optional custom email address to use as reply-to */
2624
+ replyToEmailAddress?: string;
2625
+ };
2510
2626
  v1InitUserEmailRecoveryRequest: {
2511
2627
  /** @enum {string} */
2512
- type: "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY";
2628
+ type: "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY_V2";
2513
2629
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
2514
2630
  timestampMs: string;
2515
2631
  /** @description Unique identifier for a given Organization. */
2516
2632
  organizationId: string;
2517
- parameters: definitions["v1InitUserEmailRecoveryIntent"];
2633
+ parameters: definitions["v1InitUserEmailRecoveryIntentV2"];
2518
2634
  };
2519
2635
  v1InitUserEmailRecoveryResult: {
2520
2636
  /** @description Unique identifier for the user being recovered. */
@@ -2629,6 +2745,10 @@ export type definitions = {
2629
2745
  createFiatOnRampCredentialIntent?: definitions["v1CreateFiatOnRampCredentialIntent"];
2630
2746
  updateFiatOnRampCredentialIntent?: definitions["v1UpdateFiatOnRampCredentialIntent"];
2631
2747
  deleteFiatOnRampCredentialIntent?: definitions["v1DeleteFiatOnRampCredentialIntent"];
2748
+ emailAuthIntentV3?: definitions["v1EmailAuthIntentV3"];
2749
+ initUserEmailRecoveryIntentV2?: definitions["v1InitUserEmailRecoveryIntentV2"];
2750
+ initOtpIntentV2?: definitions["v1InitOtpIntentV2"];
2751
+ initOtpAuthIntentV3?: definitions["v1InitOtpAuthIntentV3"];
2632
2752
  };
2633
2753
  v1Invitation: {
2634
2754
  /** @description Unique identifier for a given Invitation object. */
@@ -3358,7 +3478,7 @@ export type definitions = {
3358
3478
  emailAuthTemplateId?: string;
3359
3479
  /** @description Template ID for OTP SMS messages. */
3360
3480
  otpTemplateId?: string;
3361
- /** @description Overrides for auth-related email content. */
3481
+ /** @description Optional parameters for customizing emails. If not provided, the default email will be used. */
3362
3482
  emailCustomizationParams?: definitions["v1EmailCustomizationParams"];
3363
3483
  /** @description Overrides for auth-related SMS content. */
3364
3484
  smsCustomizationParams?: definitions["v1SmsCustomizationParams"];
@@ -4149,6 +4269,24 @@ export type operations = {
4149
4269
  };
4150
4270
  };
4151
4271
  };
4272
+ /** Get the status of a send transaction request. */
4273
+ PublicApiService_GetSendTransactionStatus: {
4274
+ parameters: {
4275
+ body: {
4276
+ body: definitions["v1GetSendTransactionStatusRequest"];
4277
+ };
4278
+ };
4279
+ responses: {
4280
+ /** A successful response. */
4281
+ 200: {
4282
+ schema: definitions["v1GetSendTransactionStatusResponse"];
4283
+ };
4284
+ /** An unexpected error response. */
4285
+ default: {
4286
+ schema: definitions["rpcStatus"];
4287
+ };
4288
+ };
4289
+ };
4152
4290
  /** Get details about a smart contract interface. */
4153
4291
  PublicApiService_GetSmartContractInterface: {
4154
4292
  parameters: {