@coinbase/cdp-api-client 0.0.109 → 0.0.111

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.
@@ -158,6 +158,25 @@ export declare type BadGatewayErrorResponse = Error_2;
158
158
  */
159
159
  export declare type BlockchainAddress = string;
160
160
 
161
+ /**
162
+ * The name of a capability. Capabilities represent granular functional permissions
163
+ that determine what actions a customer can perform. Each capability must be
164
+ explicitly requested before use.
165
+
166
+ */
167
+ export declare type CapabilityName = (typeof CapabilityName)[keyof typeof CapabilityName];
168
+
169
+ export declare const CapabilityName: {
170
+ readonly custodyCrypto: "custodyCrypto";
171
+ readonly custodyFiat: "custodyFiat";
172
+ readonly custodyStablecoin: "custodyStablecoin";
173
+ readonly tradeCrypto: "tradeCrypto";
174
+ readonly tradeStablecoin: "tradeStablecoin";
175
+ readonly transferCrypto: "transferCrypto";
176
+ readonly transferFiat: "transferFiat";
177
+ readonly transferStablecoin: "transferStablecoin";
178
+ };
179
+
161
180
  /**
162
181
  * Mutates the given Axios request configuration to add the CDP API key signature
163
182
  * to the request headers.
@@ -738,6 +757,13 @@ export declare interface EIP712Types {
738
757
  [key: string]: unknown;
739
758
  }
740
759
 
760
+ /**
761
+ * An email address. Maximum length 254 characters per [RFC 5321](https://www.rfc-editor.org/rfc/rfc5321).
762
+ * @maxLength 254
763
+ * @pattern ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}/-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$
764
+ */
765
+ export declare type Email = string;
766
+
741
767
  /**
742
768
  * Information about an end user who authenticates using a one-time password sent to their email address.
743
769
  */
@@ -745,7 +771,7 @@ export declare interface EmailAuthentication {
745
771
  /** The type of authentication information. */
746
772
  type: EmailAuthenticationType;
747
773
  /** The email address of the end user. */
748
- email: string;
774
+ email: Email;
749
775
  }
750
776
 
751
777
  /**
@@ -1050,6 +1076,16 @@ declare interface Error_2 {
1050
1076
  correlationId?: string;
1051
1077
  /** A link to the corresponding error documentation. */
1052
1078
  errorLink?: Url;
1079
+ /** The capability code(s) that were not authorized for the customer on
1080
+ this request. Present only when `errorType` is
1081
+ `customer_not_authorized`; absent for every other error type.
1082
+
1083
+ Use this list to render onboarding UX for the listed capabilities, or
1084
+ fetch `GET /v2/customers/{customerId}` and inspect each entry's
1085
+ `status` / `requirements` to discover what (if anything) can be
1086
+ submitted to resolve the block.
1087
+ */
1088
+ unauthorizedCapabilities?: CapabilityName[];
1053
1089
  }
1054
1090
  export { Error_2 as Error }
1055
1091
 
@@ -1064,6 +1100,7 @@ export declare const ErrorType: {
1064
1100
  readonly bad_gateway: "bad_gateway";
1065
1101
  readonly capture_expired: "capture_expired";
1066
1102
  readonly client_closed_request: "client_closed_request";
1103
+ readonly customer_not_authorized: "customer_not_authorized";
1067
1104
  readonly endpoint_unavailable: "endpoint_unavailable";
1068
1105
  readonly faucet_limit_exceeded: "faucet_limit_exceeded";
1069
1106
  readonly forbidden: "forbidden";
@@ -1092,6 +1129,12 @@ export declare const ErrorType: {
1092
1129
  readonly guest_transaction_limit: "guest_transaction_limit";
1093
1130
  readonly guest_transaction_count: "guest_transaction_count";
1094
1131
  readonly phone_number_verification_expired: "phone_number_verification_expired";
1132
+ readonly otp_verification_code_invalid: "otp_verification_code_invalid";
1133
+ readonly otp_verification_destination_mismatch: "otp_verification_destination_mismatch";
1134
+ readonly otp_verification_expired: "otp_verification_expired";
1135
+ readonly otp_verification_invalid: "otp_verification_invalid";
1136
+ readonly otp_verification_not_found: "otp_verification_not_found";
1137
+ readonly otp_verification_required: "otp_verification_required";
1095
1138
  readonly document_verification_failed: "document_verification_failed";
1096
1139
  readonly recipient_allowlist_violation: "recipient_allowlist_violation";
1097
1140
  readonly recipient_allowlist_pending: "recipient_allowlist_pending";
@@ -1133,6 +1176,17 @@ export declare const ErrorType: {
1133
1176
  readonly delegation_not_enabled: "delegation_not_enabled";
1134
1177
  readonly network_mismatch: "network_mismatch";
1135
1178
  readonly already_enabled: "already_enabled";
1179
+ readonly payment_session_already_canceled: "payment_session_already_canceled";
1180
+ readonly payment_session_already_authorized: "payment_session_already_authorized";
1181
+ readonly payment_session_action_pending: "payment_session_action_pending";
1182
+ readonly no_capturable_balance: "no_capturable_balance";
1183
+ readonly no_voidable_balance: "no_voidable_balance";
1184
+ readonly no_refundable_balance: "no_refundable_balance";
1185
+ readonly entity_not_configured_for_payment_acceptance: "entity_not_configured_for_payment_acceptance";
1186
+ readonly daily_transaction_limit_exceeded: "daily_transaction_limit_exceeded";
1187
+ readonly daily_amount_limit_exceeded: "daily_amount_limit_exceeded";
1188
+ readonly stale_attestation: "stale_attestation";
1189
+ readonly moderation_rejected: "moderation_rejected";
1136
1190
  };
1137
1191
 
1138
1192
  export declare interface EvmCall {
@@ -1732,11 +1786,8 @@ export declare const InitiateEmailAuthenticationNextStepType: {
1732
1786
  export declare interface InitiateEmailAuthenticationRequest {
1733
1787
  /** The type of authentication information. */
1734
1788
  type: InitiateEmailAuthenticationRequestType;
1735
- /**
1736
- * The email address of the end user. Maximum length is 254 characters as defined by [RFC5321](https://www.rfc-editor.org/rfc/rfc5321).
1737
- * @maxLength 254
1738
- */
1739
- email: string;
1789
+ /** The email address of the end user. Maximum length is 254 characters as defined by [RFC5321](https://www.rfc-editor.org/rfc/rfc5321). */
1790
+ email: Email;
1740
1791
  }
1741
1792
 
1742
1793
  /**
@@ -1847,8 +1898,17 @@ export declare interface InitiateOAuthAuthenticationRequest {
1847
1898
  type: OAuth2ProviderType;
1848
1899
  /** The url of the developer's application where the flow should redirect. */
1849
1900
  redirectUrl: Uri;
1901
+ /** Optional key-value pairs to append or override non-critical query parameters on the OAuth authorization URL. For example, use `prompt` to control consent behavior, `login_hint` to pre-fill the user's email on Google, or `email` for Apple. Parameters critical to the OAuth/OIDC protocol (such as `client_id`, `redirect_uri`, `response_type`, `scope`, `state`, `code_challenge`, `code_challenge_method`, and `response_mode`) cannot be overridden and will result in a 400 error. */
1902
+ providerUrlParams?: InitiateOAuthAuthenticationRequestProviderUrlParams;
1850
1903
  }
1851
1904
 
1905
+ /**
1906
+ * Optional key-value pairs to append or override non-critical query parameters on the OAuth authorization URL. For example, use `prompt` to control consent behavior, `login_hint` to pre-fill the user's email on Google, or `email` for Apple. Parameters critical to the OAuth/OIDC protocol (such as `client_id`, `redirect_uri`, `response_type`, `scope`, `state`, `code_challenge`, `code_challenge_method`, and `response_mode`) cannot be overridden and will result in a 400 error.
1907
+ */
1908
+ export declare type InitiateOAuthAuthenticationRequestProviderUrlParams = {
1909
+ [key: string]: string;
1910
+ };
1911
+
1852
1912
  /**
1853
1913
  * The response body for an end user to initiate OAuth authentication using a third-party provider.
1854
1914
  */
@@ -1927,11 +1987,8 @@ export declare const InitiateSmsAuthenticationNextStepType: {
1927
1987
  export declare interface InitiateSmsAuthenticationRequest {
1928
1988
  /** The type of authentication information. */
1929
1989
  type: InitiateSmsAuthenticationRequestType;
1930
- /**
1931
- * The phone number of the end user in E.164 format.
1932
- * @pattern ^\+[1-9]\d{1,14}$
1933
- */
1934
- phoneNumber: string;
1990
+ /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. */
1991
+ phoneNumber: PhoneNumber;
1935
1992
  }
1936
1993
 
1937
1994
  /**
@@ -1960,11 +2017,8 @@ export declare interface InitiateSmsAuthenticationResponse {
1960
2017
  export declare interface InitiateSmsMfaEnrollment {
1961
2018
  /** The type of MFA method. */
1962
2019
  type: InitiateSmsMfaEnrollmentType;
1963
- /**
1964
- * Phone number in E.164 format (e.g., +14155552671). You can use any phone number for SMS MFA, even if it differs from your SMS authentication phone number.
1965
- * @pattern ^\+[1-9]\d{1,14}$
1966
- */
1967
- phoneNumber?: string;
2020
+ /** Phone number in E.164 format (e.g., +14155552671). You can use any phone number for SMS MFA, even if it differs from your SMS authentication phone number. */
2021
+ phoneNumber?: PhoneNumber;
1968
2022
  }
1969
2023
 
1970
2024
  /**
@@ -2246,6 +2300,13 @@ export declare interface OAuth2Authentication {
2246
2300
  username?: string;
2247
2301
  }
2248
2302
 
2303
+ /**
2304
+ * Generated by orval v7.20.0 🍺
2305
+ * Do not edit manually.
2306
+ * Coinbase Developer Platform APIs
2307
+ * The Coinbase Developer Platform APIs - leading the world's transition onchain.
2308
+ * OpenAPI spec version: 2.0.0
2309
+ */
2249
2310
  /**
2250
2311
  * The type of OAuth2 provider.
2251
2312
  */
@@ -2259,6 +2320,29 @@ export declare const OAuth2ProviderType: {
2259
2320
  readonly github: "github";
2260
2321
  };
2261
2322
 
2323
+ /**
2324
+ * The OTP email logo for a project.
2325
+ */
2326
+ export declare interface OtpEmailLogo {
2327
+ /** The unique identifier of the logo asset. */
2328
+ logoId: string;
2329
+ /** The public URL for the logo image. */
2330
+ logoUrl?: Url;
2331
+ /** The moderation status of the logo. If pending, poll getProjectConfig until the status resolves to approved or rejected. If rejected, upload a new image. */
2332
+ moderationStatus: OtpEmailLogoModerationStatus;
2333
+ }
2334
+
2335
+ /**
2336
+ * The moderation status of the logo. If pending, poll getProjectConfig until the status resolves to approved or rejected. If rejected, upload a new image.
2337
+ */
2338
+ export declare type OtpEmailLogoModerationStatus = (typeof OtpEmailLogoModerationStatus)[keyof typeof OtpEmailLogoModerationStatus];
2339
+
2340
+ export declare const OtpEmailLogoModerationStatus: {
2341
+ readonly approved: "approved";
2342
+ readonly pending: "pending";
2343
+ readonly rejected: "rejected";
2344
+ };
2345
+
2262
2346
  /**
2263
2347
  * The number of resources to return per page.
2264
2348
  */
@@ -2269,11 +2353,24 @@ export declare type PageSizeParameter = number;
2269
2353
  */
2270
2354
  export declare type PageTokenParameter = string;
2271
2355
 
2356
+ /**
2357
+ * The ERC-7677 `context` object forwarded to the paymaster service as part of the `paymasterService` capability. The fields in this object are defined by the paymaster service provider; CDP forwards them to the paymaster unchanged. This field is only valid when a paymaster is configured for the request. Providing `paymasterContext` without a paymaster configured results in an `invalid_request` error.
2358
+ */
2359
+ export declare interface PaymasterContext {
2360
+ [key: string]: unknown;
2361
+ }
2362
+
2272
2363
  /**
2273
2364
  * A payment method is required to complete this operation.
2274
2365
  */
2275
2366
  export declare type PaymentMethodRequiredErrorResponse = Error_2;
2276
2367
 
2368
+ /**
2369
+ * A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
2370
+ * @pattern ^\+[1-9]\d{1,14}$
2371
+ */
2372
+ export declare type PhoneNumber = string;
2373
+
2277
2374
  /**
2278
2375
  * Configuration for a project.
2279
2376
  */
@@ -2292,15 +2389,10 @@ export declare interface ProjectConfig {
2292
2389
  /** Whether delegated signing is enabled for this project. When enabled, end users can delegate transaction signing to the project. */
2293
2390
  delegatedSigningEnabled?: boolean;
2294
2391
  appAttestation?: AppAttestationProjectConfig;
2392
+ /** The project's OTP email logo. */
2393
+ logo?: OtpEmailLogo;
2295
2394
  }
2296
2395
 
2297
- /**
2298
- * Generated by orval v7.20.0 🍺
2299
- * Do not edit manually.
2300
- * Coinbase Developer Platform APIs
2301
- * The Coinbase Developer Platform APIs - leading the world's transition onchain.
2302
- * OpenAPI spec version: 2.0.0
2303
- */
2304
2396
  /**
2305
2397
  * The ID of the Project, a UUID v4.
2306
2398
  * @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
@@ -2312,6 +2404,70 @@ export declare type ProjectId = string;
2312
2404
  */
2313
2405
  export declare type ProjectIDOptionalParameter = string;
2314
2406
 
2407
+ /**
2408
+ * Receives the OAuth callback from an identity provider. This endpoint is intended only for use as a callback URL during OAuth2 provider flows and should not be called directly by client applications. This is an unauthenticated endpoint.
2409
+ * @summary Receive OAuth callback from identity provider
2410
+ */
2411
+ export declare const receiveOAuthCallback: (providerType: OAuth2ProviderType, params?: ReceiveOAuthCallbackParams, options?: SecondParameter<typeof cdpApiClient<unknown>>) => Promise<unknown>;
2412
+
2413
+ export declare type ReceiveOAuthCallbackParams = {
2414
+ /**
2415
+ * The authorization code returned by the OAuth provider.
2416
+ */
2417
+ code?: string;
2418
+ /**
2419
+ * The OAuth scopes requested from provider.
2420
+ */
2421
+ scope?: string;
2422
+ /**
2423
+ * The base64 encoded state parameter that was sent in the original authorization request.
2424
+ */
2425
+ state?: string;
2426
+ /**
2427
+ * The "error" query param returned from OAuth2 redirection.
2428
+ */
2429
+ error?: string;
2430
+ /**
2431
+ * Human-readable description of the error.
2432
+ */
2433
+ error_description?: string;
2434
+ };
2435
+
2436
+ /**
2437
+ * Receives the OAuth callback from an identity provider. This endpoint is intended only for use as a callback URL during OAuth2 provider flows and should not be called directly by client applications. This is an unauthenticated endpoint.
2438
+ * @summary Receive OAuth callback from identity provider
2439
+ */
2440
+ export declare const receiveOAuthCallbackPost: (providerType: OAuth2ProviderType, receiveOAuthCallbackPostBody: ReceiveOAuthCallbackPostBody, options?: SecondParameter<typeof cdpApiClient<unknown>>) => Promise<unknown>;
2441
+
2442
+ export declare type ReceiveOAuthCallbackPostBody = {
2443
+ /**
2444
+ * The authorization code returned by the OAuth provider.
2445
+ * @nullable
2446
+ */
2447
+ code?: string | null;
2448
+ /**
2449
+ * The OAuth scopes requested from provider.
2450
+ * @nullable
2451
+ */
2452
+ scope?: string | null;
2453
+ /** The base64 encoded state parameter that was sent in the original authorization request. */
2454
+ state?: string;
2455
+ /**
2456
+ * The "error" query param returned from OAuth2 redirection.
2457
+ * @nullable
2458
+ */
2459
+ error?: string | null;
2460
+ /**
2461
+ * Human-readable description of the error.
2462
+ * @nullable
2463
+ */
2464
+ error_description?: string | null;
2465
+ };
2466
+
2467
+ export declare type ReceiveOAuthCallbackPostResult = NonNullable<Awaited<ReturnType<typeof receiveOAuthCallbackPost>>>;
2468
+
2469
+ export declare type ReceiveOAuthCallbackResult = NonNullable<Awaited<ReturnType<typeof receiveOAuthCallback>>>;
2470
+
2315
2471
  /**
2316
2472
  * Records that the end user was prompted for MFA enrollment. This endpoint sets the enrollmentPromptedAt timestamp to the current time, allowing tracking of whether users have been shown the enrollment prompt, regardless of whether they chose to enroll or skip.
2317
2473
  * @summary Record MFA enrollment prompt
@@ -2428,7 +2584,7 @@ export declare const registerAttestation: (projectId: ProjectId, iosAttestationR
2428
2584
  export declare type RegisterAttestationResult = NonNullable<Awaited<ReturnType<typeof registerAttestation>>>;
2429
2585
 
2430
2586
  /**
2431
- * Registers a Temporary Wallet Secret for a given end user. This secret is generated on the client-side by the end user's device/browser, typically with the CDP Embedded Wallet SDK, and is used to authenticate requests related to signing.
2587
+ * Registers a Temporary Wallet Secret for a given end user. This secret is generated on the client-side by the end user's device/browser, typically with the CDP User Wallet SDK, and is used to authenticate requests related to signing.
2432
2588
 
2433
2589
 
2434
2590
  Temporary Wallet Secrets expire according to the provided TTL. A maximum of 5 Temporary Wallet Secrets can be registered at a given time for a specific end user. If the end user has more than 5 Temporary Wallet Secrets, the oldest one will be deleted to make space for the new one.
@@ -2633,6 +2789,7 @@ export declare type SendEvmAssetWithEndUserAccountBody = {
2633
2789
  useCdpPaymaster?: boolean;
2634
2790
  /** Optional custom Paymaster URL to use for gas sponsorship. Only applicable for EVM Smart Accounts. This allows you to use your own Paymaster service instead of CDP's Paymaster. Cannot be used together with `useCdpPaymaster`. */
2635
2791
  paymasterUrl?: Url;
2792
+ paymasterContext?: PaymasterContext;
2636
2793
  /**
2637
2794
  * Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
2638
2795
  * @pattern ^[a-zA-Z0-9-]{1,100}$
@@ -2886,6 +3043,7 @@ export declare type SendUserOperationWithEndUserAccountBody = {
2886
3043
  useCdpPaymaster: boolean;
2887
3044
  /** The URL of the paymaster to use for the user operation. If using the CDP Paymaster, use the `useCdpPaymaster` option. */
2888
3045
  paymasterUrl?: Url;
3046
+ paymasterContext?: PaymasterContext;
2889
3047
  /**
2890
3048
  * Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
2891
3049
  * @pattern ^[a-zA-Z0-9-]{1,100}$
@@ -3286,11 +3444,8 @@ export declare const SiweAuthenticationType: {
3286
3444
  export declare interface SmsAuthentication {
3287
3445
  /** The type of authentication information. */
3288
3446
  type: SmsAuthenticationType;
3289
- /**
3290
- * The phone number of the end user in E.164 format.
3291
- * @pattern ^\+[1-9]\d{1,14}$
3292
- */
3293
- phoneNumber: string;
3447
+ /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. */
3448
+ phoneNumber: PhoneNumber;
3294
3449
  }
3295
3450
 
3296
3451
  /**
@@ -3556,7 +3711,7 @@ export declare interface UserOperationReceiptRevert {
3556
3711
  }
3557
3712
 
3558
3713
  /**
3559
- * Verifies the end user's email address using a one-time password. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3714
+ * Verifies the end user's email address using a one-time password. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the User Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3560
3715
  * @summary Verify end user email address
3561
3716
  */
3562
3717
  export declare const verifyEmailAuthentication: (projectId: ProjectId, verifyEmailAuthenticationRequest: VerifyEmailAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifyEmailAuthentication200>>) => Promise<VerifyEmailAuthentication200>;
@@ -3567,7 +3722,7 @@ export declare type VerifyEmailAuthentication200 = {
3567
3722
  isNewEndUser: boolean;
3568
3723
  /** The message to display to the end user. */
3569
3724
  message: string;
3570
- /** The access token for the end user. This token should be used in subsequent requests to the Embedded Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3725
+ /** The access token for the end user. This token should be used in subsequent requests to the User Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3571
3726
  accessToken: string;
3572
3727
  /** The date and time until which the access token is valid, in ISO 8601 format. */
3573
3728
  validUntil: string;
@@ -3600,7 +3755,7 @@ export declare interface VerifyOAuthAppleNativeRequest {
3600
3755
  }
3601
3756
 
3602
3757
  /**
3603
- * Verifies the end user's OAuth code. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3758
+ * Verifies the end user's OAuth code. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the User Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3604
3759
  * @summary Verify end user OAuth code
3605
3760
  */
3606
3761
  export declare const verifyOAuthCode: (projectId: ProjectId, providerType: OAuth2ProviderType, verifyOAuthCodeRequest: VerifyOAuthCodeRequest, options?: SecondParameter<typeof cdpApiClient<VerifyOAuthCode200>>) => Promise<VerifyOAuthCode200>;
@@ -3611,7 +3766,7 @@ export declare type VerifyOAuthCode200 = {
3611
3766
  isNewEndUser: boolean;
3612
3767
  /** The message to display to the end user. */
3613
3768
  message: string;
3614
- /** The access token for the end user. This token should be used in subsequent requests to the Embedded Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3769
+ /** The access token for the end user. This token should be used in subsequent requests to the User Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3615
3770
  accessToken: string;
3616
3771
  /** The date and time until which the access token is valid, in ISO 8601 format. */
3617
3772
  validUntil: string;
@@ -3637,7 +3792,7 @@ export declare type VerifyOAuthCodeResult = NonNullable<Awaited<ReturnType<typeo
3637
3792
  export declare type VerifyOAuthEndUserIdentity = VerifyOAuthTelegramRequest | VerifyOAuthAppleNativeRequest;
3638
3793
 
3639
3794
  /**
3640
- * Verifies the end user's identity using data from a third-party provider like Telegram or Apple native sign-in that does not support code-based OAuth flows and only provides user data to flows initiated on a bot's domain. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3795
+ * Verifies the end user's identity using data from a third-party provider like Telegram or Apple native sign-in that does not support code-based OAuth flows and only provides user data to flows initiated on a bot's domain. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the User Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3641
3796
  * @summary Verify third-party end user identity
3642
3797
  */
3643
3798
  export declare const verifyOAuthEndUserIdentity: (projectId: ProjectId, providerType: OAuth2ProviderType, verifyOAuthEndUserIdentity: VerifyOAuthEndUserIdentity, options?: SecondParameter<typeof cdpApiClient<VerifyOAuthEndUserIdentity200>>) => Promise<VerifyOAuthEndUserIdentity200>;
@@ -3648,7 +3803,7 @@ export declare type VerifyOAuthEndUserIdentity200 = {
3648
3803
  isNewEndUser: boolean;
3649
3804
  /** The message to display to the end user. */
3650
3805
  message: string;
3651
- /** The access token for the end user. This token should be used in subsequent requests to the Embedded Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3806
+ /** The access token for the end user. This token should be used in subsequent requests to the User Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3652
3807
  accessToken: string;
3653
3808
  /** The date and time until which the access token is valid, in ISO 8601 format. */
3654
3809
  validUntil: string;
@@ -3681,7 +3836,7 @@ export declare interface VerifyOAuthTelegramRequest {
3681
3836
  }
3682
3837
 
3683
3838
  /**
3684
- * Verifies the end user's Sign In With Ethereum (EIP-4361) signature. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3839
+ * Verifies the end user's Sign In With Ethereum (EIP-4361) signature. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the User Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3685
3840
  * @summary Verify end user SIWE signature
3686
3841
  */
3687
3842
  export declare const verifySiweAuthentication: (projectId: ProjectId, verifySiweAuthenticationRequest: VerifySiweAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifySiweAuthentication200>>) => Promise<VerifySiweAuthentication200>;
@@ -3692,7 +3847,7 @@ export declare type VerifySiweAuthentication200 = {
3692
3847
  isNewEndUser: boolean;
3693
3848
  /** The message to display to the end user. */
3694
3849
  message: string;
3695
- /** The access token for the end user. This token should be used in subsequent requests to the Embedded Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3850
+ /** The access token for the end user. This token should be used in subsequent requests to the User Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3696
3851
  accessToken: string;
3697
3852
  /** The date and time until which the access token is valid, in ISO 8601 format. */
3698
3853
  validUntil: string;
@@ -3713,7 +3868,7 @@ export declare interface VerifySiweAuthenticationRequest {
3713
3868
  export declare type VerifySiweAuthenticationResult = NonNullable<Awaited<ReturnType<typeof verifySiweAuthentication>>>;
3714
3869
 
3715
3870
  /**
3716
- * Verifies the end user's phone number using a one-time password sent via SMS. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3871
+ * Verifies the end user's phone number using a one-time password sent via SMS. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the User Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
3717
3872
  * @summary Verify end user phone number
3718
3873
  */
3719
3874
  export declare const verifySmsAuthentication: (projectId: ProjectId, verifySmsAuthenticationRequest: VerifySmsAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifySmsAuthentication200>>) => Promise<VerifySmsAuthentication200>;
@@ -3724,7 +3879,7 @@ export declare type VerifySmsAuthentication200 = {
3724
3879
  isNewEndUser: boolean;
3725
3880
  /** The message to display to the end user. */
3726
3881
  message: string;
3727
- /** The access token for the end user. This token should be used in subsequent requests to the Embedded Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3882
+ /** The access token for the end user. This token should be used in subsequent requests to the User Wallet APIs by specifing 'Bearer' as the prefix of the `Authorization` header. */
3728
3883
  accessToken: string;
3729
3884
  /** The date and time until which the access token is valid, in ISO 8601 format. */
3730
3885
  validUntil: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coinbase/cdp-api-client",
3
- "version": "0.0.109",
3
+ "version": "0.0.111",
4
4
  "type": "module",
5
5
  "files": [
6
6
  "dist/**",