@coinbase/cdp-sdk 1.43.1 → 1.44.1

package/_types/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.d.ts

@@ -235,8 +235,6 @@ export declare const ErrorType: {
     readonly mfa_flow_expired: "mfa_flow_expired";
     readonly mfa_required: "mfa_required";
     readonly mfa_not_enrolled: "mfa_not_enrolled";
-    readonly mfa_multiple_methods_available: "mfa_multiple_methods_available";
-    readonly mfa_invalid_method: "mfa_invalid_method";
 };
 /**
  * A valid HTTP or HTTPS URL.
@@ -2086,6 +2084,18 @@ export interface AccountTokenAddressesResponse {
      */
     totalCount?: number;
 }
+/**
+ * A human-readable description.
+ * @minLength 0
+ * @maxLength 500
+ */
+export type Description = string;
+/**
+ * Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 50 key/value pairs may be provided.  Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.
+ */
+export interface Metadata {
+    [key: string]: string;
+}
 /**
  * Additional headers to include in webhook requests.
  */
@@ -2103,16 +2113,17 @@ export interface WebhookTarget {
     /** Additional headers to include in webhook requests. */
     headers?: WebhookTargetHeaders;
 }
-/**
- * Additional metadata for the subscription.
- */
-export type WebhookSubscriptionResponseMetadata = {
+export type WebhookSubscriptionResponseMetadataAllOf = {
     /**
      * Use the root-level `secret` field instead. Maintained for backward compatibility only.
      * @deprecated
      */
     secret?: string;
 };
+/**
+ * Additional metadata for the subscription.
+ */
+export type WebhookSubscriptionResponseMetadata = Metadata & WebhookSubscriptionResponseMetadataAllOf;
 /**
  * Multi-label filters using total overlap logic. Total overlap means the subscription only triggers when events contain ALL these key-value pairs.
 Present when subscription uses multi-label format.
@@ -2128,7 +2139,7 @@ export interface WebhookSubscriptionResponse {
     /** When the subscription was created. */
     createdAt: string;
     /** Description of the webhook subscription. */
-    description?: string;
+    description?: Description;
     /** Types of events to subscribe to. Event types follow a three-part dot-separated format:
   service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
    */
@@ -2142,24 +2153,6 @@ export interface WebhookSubscriptionResponse {
     /** Unique identifier for the subscription. */
     subscriptionId: string;
     target: WebhookTarget;
-    /**
-     * (Deprecated) Use `labels` field instead.
-  
-  Label key for filtering events. Present when subscription uses traditional single-label format.
-  Maintained for backward compatibility only.
-  
-     * @deprecated
-     */
-    labelKey?: string;
-    /**
-     * (Deprecated) Use `labels` field instead.
-  
-  Label value for filtering events. Present when subscription uses traditional single-label format.
-  Maintained for backward compatibility only.
-  
-     * @deprecated
-     */
-    labelValue?: string;
     /** Multi-label filters using total overlap logic. Total overlap means the subscription only triggers when events contain ALL these key-value pairs.
   Present when subscription uses multi-label format.
    */
@@ -2174,15 +2167,9 @@ export type WebhookSubscriptionListResponseAllOf = {
 };
 export type WebhookSubscriptionListResponse = WebhookSubscriptionListResponseAllOf & ListResponse;
 /**
- * Additional metadata for the subscription.
- */
-export type WebhookSubscriptionRequestMetadata = {
-    [key: string]: unknown;
-};
-/**
- * Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when
+ * Optional. Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when
 an event contains ALL the key-value pairs specified here. Additional labels on
-the event are allowed and will not prevent matching.
+the event are allowed and will not prevent matching. Omit to receive all events for the selected event types.
 
 **Note:** Currently, labels are supported for onchain webhooks only.
 
@@ -2193,200 +2180,67 @@ export type WebhookSubscriptionRequestLabels = {
     [key: string]: string;
 };
 /**
- * Request to create a new webhook subscription with support for both traditional single-label
-and multi-label filtering formats.
+ * Request to create a new webhook subscription with support for multi-label filtering.
 
  */
-export type WebhookSubscriptionRequest = (unknown & {
+export interface WebhookSubscriptionRequest {
     /** Description of the webhook subscription. */
-    description?: string;
+    description?: Description;
     /** Types of events to subscribe to. Event types follow a three-part dot-separated format:
-service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
-The subscription will only receive events matching these types AND the label filter(s).
-*/
-    eventTypes?: string[];
-    /** Whether the subscription is enabled. */
-    isEnabled?: boolean;
-    target?: WebhookTarget;
-    /** Additional metadata for the subscription. */
-    metadata?: WebhookSubscriptionRequestMetadata;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label key for filtering events. Each subscription filters on exactly one (labelKey, labelValue) pair
-in addition to the event types. Only events matching both the event types AND this label filter will be delivered.
-NOTE: Use either (labelKey + labelValue) OR labels, not both.
-
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelKey?: string;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label value for filtering events. Must correspond to the labelKey (e.g., contract address for contract_address key).
-Only events with this exact label value will be delivered.
-NOTE: Use either (labelKey + labelValue) OR labels, not both.
-
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelValue?: string;
-    /** Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when
-an event contains ALL the key-value pairs specified here. Additional labels on
-the event are allowed and will not prevent matching.
-
-**Note:** Currently, labels are supported for onchain webhooks only.
-
-See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
-*/
-    labels?: WebhookSubscriptionRequestLabels;
-}) | (unknown & {
-    /** Description of the webhook subscription. */
-    description?: string;
-    /** Types of events to subscribe to. Event types follow a three-part dot-separated format:
-service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
-The subscription will only receive events matching these types AND the label filter(s).
-*/
-    eventTypes?: string[];
+  service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
+  The subscription will only receive events matching these types AND the label filter(s).
+   */
+    eventTypes: string[];
     /** Whether the subscription is enabled. */
-    isEnabled?: boolean;
-    target?: WebhookTarget;
-    /** Additional metadata for the subscription. */
-    metadata?: WebhookSubscriptionRequestMetadata;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label key for filtering events. Each subscription filters on exactly one (labelKey, labelValue) pair
-in addition to the event types. Only events matching both the event types AND this label filter will be delivered.
-NOTE: Use either (labelKey + labelValue) OR labels, not both.
-
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelKey?: string;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label value for filtering events. Must correspond to the labelKey (e.g., contract address for contract_address key).
-Only events with this exact label value will be delivered.
-NOTE: Use either (labelKey + labelValue) OR labels, not both.
-
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelValue?: string;
-    /** Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when
-an event contains ALL the key-value pairs specified here. Additional labels on
-the event are allowed and will not prevent matching.
-
-**Note:** Currently, labels are supported for onchain webhooks only.
-
-See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
-*/
+    isEnabled: boolean;
+    target: WebhookTarget;
+    metadata?: Metadata;
+    /** Optional. Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when
+  an event contains ALL the key-value pairs specified here. Additional labels on
+  the event are allowed and will not prevent matching. Omit to receive all events for the selected event types.
+  
+  **Note:** Currently, labels are supported for onchain webhooks only.
+  
+  See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
+   */
     labels?: WebhookSubscriptionRequestLabels;
-});
-/**
- * Additional metadata for the subscription.
- */
-export type WebhookSubscriptionUpdateRequestMetadata = {
-    [key: string]: unknown;
-};
+}
 /**
- * Multi-label filters that trigger only when an event contains ALL of these key-value pairs.
+ * Optional. Multi-label filters that trigger only when an event contains ALL of these key-value pairs.
 
 **Note:** Currently, labels are supported for onchain webhooks only.
 
 See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
+Omit to receive all events for the selected event types.
 
  */
 export type WebhookSubscriptionUpdateRequestLabels = {
     [key: string]: string;
 };
 /**
- * Request to update an existing webhook subscription. The update format must match
-the original subscription format (traditional or multi-label).
-
- */
-export type WebhookSubscriptionUpdateRequest = (unknown & {
-    /** Description of the webhook subscription. */
-    description?: string;
-    /** Types of events to subscribe to. Event types follow a three-part dot-separated format:
-service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
-*/
-    eventTypes?: string[];
-    /** Whether the subscription is enabled. */
-    isEnabled?: boolean;
-    target?: WebhookTarget;
-    /** Additional metadata for the subscription. */
-    metadata?: WebhookSubscriptionUpdateRequestMetadata;
-    /** Multi-label filters that trigger only when an event contains ALL of these key-value pairs.
-
-**Note:** Currently, labels are supported for onchain webhooks only.
-
-See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
-*/
-    labels?: WebhookSubscriptionUpdateRequestLabels;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
+ * Request to update an existing webhook subscription.
 
-Label key for filtering events. Use either (labelKey + labelValue) OR labels, not both.
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelKey?: string;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label value for filtering events. Use either (labelKey + labelValue) OR labels, not both.
-Maintained for backward compatibility only.
-
- * @deprecated
  */
-    labelValue?: string;
-}) | (unknown & {
+export interface WebhookSubscriptionUpdateRequest {
     /** Description of the webhook subscription. */
-    description?: string;
+    description?: Description;
     /** Types of events to subscribe to. Event types follow a three-part dot-separated format:
-service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
-*/
-    eventTypes?: string[];
+  service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created").
+   */
+    eventTypes: string[];
     /** Whether the subscription is enabled. */
-    isEnabled?: boolean;
-    target?: WebhookTarget;
-    /** Additional metadata for the subscription. */
-    metadata?: WebhookSubscriptionUpdateRequestMetadata;
-    /** Multi-label filters that trigger only when an event contains ALL of these key-value pairs.
-
-**Note:** Currently, labels are supported for onchain webhooks only.
-
-See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
-*/
+    isEnabled: boolean;
+    target: WebhookTarget;
+    metadata?: Metadata;
+    /** Optional. Multi-label filters that trigger only when an event contains ALL of these key-value pairs.
+  
+  **Note:** Currently, labels are supported for onchain webhooks only.
+  
+  See [allowed labels for onchain webhooks](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/webhooks/create-webhook-subscription#onchain-label-filtering).
+  Omit to receive all events for the selected event types.
+   */
     labels?: WebhookSubscriptionUpdateRequestLabels;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label key for filtering events. Use either (labelKey + labelValue) OR labels, not both.
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelKey?: string;
-    /**
- * (Deprecated) Use `labels` instead for better filtering capabilities, including filtering on multiple labels simultaneously.
-
-Label value for filtering events. Use either (labelKey + labelValue) OR labels, not both.
-Maintained for backward compatibility only.
-
- * @deprecated
- */
-    labelValue?: string;
-});
+}
 /**
  * The version of the x402 protocol.
  */
@@ -2519,8 +2373,8 @@ export interface X402V2PaymentRequirements {
 export interface X402ResourceInfo {
     /** The URL of the resource. */
     url?: string;
-    /** The description of the resource. */
-    description?: string;
+    /** A human-readable description of the resource. */
+    description?: Description;
     /** The MIME type of the resource response. */
     mimeType?: string;
 }
@@ -2591,8 +2445,8 @@ export interface X402V1PaymentRequirements {
     maxAmountRequired: string;
     /** The URL of the resource to pay for. */
     resource: string;
-    /** The description of the resource. */
-    description: string;
+    /** A human-readable description of the resource. */
+    description: Description;
     /** The MIME type of the resource response. */
     mimeType: string;
     /** The optional JSON schema describing the resource output. */
@@ -2664,6 +2518,7 @@ export declare const X402VerifyInvalidReason: {
     readonly invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata: "invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata";
     readonly invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts: "invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts";
     readonly invalid_exact_svm_payload_transaction_fee_payer_transferring_funds: "invalid_exact_svm_payload_transaction_fee_payer_transferring_funds";
+    readonly unknown_error: "unknown_error";
 };
 /**
  * The result when x402 payment verification fails.
@@ -2672,6 +2527,8 @@ export interface X402VerifyPaymentRejection {
     /** Indicates whether the payment is valid. */
     isValid: boolean;
     invalidReason: X402VerifyInvalidReason;
+    /** The message describing the invalid reason. */
+    invalidMessage?: string;
     /**
      * The onchain address of the client that is paying for the resource.
   
@@ -2727,6 +2584,7 @@ export declare const X402SettleErrorReason: {
     readonly settle_exact_failed_onchain: "settle_exact_failed_onchain";
     readonly settle_exact_svm_block_height_exceeded: "settle_exact_svm_block_height_exceeded";
     readonly settle_exact_svm_transaction_confirmation_timed_out: "settle_exact_svm_transaction_confirmation_timed_out";
+    readonly unknown_error: "unknown_error";
 };
 /**
  * The result when x402 payment settlement fails.
@@ -2735,6 +2593,8 @@ export interface X402SettlePaymentRejection {
     /** Indicates whether the payment settlement is successful. */
     success: boolean;
     errorReason: X402SettleErrorReason;
+    /** The message describing the error reason. */
+    errorMessage?: string;
     /**
      * The onchain address of the client that is paying for the resource.
   
@@ -2770,6 +2630,10 @@ export declare const X402SupportedPaymentKindNetwork: {
     readonly base: "base";
     readonly "solana-devnet": "solana-devnet";
     readonly solana: "solana";
+    readonly "eip155:8453": "eip155:8453";
+    readonly "eip155:84532": "eip155:84532";
+    readonly "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
+    readonly "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1";
 };
 /**
  * The optional additional scheme-specific payment info.
@@ -2789,6 +2653,12 @@ export interface X402SupportedPaymentKind {
     /** The optional additional scheme-specific payment info. */
     extra?: X402SupportedPaymentKindExtra;
 }
+/**
+ * A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).
+ * @minLength 1
+ * @maxLength 128
+ */
+export type BlockchainAddress = string;
 /**
  * The type of payment method to be used to complete an onramp order.
  */
@@ -2848,7 +2718,7 @@ export interface OnrampOrder {
     /** The exchange rate used to convert fiat to crypto i.e. the crypto value of one fiat. */
     exchangeRate: string;
     /** The destination address to send the crypto to. */
-    destinationAddress: string;
+    destinationAddress: BlockchainAddress;
     /** The network to send the crypto on. */
     destinationNetwork: string;
     status: OnrampOrderStatus;
@@ -2965,6 +2835,8 @@ export type X402VerifyResponseResponse = {
     /** Indicates whether the payment is valid. */
     isValid: boolean;
     invalidReason?: X402VerifyInvalidReason;
+    /** The message describing the invalid reason. */
+    invalidMessage?: string;
     /**
      * The onchain address of the client that is paying for the resource.
   
@@ -2983,6 +2855,8 @@ export type X402SettleResponseResponse = {
     /** Indicates whether the payment settlement is successful. */
     success: boolean;
     errorReason?: X402SettleErrorReason;
+    /** The message describing the error reason. */
+    errorMessage?: string;
     /**
      * The onchain address of the client that is paying for the resource.
   
@@ -3107,6 +2981,25 @@ export type ValidateEndUserAccessTokenBody = {
     /** The access token in JWT format to verify. */
     accessToken: string;
 };
+export type AddEndUserEvmAccountBody = {
+    [key: string]: unknown;
+};
+export type AddEndUserEvmAccount201 = {
+    evmAccount: EndUserEvmAccount;
+};
+export type AddEndUserEvmSmartAccountBody = {
+    /** If true, enables spend permissions for the EVM smart account. */
+    enableSpendPermissions?: boolean;
+};
+export type AddEndUserEvmSmartAccount201 = {
+    evmSmartAccount: EndUserEvmSmartAccount;
+};
+export type AddEndUserSolanaAccountBody = {
+    [key: string]: unknown;
+};
+export type AddEndUserSolanaAccount201 = {
+    solanaAccount: EndUserSolanaAccount;
+};
 /**
  * The type of key being imported. Determines what type of account will be associated for the end user.
  */
@@ -3658,7 +3551,7 @@ export type CreateOnrampOrderBody = {
     /** The timestamp of when the user acknowledged that by using Coinbase Onramp they are accepting the Coinbase Terms  (https://www.coinbase.com/legal/guest-checkout/us), User Agreement (https://www.coinbase.com/legal/user_agreement),  and Privacy Policy (https://www.coinbase.com/legal/privacy). */
     agreementAcceptedAt: string;
     /** The address the purchased crypto will be sent to. */
-    destinationAddress: string;
+    destinationAddress: BlockchainAddress;
     /** The name of the crypto network the purchased currency will be sent on.
   
   Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported networks for your user's location. */
@@ -3712,7 +3605,7 @@ export type CreateOnrampSessionBody = {
   Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported networks for your user's location. */
     destinationNetwork: string;
     /** The address the purchased crypto will be sent to. */
-    destinationAddress: string;
+    destinationAddress: BlockchainAddress;
     /** A string representing the amount of fiat the user wishes to pay in exchange for crypto. When using this parameter, the returned quote will be inclusive of fees i.e. the user  will pay this exact amount of the payment currency. */
     paymentAmount?: string;
     /** A string representing the amount of crypto the user wishes to purchase. When using  this parameter, the returned quote will be exclusive of fees i.e. the user will  receive this exact amount of the purchase currency. */