@dynamic-labs/sdk-api-core 0.5.0 → 0.8.0

package/src/apis/SDKApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { Account, AddBusinessAccountMemberSdkRequest, AddBusinessAccountSignerSdkRequest, AleoCuratedPricesResponse, AleoProverEncryptedRequest, AleoProverPubkeyResponse, AttachSourceRequest, BackupKeySharesToLocationsRequest, BackupKeySharesToLocationsResponse, BusinessAccount, BusinessAccountDetail, BusinessAccountList, BusinessAccountMember, ChainEnum, CheckoutTransaction, CheckoutTransactionCreateRequest, CheckoutTransactionCreateResponse, CoinbaseOnrampGetBuyUrlRequest, CoinbaseOnrampGetBuyUrlResponse, CoinbaseOnrampOrderCreateRequest, CoinbaseOnrampOrderResponse, CompletePasskeyRecoveryRequest, ConnectRequest, CreateBusinessAccountSdkRequest, CreateEmbeddedWalletsRequest, CreateExchangeTransferRequest, CreateRoomsRequest, CreateRoomsResponse, CreateRoomsWithoutWalletIdRequest, CreateRoomsWithoutWalletIdResponse, CreateWaasAccountRequest, CreateWalletAccountRequest, CryptoDotComPaymentCreateRequest, CryptoDotComPaymentResponse, Currency, DelegatedShareDeliveryRequest, DelegatedShareDeliveryResponse, DeleteDeviceRegistrationResponse, DeleteEmbeddedWalletsRequest, DeleteUserPasskeyRequest, DeviceRegistrationsResponse, EmailProviderResponse, EmailVerificationCreateRequest, EmailVerificationCreateResponse, EmailVerificationMfaRequest, EmailVerificationRetryRequest, EmailVerificationVerifyRequest, EmbeddedWalletAuthToken, EmbeddedWalletAuthType, EmbeddedWalletChainEnum, EmbeddedWalletPasscodeClaimRequest, EmbeddedWalletSecret, ExchangeKeyEnum, ExchangeTransaction, ExchangeTransferResponse, ExportAleoViewKeyRequest, ExportEmbeddedWalletResponse, ExportWaasWalletPrivateKeyRequest, ExternalAuthAssertionResponse, ExternalAuthSigninRequest, FarcasterSignInRequest, Flow, FlowAttachSourceRequest, FlowPrepareSigningRequest, FlowQuoteRequest, FlowRecordBroadcastRequest, FlowSourceResponse, GeneratedTokenResponse, GetAvailableEVMGaslessRelayerResponse, GetEVMSponsoredTransactionStatusResponse, GetPasskeyAuthenticationOptionsResponse, GetPasskeyRegistrationOptionsResponse, GetUserPasskeysResponse, GlobalWalletConnection, GlobalWalletConnectionCreateRequest, GlobalWalletSettings, HealthcheckResponse, ImportWaasPrivateKeyRequest, InitEmailAuthRequest, InitEmailAuthResponse, InitPasskeyRecoveryRequest, InitPasskeyRecoveryResponse, InlineObject, InlineObject1, InlineObject2, InlineObject3, InlineObject4, InlineResponse200, InlineResponse2001, InlineResponse2002, InlineResponse2003, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2007, InlineResponse2008, JwksResponse, LinkBusinessAccountWalletSdkRequest, MFAAuthRecoveryDevicePostRequest, MFAAuthTotpDevicePostRequest, MFADevice, MFAGetRecoveryCodesResponse, MFAListDevicesResponse, MFAMethodsResponse, MFARegenRecoveryCodesResponse, MFARegisterPasskeyDeviceGetResponse, MFARegisterPasskeyDevicePostRequest, MFARegisterTotpDeviceGetResponse, MFARegisterTotpDevicePostRequest, MFAUpdateDeviceRequest, MergeUserConflictResolutions, MoonPayCurrenciesResponse, MultichainAccountBalanceResponse, MultichainAccountBalancesRequest, NetworkConfigurationResponse, NonceResponse, NoncesResponse, OauthInitAuthRequest, OauthProviderLoginUrl, OauthRequest, OauthResultRequest, OauthResultResponse, OpenRoomResponse, OpenRoomResponseForReshare, OpenRoomResponseWithServerKeygenIds, PasskeyAuthRequest, PasskeyRegisterRequest, PrefetchRequest, ProjectSettings, ProviderEnum, PublishEvents, RealtimeAuthTokenResponse, RecoverMultipleClientKeySharesRequest, RecoverMultipleClientKeySharesResponse, RefreshKeySharesRequest, RefreshKeySharesResponse, RegisterEmbeddedWalletSessionKeyResponse, RegisterSessionKeyRequest, ReshareRequest, ScanWebsiteUrlRequest, ScanWebsiteUrlResponse, ScreenTransactionRequest, ScreenTransactionResponse, SdkSettingsRequest, SdkUser, SignAleoRequestWithWaasRequest, SignMessageWithWaasRequest, SimulateEVMTransactionRequest, SimulateSVMTransactionRequest, SimulateTransactionResponse, SimulateUserOpRequest, SmsVerificationCreateRequest, SmsVerificationCreateResponse, SmsVerificationRetryRequest, SmsVerificationVerifyRequest, SolanaTransactionOptimizationRequest, SolanaTransactionOptimizationResponse, SponsorEVMTransactionRequest, SponsorEVMTransactionResponse, SponsorSVMTransactionRequest, SponsorSVMTransactionResponse, SsoProviderCheckRequest, SsoProviderCheckResponse, StepUpCheckRequest, StepUpCheckResponse, SupportedOfframpsResponse, SupportedOnrampsResponse, SwapQuoteRequest, SwapQuoteResponse, SwapStatusRequest, SwapStatusResponse, TelegramPostRequest, TokenBalance, TransactionFeeEstimateRequest, TransactionFeeEstimateResponse, TransferBusinessAccountOwnershipSdkRequest, TransferDestinationResponse, TurnkeyCreateWalletAccountsRequestBody, TurnkeyDeleteEmbeddedWalletsRequestBody, UpdateBusinessAccountMemberRoleSdkRequest, UpdateBusinessAccountSdkRequest, UpdateRecoveryEmailRequest, UpdateSelfResponse, UpdateUserPasskeyRequest, UpdateWaasWalletSettingsRequest, UpdateWaasWalletSettingsResponse, UpgradeEmbeddedWalletToV2Request, UserFields, UserFieldsCheckParams, UserFieldsCheckResponse, UserOauthAccessTokenResponse, UserPasskey, UserWalletSelectionRequest, VerifyRequest, VerifyResponse, VerifyUnlinkRequest, WaasPolicyLayerResponse, WaasPolicyLayerUpdateRequest, WaasSignerPolicyLayerUpdateRequest, WaasTransactionBroadcastRequest, WaasTransactionBroadcastResponse, WalletSanctionsResponse, WalletTransactionsResponse, YieldVaultActionRequest, YieldVaultActionResponse, YieldVaultDetails, YieldVaultListResponse, YieldVaultPosition, YieldVaultRewardsResponse } from '../models';
+import { Account, AddBusinessAccountMemberSdkRequest, AddBusinessAccountSignerSdkRequest, AleoCuratedPricesResponse, AleoProverEncryptedRequest, AleoProverPubkeyResponse, AttachSourceRequest, BackupKeySharesToLocationsRequest, BackupKeySharesToLocationsResponse, BusinessAccount, BusinessAccountDetail, BusinessAccountList, BusinessAccountMember, ChainEnum, CheckoutTransaction, CheckoutTransactionCreateRequest, CheckoutTransactionCreateResponse, CoinbaseOnrampGetBuyUrlRequest, CoinbaseOnrampGetBuyUrlResponse, CoinbaseOnrampOrderCreateRequest, CoinbaseOnrampOrderResponse, CompletePasskeyRecoveryRequest, ConnectRequest, CreateBusinessAccountSdkRequest, CreateEmbeddedWalletsRequest, CreateExchangeTransferRequest, CreateRoomsRequest, CreateRoomsResponse, CreateRoomsWithoutWalletIdRequest, CreateRoomsWithoutWalletIdResponse, CreateWaasAccountRequest, CreateWalletAccountRequest, CryptoDotComPaymentCreateRequest, CryptoDotComPaymentResponse, Currency, DelegatedShareDeliveryRequest, DelegatedShareDeliveryResponse, DeleteDeviceRegistrationResponse, DeleteEmbeddedWalletsRequest, DeleteUserPasskeyRequest, DeviceRegistrationsResponse, EmailProviderResponse, EmailVerificationCreateRequest, EmailVerificationCreateResponse, EmailVerificationMfaRequest, EmailVerificationRetryRequest, EmailVerificationVerifyRequest, EmbeddedWalletAuthToken, EmbeddedWalletAuthType, EmbeddedWalletChainEnum, EmbeddedWalletPasscodeClaimRequest, EmbeddedWalletSecret, ExchangeKeyEnum, ExchangeTransaction, ExchangeTransferResponse, ExportAleoViewKeyRequest, ExportEmbeddedWalletResponse, ExportWaasWalletPrivateKeyRequest, ExternalAuthAssertionResponse, ExternalAuthSigninRequest, FarcasterSignInRequest, Flow, FlowAttachSourceRequest, FlowPrepareSigningRequest, FlowQuoteRequest, FlowRecordBroadcastRequest, FlowSourceResponse, GeneratedTokenResponse, GetAvailableEVMGaslessRelayerResponse, GetEVMSponsoredTransactionStatusResponse, GetPasskeyAuthenticationOptionsResponse, GetPasskeyRegistrationOptionsResponse, GetUserPasskeysResponse, GlobalWalletConnection, GlobalWalletConnectionCreateRequest, GlobalWalletSettings, HealthcheckResponse, ImportWaasPrivateKeyRequest, InitEmailAuthRequest, InitEmailAuthResponse, InitPasskeyRecoveryRequest, InitPasskeyRecoveryResponse, InlineObject, InlineObject1, InlineObject2, InlineObject3, InlineObject4, InlineResponse200, InlineResponse2001, InlineResponse2002, InlineResponse2003, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2007, InlineResponse2008, JwksResponse, LinkBusinessAccountWalletSdkRequest, MFAAuthRecoveryDevicePostRequest, MFAAuthTotpDevicePostRequest, MFADevice, MFAGetRecoveryCodesResponse, MFAListDevicesResponse, MFAMethodsResponse, MFARegenRecoveryCodesResponse, MFARegisterPasskeyDeviceGetResponse, MFARegisterPasskeyDevicePostRequest, MFARegisterTotpDeviceGetResponse, MFARegisterTotpDevicePostRequest, MFAUpdateDeviceRequest, MergeUserConflictResolutions, MoonPayCurrenciesResponse, MultichainAccountBalanceResponse, MultichainAccountBalancesRequest, NetworkConfigurationResponse, NonceResponse, NoncesResponse, OauthInitAuthRequest, OauthProviderLoginUrl, OauthRequest, OauthResultRequest, OauthResultResponse, OpenRoomResponse, OpenRoomResponseForReshare, OpenRoomResponseWithServerKeygenIds, PasskeyAuthRequest, PasskeyRegisterRequest, PrefetchRequest, ProjectSettings, ProviderEnum, PublishEvents, RealtimeAuthTokenResponse, RecoverMultipleClientKeySharesRequest, RecoverMultipleClientKeySharesResponse, RefreshKeySharesRequest, RefreshKeySharesResponse, RegisterEmbeddedWalletSessionKeyResponse, RegisterSessionKeyRequest, ReshareRequest, ScanWebsiteUrlRequest, ScanWebsiteUrlResponse, ScreenTransactionRequest, ScreenTransactionResponse, SdkSettingsRequest, SdkUser, SignAleoRequestWithWaasRequest, SignMessageWithWaasRequest, SimulateEVMTransactionRequest, SimulateSVMTransactionRequest, SimulateTransactionResponse, SimulateUserOpRequest, SmsVerificationCreateRequest, SmsVerificationCreateResponse, SmsVerificationRetryRequest, SmsVerificationVerifyRequest, SolanaTransactionOptimizationRequest, SolanaTransactionOptimizationResponse, SponsorEVMTransactionRequest, SponsorEVMTransactionResponse, SponsorSVMTransactionRequest, SponsorSVMTransactionResponse, SsoProviderCheckRequest, SsoProviderCheckResponse, StepUpCheckRequest, StepUpCheckResponse, SupportedOfframpsResponse, SupportedOnrampsResponse, SwapQuoteRequest, SwapQuoteResponse, SwapStatusRequest, SwapStatusResponse, TelegramPostRequest, TokenBalance, TransactionFeeEstimateRequest, TransactionFeeEstimateResponse, TransferBusinessAccountOwnershipSdkRequest, TransferDestinationResponse, TurnkeyCreateWalletAccountsRequestBody, TurnkeyDeleteEmbeddedWalletsRequestBody, UpdateBusinessAccountMemberRoleSdkRequest, UpdateBusinessAccountSdkRequest, UpdateRecoveryEmailRequest, UpdateSelfResponse, UpdateUserPasskeyRequest, UpdateWaasWalletSettingsRequest, UpdateWaasWalletSettingsResponse, UpgradeEmbeddedWalletToV2Request, UserFields, UserFieldsCheckParams, UserFieldsCheckResponse, UserOauthAccessTokenResponse, UserPasskey, UserWalletSelectionRequest, VerifyRequest, VerifyResponse, VerifyUnlinkRequest, WaasPolicyLayerResponse, WaasPolicyLayerUpdateRequest, WaasSignerPolicyLayerUpdateRequest, WaasTransactionBroadcastRequest, WaasTransactionBroadcastResponse, WalletSanctionsResponse, WalletTransactionsResponse, YieldVaultActionRequest, YieldVaultActionResponse, YieldVaultClaimRequest, YieldVaultDetails, YieldVaultListResponse, YieldVaultPosition, YieldVaultRewardsResponse } from '../models';
 export interface AttachFlowSourceRequest {
     environmentId: string;
     flowId: string;
@@ -1514,6 +1514,15 @@ export interface WalletsVerifyRequest {
 export interface WalletsVerifyOptionsRequest {
     environmentId: string;
 }
+export interface YieldVaultClaimOperationRequest {
+    environmentId: string;
+    vaultId: string;
+    yieldVaultClaimRequest: YieldVaultClaimRequest;
+}
+export interface YieldVaultClaimOptionsRequest {
+    environmentId: string;
+    vaultId: string;
+}
 export interface YieldVaultDepositRequest {
     environmentId: string;
     vaultId: string;
@@ -4972,6 +4981,24 @@ export declare class SDKApi extends runtime.BaseAPI {
      * Options call for this endpoint
      */
     walletsVerifyOptions(requestParameters: WalletsVerifyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
+    /**
+     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * Build a vault reward-claim signing payload
+     */
+    yieldVaultClaimRaw(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultActionResponse>>;
+    /**
+     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * Build a vault reward-claim signing payload
+     */
+    yieldVaultClaim(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<YieldVaultActionResponse>;
+    /**
+     * Options call for this endpoint
+     */
+    yieldVaultClaimOptionsRaw(requestParameters: YieldVaultClaimOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Options call for this endpoint
+     */
+    yieldVaultClaimOptions(requestParameters: YieldVaultClaimOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
      * Builds an unsigned deposit signing payload for the given vault and wallet address. When the payload includes an approval step, the SDK signs and sends it before the main transaction.
      * Build a vault deposit signing payload
@@ -5015,12 +5042,12 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     yieldVaultRewardsOptions(requestParameters: YieldVaultRewardsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
-     * Builds an unsigned ERC-4626 withdraw signing payload for the given vault and wallet address. No ERC-20 approval is needed for withdrawals — the owner redeems shares they already hold, so the response never contains `evmApproval`.
+     * Builds an unsigned withdraw signing payload for the given vault and wallet address. Withdrawals redeem shares the owner already holds, so no approval step is needed and the response never includes one.
      * Build a vault withdraw signing payload
      */
     yieldVaultWithdrawRaw(requestParameters: YieldVaultWithdrawRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultActionResponse>>;
     /**
-     * Builds an unsigned ERC-4626 withdraw signing payload for the given vault and wallet address. No ERC-20 approval is needed for withdrawals — the owner redeems shares they already hold, so the response never contains `evmApproval`.
+     * Builds an unsigned withdraw signing payload for the given vault and wallet address. Withdrawals redeem shares the owner already holds, so no approval step is needed and the response never includes one.
      * Build a vault withdraw signing payload
      */
     yieldVaultWithdraw(requestParameters: YieldVaultWithdrawRequest, initOverrides?: RequestInit): Promise<YieldVaultActionResponse>;

package/src/apis/SDKApi.js

@@ -299,6 +299,7 @@ import '../models/WalletTransactionType.js';
 import { WalletTransactionsResponseFromJSON } from '../models/WalletTransactionsResponse.js';
 import { YieldVaultActionRequestToJSON } from '../models/YieldVaultActionRequest.js';
 import { YieldVaultActionResponseFromJSON } from '../models/YieldVaultActionResponse.js';
+import { YieldVaultClaimRequestToJSON } from '../models/YieldVaultClaimRequest.js';
 import { YieldVaultDetailsFromJSON } from '../models/YieldVaultDetails.js';
 import { YieldVaultListResponseFromJSON } from '../models/YieldVaultListResponse.js';
 import { YieldVaultPositionFromJSON } from '../models/YieldVaultPosition.js';
@@ -11856,6 +11857,66 @@ class SDKApi extends BaseAPI {
     async walletsVerifyOptions(requestParameters, initOverrides) {
         await this.walletsVerifyOptionsRaw(requestParameters, initOverrides);
     }
+    /**
+     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * Build a vault reward-claim signing payload
+     */
+    async yieldVaultClaimRaw(requestParameters, initOverrides) {
+        if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
+            throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling yieldVaultClaim.');
+        }
+        if (requestParameters.vaultId === null || requestParameters.vaultId === undefined) {
+            throw new RequiredError('vaultId', 'Required parameter requestParameters.vaultId was null or undefined when calling yieldVaultClaim.');
+        }
+        if (requestParameters.yieldVaultClaimRequest === null || requestParameters.yieldVaultClaimRequest === undefined) {
+            throw new RequiredError('yieldVaultClaimRequest', 'Required parameter requestParameters.yieldVaultClaimRequest was null or undefined when calling yieldVaultClaim.');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: `/sdk/{environmentId}/yield/vaults/{vaultId}/claim`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))).replace(`{${"vaultId"}}`, encodeURIComponent(String(requestParameters.vaultId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: YieldVaultClaimRequestToJSON(requestParameters.yieldVaultClaimRequest),
+        }, initOverrides);
+        return new JSONApiResponse(response, (jsonValue) => YieldVaultActionResponseFromJSON(jsonValue));
+    }
+    /**
+     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * Build a vault reward-claim signing payload
+     */
+    async yieldVaultClaim(requestParameters, initOverrides) {
+        const response = await this.yieldVaultClaimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Options call for this endpoint
+     */
+    async yieldVaultClaimOptionsRaw(requestParameters, initOverrides) {
+        if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
+            throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling yieldVaultClaimOptions.');
+        }
+        if (requestParameters.vaultId === null || requestParameters.vaultId === undefined) {
+            throw new RequiredError('vaultId', 'Required parameter requestParameters.vaultId was null or undefined when calling yieldVaultClaimOptions.');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        const response = await this.request({
+            path: `/sdk/{environmentId}/yield/vaults/{vaultId}/claim`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))).replace(`{${"vaultId"}}`, encodeURIComponent(String(requestParameters.vaultId))),
+            method: 'OPTIONS',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new VoidApiResponse(response);
+    }
+    /**
+     * Options call for this endpoint
+     */
+    async yieldVaultClaimOptions(requestParameters, initOverrides) {
+        await this.yieldVaultClaimOptionsRaw(requestParameters, initOverrides);
+    }
     /**
      * Builds an unsigned deposit signing payload for the given vault and wallet address. When the payload includes an approval step, the SDK signs and sends it before the main transaction.
      * Build a vault deposit signing payload
@@ -11995,7 +12056,7 @@ class SDKApi extends BaseAPI {
         await this.yieldVaultRewardsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * Builds an unsigned ERC-4626 withdraw signing payload for the given vault and wallet address. No ERC-20 approval is needed for withdrawals — the owner redeems shares they already hold, so the response never contains `evmApproval`.
+     * Builds an unsigned withdraw signing payload for the given vault and wallet address. Withdrawals redeem shares the owner already holds, so no approval step is needed and the response never includes one.
      * Build a vault withdraw signing payload
      */
     async yieldVaultWithdrawRaw(requestParameters, initOverrides) {
@@ -12021,7 +12082,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultActionResponseFromJSON(jsonValue));
     }
     /**
-     * Builds an unsigned ERC-4626 withdraw signing payload for the given vault and wallet address. No ERC-20 approval is needed for withdrawals — the owner redeems shares they already hold, so the response never contains `evmApproval`.
+     * Builds an unsigned withdraw signing payload for the given vault and wallet address. Withdrawals redeem shares the owner already holds, so no approval step is needed and the response never includes one.
      * Build a vault withdraw signing payload
      */
     async yieldVaultWithdraw(requestParameters, initOverrides) {