@coinbase/cdp-api-client 0.0.68 → 0.0.69

package/dist/types/index.d.ts

@@ -56,14 +56,15 @@ export declare interface Account {
     accountId: AccountId;
     type: AccountType;
     owner: Owner;
-    name?: string;
-    projectIds?: ProjectId[];
+    name?: AccountName;
     createdAt: string;
     updatedAt: string;
 }
 
 export declare type AccountId = string;
 
+export declare type AccountName = string;
+
 export declare interface AccountTokenAddressesResponse {
     accountAddress?: string;
     tokenAddresses?: string[];
@@ -113,6 +114,11 @@ export declare const AddressRiskRiskLevel: {
 
 export declare type AlreadyExistsErrorResponse = Error_2;
 
+export declare interface AmountDetail {
+    available: string;
+    total: string;
+}
+
 export declare class APIError extends Error {
     statusCode: number;
     errorType: APIErrorType;
@@ -177,10 +183,13 @@ export declare type BadGatewayErrorResponse = Error_2;
 
 export declare interface Balance {
     asset: Asset;
-    availableAmount: string;
-    totalAmount: string;
+    amount: BalanceAmount;
 }
 
+export declare type BalanceAmount = {
+    [key: string]: AmountDetail;
+};
+
 export declare interface Balances {
     balances: Balance[];
 }
@@ -284,12 +293,9 @@ export declare const CoolPaymentMethodType: {
 
 export declare interface CreateAccountRequest {
     owner: string;
-    name?: string;
-    projectIds?: ProjectId[];
+    name?: AccountName;
 }
 
-export declare const createCustomAuthConfig: (projectId: string, createCustomAuthConfigRequest: CreateCustomAuthConfigRequest, options?: SecondParameter<typeof cdpApiClient>) => Promise<CustomAuthConfig>;
-
 export declare interface CreateCustomAuthConfigRequest {
     enabled: boolean;
     jwksUrl: string;
@@ -297,7 +303,22 @@ export declare interface CreateCustomAuthConfigRequest {
     audience?: string;
 }
 
-export declare type CreateCustomAuthConfigResult = NonNullable<Awaited<ReturnType<typeof createCustomAuthConfig>>>;
+export declare interface CreateDepositDestinationRequest {
+    accountId: AccountId;
+    type: CreateDepositDestinationRequestType;
+    network: Network;
+    metadata?: CreateDepositDestinationRequestMetadata;
+}
+
+export declare type CreateDepositDestinationRequestMetadata = {
+    [key: string]: string;
+};
+
+export declare type CreateDepositDestinationRequestType = (typeof CreateDepositDestinationRequestType)[keyof typeof CreateDepositDestinationRequestType];
+
+export declare const CreateDepositDestinationRequestType: {
+    readonly crypto: "crypto";
+};
 
 export declare const createEndUserEvmAccount: (projectId: string, userId: string, createEndUserEvmAccountBody: CreateEndUserEvmAccountBody, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
 
@@ -391,6 +412,29 @@ export declare type CreateSwapQuoteResponseAllOfTransaction = {
 
 export declare type CreateSwapQuoteResponseWrapper = CreateSwapQuoteResponse | SwapUnavailableResponse;
 
+export declare type CreateTransferSource = TransfersAccount | PaymentMethod;
+
+export declare interface CryptoDepositDestination {
+    depositDestinationId: DepositDestinationId;
+    accountId: AccountId;
+    type: CryptoDepositDestinationType;
+    address: string;
+    network: Network;
+    metadata?: CryptoDepositDestinationMetadata;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export declare type CryptoDepositDestinationMetadata = {
+    [key: string]: string;
+};
+
+export declare type CryptoDepositDestinationType = (typeof CryptoDepositDestinationType)[keyof typeof CryptoDepositDestinationType];
+
+export declare const CryptoDepositDestinationType: {
+    readonly crypto: "crypto";
+};
+
 export declare interface CustomAuthConfig {
     enabled: boolean;
     jwksUrl: string;
@@ -453,6 +497,16 @@ export declare interface DateOfBirth {
     year?: string;
 }
 
+export declare type DepositDestination = CryptoDepositDestination;
+
+export declare type DepositDestinationId = string;
+
+export declare type DepositDestinationType = (typeof DepositDestinationType)[keyof typeof DepositDestinationType];
+
+export declare const DepositDestinationType: {
+    readonly crypto: "crypto";
+};
+
 export declare interface DeveloperJWTAuthentication {
     type: DeveloperJWTAuthenticationType;
     kid: string;
@@ -513,6 +567,7 @@ export declare const EmailAuthenticationType: {
 export declare interface EndUser {
     userId: string;
     authenticationMethods: AuthenticationMethods;
+    mfaMethods?: MFAMethods;
     evmAccounts: string[];
     evmSmartAccounts: string[];
     solanaAccounts: string[];
@@ -577,6 +632,14 @@ export declare const ErrorType: {
     readonly recipient_allowlist_violation: "recipient_allowlist_violation";
     readonly recipient_allowlist_pending: "recipient_allowlist_pending";
     readonly travel_rules_recipient_violation: "travel_rules_recipient_violation";
+    readonly transfer_amount_out_of_bounds: "transfer_amount_out_of_bounds";
+    readonly transfer_recipient_address_invalid: "transfer_recipient_address_invalid";
+    readonly transfer_quote_expired: "transfer_quote_expired";
+    readonly mfa_already_enrolled: "mfa_already_enrolled";
+    readonly mfa_invalid_code: "mfa_invalid_code";
+    readonly mfa_flow_expired: "mfa_flow_expired";
+    readonly mfa_required: "mfa_required";
+    readonly mfa_not_enrolled: "mfa_not_enrolled";
 };
 
 export declare interface EthValueCriterion {
@@ -846,6 +909,7 @@ export declare type ExportEndUserEvmAccountBody = {
     address: string;
     exportEncryptionKey: string;
     walletSecretId: string;
+    parentOrigin?: string;
 };
 
 export declare type ExportEndUserEvmAccountResult = NonNullable<Awaited<ReturnType<typeof exportEndUserEvmAccount>>>;
@@ -860,6 +924,7 @@ export declare type ExportEndUserSolanaAccountBody = {
     address: string;
     exportEncryptionKey: string;
     walletSecretId: string;
+    parentOrigin?: string;
 };
 
 export declare type ExportEndUserSolanaAccountResult = NonNullable<Awaited<ReturnType<typeof exportEndUserSolanaAccount>>>;
@@ -1017,6 +1082,21 @@ export declare interface InitiateEmailAuthenticationResponse {
     nextStep: InitiateEmailAuthenticationNextStep;
 }
 
+export declare const initiateMfaEnrollment: (projectId: string, userId: string, mfaMethod: "totp", options?: SecondParameter<typeof cdpApiClient>) => Promise< InitiateMfaEnrollmentTotpResponse>;
+
+export declare type InitiateMfaEnrollmentResponseWrapper = InitiateMfaEnrollmentTotpResponse;
+
+export declare type InitiateMfaEnrollmentResult = NonNullable<Awaited<ReturnType<typeof initiateMfaEnrollment>>>;
+
+export declare interface InitiateMfaEnrollmentTotpResponse {
+    authUrl: string;
+    secret: string;
+}
+
+export declare const initiateMfaVerification: (projectId: string, userId: string, mfaMethod: "totp", options?: SecondParameter<typeof cdpApiClient>) => Promise<void>;
+
+export declare type InitiateMfaVerificationResult = NonNullable<Awaited<ReturnType<typeof initiateMfaVerification>>>;
+
 export declare interface InitiateOAuthAuthenticationRequest {
     type: OAuth2ProviderType;
     redirectUrl: string;
@@ -1210,6 +1290,32 @@ export declare type LogOutEndUserBody = {
 
 export declare type LogOutEndUserResult = NonNullable<Awaited<ReturnType<typeof logOutEndUser>>>;
 
+export declare interface Metadata {
+    [key: string]: unknown;
+}
+
+export declare type MfaAlreadyEnrolledErrorResponse = Error_2;
+
+export declare type MfaFlowExpiredErrorResponse = Error_2;
+
+export declare type MfaInvalidCodeErrorResponse = Error_2;
+
+export declare type MfaMethod = (typeof MfaMethod)[keyof typeof MfaMethod];
+
+export declare const MfaMethod: {
+    readonly totp: "totp";
+};
+
+export declare interface MFAMethods {
+    totp?: MFAMethodsTotp;
+}
+
+export declare type MFAMethodsTotp = {
+    enrolledAt: string;
+};
+
+export declare type MfaNotEnrolledErrorResponse = Error_2;
+
 export declare interface MintAddressCriterion {
     type: MintAddressCriterionType;
     addresses: string[];
@@ -1256,17 +1362,13 @@ export declare type Network = (typeof Network)[keyof typeof Network];
 export declare const Network: {
     readonly base: "base";
     readonly ethereum: "ethereum";
-    readonly algorand: "algorand";
+    readonly solana: "solana";
     readonly aptos: "aptos";
     readonly arbitrum: "arbitrum";
     readonly avacchain: "avacchain";
-    readonly noble: "noble";
     readonly optimism: "optimism";
     readonly polygon: "polygon";
-    readonly solana: "solana";
-    readonly stellar: "stellar";
     readonly sui: "sui";
-    readonly unichain: "unichain";
 };
 
 export declare interface OAuth2Authentication {
@@ -1371,11 +1473,6 @@ export declare interface OnchainDataTableSchema {
     columns?: OnchainDataColumnSchema[];
 }
 
-export declare interface OnchainTransaction {
-    txHash: string;
-    network: Network;
-}
-
 export declare interface OnrampOrder {
     orderId: string;
     paymentTotal: string;
@@ -2391,6 +2488,26 @@ export declare const SplValueCriterionType: {
     readonly splValue: "splValue";
 };
 
+export declare const submitMfaEnrollment: (projectId: string, userId: string, mfaMethod: "totp", submitMfaEnrollmentBody: SubmitMfaEnrollmentBody, options?: SecondParameter<typeof cdpApiClient>) => Promise<SubmitMfaEnrollment200>;
+
+export declare type SubmitMfaEnrollment200 = {
+    endUser: EndUser;
+};
+
+export declare type SubmitMfaEnrollmentBody = {
+    mfaCode: string;
+};
+
+export declare type SubmitMfaEnrollmentResult = NonNullable<Awaited<ReturnType<typeof submitMfaEnrollment>>>;
+
+export declare const submitMfaVerification: (projectId: string, userId: string, mfaMethod: "totp", submitMfaVerificationBody: SubmitMfaVerificationBody, options?: SecondParameter<typeof cdpApiClient>) => Promise<void>;
+
+export declare type SubmitMfaVerificationBody = {
+    mfaCode: string;
+};
+
+export declare type SubmitMfaVerificationResult = NonNullable<Awaited<ReturnType<typeof submitMfaVerification>>>;
+
 export declare interface SwapUnavailableResponse {
     liquidityAvailable: boolean;
 }
@@ -2440,15 +2557,12 @@ export declare interface Transfer {
     status: TransferStatus;
     source: TransferSource;
     target: TransferTarget;
-    amount: string;
-    asset: string;
     sourceAmount?: string;
     sourceAsset?: string;
     targetAmount?: string;
     targetAsset?: string;
     exchangeRate?: TransferExchangeRate;
     fees?: TransferFees;
-    onchainTransactions?: OnchainTransaction[];
     completedAt?: string;
     failureReason?: string;
     reversalReason?: TransferReversalReason;
@@ -2458,6 +2572,9 @@ export declare interface Transfer {
     executedAt?: string;
     createdAt: string;
     updatedAt: string;
+    validateOnly?: boolean;
+    metadata?: Metadata;
+    travelRule?: TravelRule;
 }
 
 export declare type TransferCancellationReason = (typeof TransferCancellationReason)[keyof typeof TransferCancellationReason];
@@ -2510,12 +2627,15 @@ export declare type TransferLastErrorDetails = {
 };
 
 export declare interface TransferRequest {
-    source: TransferSource;
+    source: CreateTransferSource;
     target: TransferTarget;
     amount: string;
     asset: string;
     amountType?: TransferRequestAmountType;
+    validateOnly?: boolean;
     execute: boolean;
+    metadata?: Metadata;
+    travelRule?: TravelRule;
 }
 
 export declare type TransferRequestAmountType = (typeof TransferRequestAmountType)[keyof typeof TransferRequestAmountType];
@@ -2540,13 +2660,12 @@ export declare interface TransfersAccount {
     asset: string;
 }
 
-export declare type TransferSource = TransfersAccount | PaymentMethod;
+export declare type TransferSource = TransfersAccount | PaymentMethod | OnchainAddress;
 
 export declare type TransferStatus = (typeof TransferStatus)[keyof typeof TransferStatus];
 
 export declare const TransferStatus: {
-    readonly draft: "draft";
-    readonly awaiting_funds: "awaiting_funds";
+    readonly quoted: "quoted";
     readonly processing: "processing";
     readonly completed: "completed";
     readonly failed: "failed";
@@ -2555,8 +2674,45 @@ export declare const TransferStatus: {
     readonly reversed: "reversed";
 };
 
+export declare interface TransferStatusChangedWebhookEvent {
+    eventType: TransferStatusChangedWebhookEventEventType;
+    eventId: string;
+    timestamp: string;
+    data: Transfer;
+}
+
+export declare type TransferStatusChangedWebhookEventEventType = (typeof TransferStatusChangedWebhookEventEventType)[keyof typeof TransferStatusChangedWebhookEventEventType];
+
+export declare const TransferStatusChangedWebhookEventEventType: {
+    readonly transferstatus_changed: "transfer.status_changed";
+};
+
 export declare type TransferTarget = TransfersAccount | PaymentMethod | OnchainAddress | EmailAddress;
 
+export declare interface TravelRule {
+    originator?: TravelRuleOriginator;
+    beneficiary?: TravelRuleParty;
+}
+
+export declare interface TravelRuleAddress {
+    address1?: string;
+    address2?: string;
+    city?: string;
+    postalCode?: string;
+    country?: string;
+}
+
+export declare type TravelRuleOriginator = TravelRuleParty & TravelRuleOriginatorAllOf;
+
+export declare type TravelRuleOriginatorAllOf = {
+    financialInstitution?: string;
+};
+
+export declare interface TravelRuleParty {
+    name?: string;
+    address?: TravelRuleAddress;
+}
+
 export declare type UnauthorizedErrorResponse = Error_2;
 
 export declare class UnknownApiError extends APIError {
@@ -2567,6 +2723,13 @@ export declare class UnknownError extends Error {
     constructor(message: string, cause?: Error);
 }
 
+export declare interface UpdateCustomAuthConfigRequest {
+    enabled?: boolean;
+    jwksUrl?: string;
+    issuer?: string;
+    audience?: string;
+}
+
 export declare interface UserOperationReceipt {
     revert?: UserOperationReceiptRevert;
     transactionHash?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-api-client",
-  "version": "0.0.68",
+  "version": "0.0.69",
   "type": "module",
   "files": [
     "dist/**",