From 33cd6b1ebda5a60f18b771b17d76ca3431ff6ab2 Mon Sep 17 00:00:00 2001 From: fireblocks_dx_team Date: Tue, 5 May 2026 16:18:39 +0000 Subject: [PATCH] Generated SDK #3222 --- .openapi-generator/FILES | 54 + CHANGELOG.md | 239 -- README.md | 35 +- api/openapi.yaml | 3014 +++++++++++++---- build.gradle | 2 +- docs/ApiUserApi.md | 4 +- docs/AuditLogsApi.md | 2 +- docs/BlockchainsAssetsApi.md | 4 +- docs/ChainDescriptor.md | 4 + docs/CircleGatewayWalletInfoResponse.md | 26 + docs/CircleGatewayWalletStatusResponse.md | 23 + docs/ComplianceApi.md | 442 ++- docs/ConnectedAccountsBetaApi.md | 2 +- docs/ConsoleUserApi.md | 4 +- docs/ContractInteractionsApi.md | 4 +- docs/ContractTemplatesApi.md | 2 +- docs/ContractsApi.md | 14 +- docs/CosignersBetaApi.md | 20 +- docs/CounterpartyGroup.md | 20 + docs/CounterpartyGroupsPaginatedResponse.md | 16 + docs/CreateCounterpartyGroupRequest.md | 16 + ...CreateMultipleDepositAddressesJobStatus.md | 2 +- docs/CreateMultipleVaultAccountsJobStatus.md | 4 +- docs/CreateQuote.md | 1 + docs/CreateVaultAccountRequest.md | 4 +- docs/ExchangeAccountsApi.md | 10 +- docs/ExternalWalletsApi.md | 16 +- docs/FiatAccountsApi.md | 4 +- docs/GasStationsApi.md | 8 +- docs/MomoPaymentInfo.md | 2 + docs/NftsApi.md | 2 +- docs/OffExchangesApi.md | 10 +- docs/PaymentsPayoutApi.md | 6 +- docs/PayoutResponse.md | 2 +- docs/PolicyEditorBetaApi.md | 10 +- docs/PolicyEditorV2BetaApi.md | 6 +- docs/Quote.md | 1 + docs/QuotePropertiesDetails.md | 1 + docs/ResetDeviceApi.md | 2 +- docs/SmartTransferApi.md | 24 +- docs/StakingApi.md | 38 +- docs/TRLinkBeneficiaryPii.md | 14 + docs/TRLinkGetRequiredActionsResponse.md | 14 + docs/TRLinkManualDecisionAction.md | 13 + docs/TRLinkManualDecisionDestinationDetail.md | 16 + docs/TRLinkManualDecisionRequest.md | 15 + docs/TRLinkManualDecisionResponse.md | 19 + docs/TRLinkManualDecisionSource.md | 13 + docs/TRLinkRequiredAction.md | 16 + docs/TRLinkRequiredActionData.md | 15 + docs/TRLinkRequiredField.md | 15 + docs/TRLinkResolveActionData.md | 14 + docs/TRLinkResolveActionRequest.md | 15 + docs/TokenizationApi.md | 6 +- docs/TrLinkApi.md | 266 ++ docs/TransactionsApi.md | 22 +- docs/UpdateCounterpartyGroupRequest.md | 17 + docs/UserGroupsBetaApi.md | 10 +- docs/UtxoManagementBetaApi.md | 4 +- docs/VaultsApi.md | 302 +- docs/WebhooksApi.md | 2 +- docs/WhitelistIpAddressesApi.md | 2 +- docs/WithdrawRequest.md | 2 +- docs/WorkspaceStatusBetaApi.md | 2 +- pom.xml | 2 +- .../com/fireblocks/sdk/Configuration.java | 2 +- .../com/fireblocks/sdk/api/ApiUserApi.java | 6 +- .../com/fireblocks/sdk/api/AuditLogsApi.java | 4 +- .../sdk/api/BlockchainsAssetsApi.java | 8 +- .../com/fireblocks/sdk/api/ComplianceApi.java | 423 ++- .../sdk/api/ConnectedAccountsBetaApi.java | 4 +- .../fireblocks/sdk/api/ConsoleUserApi.java | 8 +- .../sdk/api/ContractInteractionsApi.java | 8 +- .../sdk/api/ContractTemplatesApi.java | 4 +- .../com/fireblocks/sdk/api/ContractsApi.java | 22 +- .../fireblocks/sdk/api/CosignersBetaApi.java | 29 +- .../sdk/api/ExchangeAccountsApi.java | 14 +- .../sdk/api/ExternalWalletsApi.java | 32 +- .../fireblocks/sdk/api/FiatAccountsApi.java | 7 +- .../fireblocks/sdk/api/GasStationsApi.java | 14 +- .../java/com/fireblocks/sdk/api/NftsApi.java | 4 +- .../fireblocks/sdk/api/OffExchangesApi.java | 14 +- .../fireblocks/sdk/api/PaymentsPayoutApi.java | 50 +- .../sdk/api/PolicyEditorBetaApi.java | 56 +- .../sdk/api/PolicyEditorV2BetaApi.java | 15 +- .../fireblocks/sdk/api/ResetDeviceApi.java | 3 +- .../fireblocks/sdk/api/SmartTransferApi.java | 43 +- .../com/fireblocks/sdk/api/StakingApi.java | 51 +- .../fireblocks/sdk/api/TokenizationApi.java | 12 +- .../com/fireblocks/sdk/api/TrLinkApi.java | 299 ++ .../fireblocks/sdk/api/TransactionsApi.java | 42 +- .../fireblocks/sdk/api/UserGroupsBetaApi.java | 24 +- .../sdk/api/UtxoManagementBetaApi.java | 7 +- .../com/fireblocks/sdk/api/VaultsApi.java | 311 +- .../com/fireblocks/sdk/api/WebhooksApi.java | 2 +- .../sdk/api/WhitelistIpAddressesApi.java | 3 +- .../sdk/api/WorkspaceStatusBetaApi.java | 2 +- .../fireblocks/sdk/model/ChainDescriptor.java | 4 + .../CircleGatewayWalletInfoResponse.java | 365 ++ .../CircleGatewayWalletStatusResponse.java | 224 ++ .../sdk/model/CounterpartyGroup.java | 415 +++ .../CounterpartyGroupsPaginatedResponse.java | 252 ++ .../model/CreateCounterpartyGroupRequest.java | 252 ++ ...eateMultipleDepositAddressesJobStatus.java | 2 +- .../CreateMultipleVaultAccountsJobStatus.java | 113 +- .../com/fireblocks/sdk/model/CreateQuote.java | 49 +- .../sdk/model/CreateVaultAccountRequest.java | 15 +- .../fireblocks/sdk/model/MomoPaymentInfo.java | 48 +- .../fireblocks/sdk/model/PayoutResponse.java | 12 +- .../java/com/fireblocks/sdk/model/Quote.java | 49 + .../sdk/model/QuotePropertiesDetails.java | 57 +- .../sdk/model/TRLinkBeneficiaryPii.java | 140 + .../TRLinkGetRequiredActionsResponse.java | 171 + .../sdk/model/TRLinkManualDecisionAction.java | 64 + ...TRLinkManualDecisionDestinationDetail.java | 240 ++ .../model/TRLinkManualDecisionRequest.java | 190 ++ .../model/TRLinkManualDecisionResponse.java | 399 +++ .../sdk/model/TRLinkManualDecisionSource.java | 64 + .../sdk/model/TRLinkMissingTrmAction2.java | 2 +- .../sdk/model/TRLinkRequiredAction.java | 223 ++ .../sdk/model/TRLinkRequiredActionData.java | 244 ++ .../sdk/model/TRLinkRequiredField.java | 186 + .../sdk/model/TRLinkResolveActionData.java | 139 + .../sdk/model/TRLinkResolveActionRequest.java | 185 + .../model/UpdateCounterpartyGroupRequest.java | 281 ++ .../fireblocks/sdk/model/WithdrawRequest.java | 8 +- .../fireblocks/sdk/api/ApiUserApiTest.java | 6 +- .../fireblocks/sdk/api/AuditLogsApiTest.java | 2 +- .../sdk/api/BlockchainsAssetsApiTest.java | 8 +- .../fireblocks/sdk/api/ComplianceApiTest.java | 102 +- .../sdk/api/ConnectedAccountsBetaApiTest.java | 4 +- .../sdk/api/ConsoleUserApiTest.java | 4 +- .../sdk/api/ContractInteractionsApiTest.java | 7 +- .../sdk/api/ContractTemplatesApiTest.java | 2 +- .../fireblocks/sdk/api/ContractsApiTest.java | 28 +- .../sdk/api/CosignersBetaApiTest.java | 26 +- .../sdk/api/ExchangeAccountsApiTest.java | 14 +- .../sdk/api/ExternalWalletsApiTest.java | 32 +- .../sdk/api/FiatAccountsApiTest.java | 4 +- .../sdk/api/GasStationsApiTest.java | 16 +- .../com/fireblocks/sdk/api/NftsApiTest.java | 4 +- .../sdk/api/OffExchangesApiTest.java | 18 +- .../sdk/api/PaymentsPayoutApiTest.java | 48 +- .../sdk/api/PolicyEditorBetaApiTest.java | 60 +- .../sdk/api/PolicyEditorV2BetaApiTest.java | 16 +- .../sdk/api/ResetDeviceApiTest.java | 2 +- .../sdk/api/SmartTransferApiTest.java | 45 +- .../fireblocks/sdk/api/StakingApiTest.java | 34 +- .../sdk/api/TokenizationApiTest.java | 11 +- .../com/fireblocks/sdk/api/TrLinkApiTest.java | 58 + .../sdk/api/TransactionsApiTest.java | 38 +- .../sdk/api/UserGroupsBetaApiTest.java | 24 +- .../sdk/api/UtxoManagementBetaApiTest.java | 7 +- .../com/fireblocks/sdk/api/VaultsApiTest.java | 139 +- .../fireblocks/sdk/api/WebhooksApiTest.java | 4 +- .../sdk/api/WhitelistIpAddressesApiTest.java | 4 +- .../sdk/api/WorkspaceStatusBetaApiTest.java | 4 +- ...ditionalInfoRequestAdditionalInfoTest.java | 6 + .../CircleGatewayWalletInfoResponseTest.java | 57 + ...CircleGatewayWalletStatusResponseTest.java | 39 + .../sdk/model/CounterpartyGroupTest.java | 69 + ...unterpartyGroupsPaginatedResponseTest.java | 46 + .../CreateCounterpartyGroupRequestTest.java | 45 + ...ateMultipleVaultAccountsJobStatusTest.java | 12 + .../fireblocks/sdk/model/CreateQuoteTest.java | 6 + .../sdk/model/MomoPaymentInfoTest.java | 6 + .../sdk/model/QuotePropertiesDetailsTest.java | 6 + .../com/fireblocks/sdk/model/QuoteTest.java | 6 + .../sdk/model/TRLinkBeneficiaryPiiTest.java | 33 + .../TRLinkGetRequiredActionsResponseTest.java | 33 + .../model/TRLinkManualDecisionActionTest.java | 25 + ...nkManualDecisionDestinationDetailTest.java | 46 + .../TRLinkManualDecisionRequestTest.java | 39 + .../TRLinkManualDecisionResponseTest.java | 63 + .../model/TRLinkManualDecisionSourceTest.java | 25 + .../model/TRLinkRequiredActionDataTest.java | 39 + .../sdk/model/TRLinkRequiredActionTest.java | 45 + .../sdk/model/TRLinkRequiredFieldTest.java | 39 + .../model/TRLinkResolveActionDataTest.java | 33 + .../model/TRLinkResolveActionRequestTest.java | 39 + .../UpdateCounterpartyGroupRequestTest.java | 51 + 181 files changed, 10632 insertions(+), 1779 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 docs/CircleGatewayWalletInfoResponse.md create mode 100644 docs/CircleGatewayWalletStatusResponse.md create mode 100644 docs/CounterpartyGroup.md create mode 100644 docs/CounterpartyGroupsPaginatedResponse.md create mode 100644 docs/CreateCounterpartyGroupRequest.md create mode 100644 docs/TRLinkBeneficiaryPii.md create mode 100644 docs/TRLinkGetRequiredActionsResponse.md create mode 100644 docs/TRLinkManualDecisionAction.md create mode 100644 docs/TRLinkManualDecisionDestinationDetail.md create mode 100644 docs/TRLinkManualDecisionRequest.md create mode 100644 docs/TRLinkManualDecisionResponse.md create mode 100644 docs/TRLinkManualDecisionSource.md create mode 100644 docs/TRLinkRequiredAction.md create mode 100644 docs/TRLinkRequiredActionData.md create mode 100644 docs/TRLinkRequiredField.md create mode 100644 docs/TRLinkResolveActionData.md create mode 100644 docs/TRLinkResolveActionRequest.md create mode 100644 docs/UpdateCounterpartyGroupRequest.md create mode 100644 src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponse.java create mode 100644 src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponse.java create mode 100644 src/main/java/com/fireblocks/sdk/model/CounterpartyGroup.java create mode 100644 src/main/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponse.java create mode 100644 src/main/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequest.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPii.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponse.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionAction.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetail.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequest.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponse.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionSource.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkRequiredAction.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkRequiredActionData.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkRequiredField.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionData.java create mode 100644 src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionRequest.java create mode 100644 src/main/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponseTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponseTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/CounterpartyGroupTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponseTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequestTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPiiTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponseTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionActionTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetailTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequestTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponseTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionSourceTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionDataTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkRequiredFieldTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionDataTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionRequestTest.java create mode 100644 src/test/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequestTest.java diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index bf883168..dcf6475e 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -159,6 +159,8 @@ docs/ChannelDvnConfigWithConfirmations.md docs/ChapsAddress.md docs/ChapsDestination.md docs/ChapsPaymentInfo.md +docs/CircleGatewayWalletInfoResponse.md +docs/CircleGatewayWalletStatusResponse.md docs/ClaimRewardsRequest.md docs/CollectionBurnRequestDto.md docs/CollectionBurnResponseDto.md @@ -245,6 +247,8 @@ docs/ConvertAssetsResponse.md docs/Cosigner.md docs/CosignersBetaApi.md docs/CosignersPaginatedResponse.md +docs/CounterpartyGroup.md +docs/CounterpartyGroupsPaginatedResponse.md docs/CreateAPIUser.md docs/CreateAddressRequest.md docs/CreateAddressResponse.md @@ -255,6 +259,7 @@ docs/CreateConnectionResponse.md docs/CreateConsoleUser.md docs/CreateContractRequest.md docs/CreateConversionConfigOperationRequest.md +docs/CreateCounterpartyGroupRequest.md docs/CreateDisbursementConfigOperationRequest.md docs/CreateEarnActionRequest.md docs/CreateEarnActionResponse.md @@ -851,6 +856,7 @@ docs/TRLinkAsset.md docs/TRLinkAssetData.md docs/TRLinkAssetFormat.md docs/TRLinkAssetsListPagedResponse.md +docs/TRLinkBeneficiaryPii.md docs/TRLinkCancelTrmRequest.md docs/TRLinkConnectIntegrationRequest.md docs/TRLinkCreateCustomerRequest.md @@ -862,10 +868,16 @@ docs/TRLinkDestinationTransferPeerPath.md docs/TRLinkDiscoverableStatus.md docs/TRLinkFiatValue.md docs/TRLinkGeographicAddressRequest.md +docs/TRLinkGetRequiredActionsResponse.md docs/TRLinkGetSupportedAssetResponse.md docs/TRLinkIvms.md docs/TRLinkIvmsResponse.md docs/TRLinkJwkPublicKey.md +docs/TRLinkManualDecisionAction.md +docs/TRLinkManualDecisionDestinationDetail.md +docs/TRLinkManualDecisionRequest.md +docs/TRLinkManualDecisionResponse.md +docs/TRLinkManualDecisionSource.md docs/TRLinkMissingTrmAction.md docs/TRLinkMissingTrmAction2.md docs/TRLinkMissingTrmActionEnum.md @@ -895,6 +907,11 @@ docs/TRLinkRegistrationResult.md docs/TRLinkRegistrationResultFullPayload.md docs/TRLinkRegistrationStatus.md docs/TRLinkRegistrationStatusEnum.md +docs/TRLinkRequiredAction.md +docs/TRLinkRequiredActionData.md +docs/TRLinkRequiredField.md +docs/TRLinkResolveActionData.md +docs/TRLinkResolveActionRequest.md docs/TRLinkResult.md docs/TRLinkResultFullPayload.md docs/TRLinkRuleBase.md @@ -1046,6 +1063,7 @@ docs/UnstakeRequest.md docs/UpdateAssetUserMetadataRequest.md docs/UpdateCallbackHandlerRequest.md docs/UpdateCallbackHandlerResponse.md +docs/UpdateCounterpartyGroupRequest.md docs/UpdateDraftRequest.md docs/UpdateLegalEntityRequest.md docs/UpdateTagRequest.md @@ -1337,6 +1355,8 @@ src/main/java/com/fireblocks/sdk/model/ChannelDvnConfigWithConfirmations.java src/main/java/com/fireblocks/sdk/model/ChapsAddress.java src/main/java/com/fireblocks/sdk/model/ChapsDestination.java src/main/java/com/fireblocks/sdk/model/ChapsPaymentInfo.java +src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponse.java +src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponse.java src/main/java/com/fireblocks/sdk/model/ClaimRewardsRequest.java src/main/java/com/fireblocks/sdk/model/CollectionBurnRequestDto.java src/main/java/com/fireblocks/sdk/model/CollectionBurnResponseDto.java @@ -1415,6 +1435,8 @@ src/main/java/com/fireblocks/sdk/model/ConvertAssetsRequest.java src/main/java/com/fireblocks/sdk/model/ConvertAssetsResponse.java src/main/java/com/fireblocks/sdk/model/Cosigner.java src/main/java/com/fireblocks/sdk/model/CosignersPaginatedResponse.java +src/main/java/com/fireblocks/sdk/model/CounterpartyGroup.java +src/main/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponse.java src/main/java/com/fireblocks/sdk/model/CreateAPIUser.java src/main/java/com/fireblocks/sdk/model/CreateAddressRequest.java src/main/java/com/fireblocks/sdk/model/CreateAddressResponse.java @@ -1425,6 +1447,7 @@ src/main/java/com/fireblocks/sdk/model/CreateConnectionResponse.java src/main/java/com/fireblocks/sdk/model/CreateConsoleUser.java src/main/java/com/fireblocks/sdk/model/CreateContractRequest.java src/main/java/com/fireblocks/sdk/model/CreateConversionConfigOperationRequest.java +src/main/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequest.java src/main/java/com/fireblocks/sdk/model/CreateDisbursementConfigOperationRequest.java src/main/java/com/fireblocks/sdk/model/CreateEarnActionRequest.java src/main/java/com/fireblocks/sdk/model/CreateEarnActionResponse.java @@ -2000,6 +2023,7 @@ src/main/java/com/fireblocks/sdk/model/TRLinkAsset.java src/main/java/com/fireblocks/sdk/model/TRLinkAssetData.java src/main/java/com/fireblocks/sdk/model/TRLinkAssetFormat.java src/main/java/com/fireblocks/sdk/model/TRLinkAssetsListPagedResponse.java +src/main/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPii.java src/main/java/com/fireblocks/sdk/model/TRLinkCancelTrmRequest.java src/main/java/com/fireblocks/sdk/model/TRLinkConnectIntegrationRequest.java src/main/java/com/fireblocks/sdk/model/TRLinkCreateCustomerRequest.java @@ -2011,10 +2035,16 @@ src/main/java/com/fireblocks/sdk/model/TRLinkDestinationTransferPeerPath.java src/main/java/com/fireblocks/sdk/model/TRLinkDiscoverableStatus.java src/main/java/com/fireblocks/sdk/model/TRLinkFiatValue.java src/main/java/com/fireblocks/sdk/model/TRLinkGeographicAddressRequest.java +src/main/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponse.java src/main/java/com/fireblocks/sdk/model/TRLinkGetSupportedAssetResponse.java src/main/java/com/fireblocks/sdk/model/TRLinkIvms.java src/main/java/com/fireblocks/sdk/model/TRLinkIvmsResponse.java src/main/java/com/fireblocks/sdk/model/TRLinkJwkPublicKey.java +src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionAction.java +src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetail.java +src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequest.java +src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponse.java +src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionSource.java src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction.java src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionEnum.java @@ -2044,6 +2074,11 @@ src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationResult.java src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationResultFullPayload.java src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationStatus.java src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusEnum.java +src/main/java/com/fireblocks/sdk/model/TRLinkRequiredAction.java +src/main/java/com/fireblocks/sdk/model/TRLinkRequiredActionData.java +src/main/java/com/fireblocks/sdk/model/TRLinkRequiredField.java +src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionData.java +src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionRequest.java src/main/java/com/fireblocks/sdk/model/TRLinkResult.java src/main/java/com/fireblocks/sdk/model/TRLinkResultFullPayload.java src/main/java/com/fireblocks/sdk/model/TRLinkRuleBase.java @@ -2189,6 +2224,7 @@ src/main/java/com/fireblocks/sdk/model/UnstakeRequest.java src/main/java/com/fireblocks/sdk/model/UpdateAssetUserMetadataRequest.java src/main/java/com/fireblocks/sdk/model/UpdateCallbackHandlerRequest.java src/main/java/com/fireblocks/sdk/model/UpdateCallbackHandlerResponse.java +src/main/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequest.java src/main/java/com/fireblocks/sdk/model/UpdateDraftRequest.java src/main/java/com/fireblocks/sdk/model/UpdateLegalEntityRequest.java src/main/java/com/fireblocks/sdk/model/UpdateTagRequest.java @@ -2448,6 +2484,8 @@ src/test/java/com/fireblocks/sdk/model/ChannelDvnConfigWithConfirmationsTest.jav src/test/java/com/fireblocks/sdk/model/ChapsAddressTest.java src/test/java/com/fireblocks/sdk/model/ChapsDestinationTest.java src/test/java/com/fireblocks/sdk/model/ChapsPaymentInfoTest.java +src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponseTest.java +src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponseTest.java src/test/java/com/fireblocks/sdk/model/ClaimRewardsRequestTest.java src/test/java/com/fireblocks/sdk/model/CollectionBurnRequestDtoTest.java src/test/java/com/fireblocks/sdk/model/CollectionBurnResponseDtoTest.java @@ -2526,6 +2564,8 @@ src/test/java/com/fireblocks/sdk/model/ConvertAssetsRequestTest.java src/test/java/com/fireblocks/sdk/model/ConvertAssetsResponseTest.java src/test/java/com/fireblocks/sdk/model/CosignerTest.java src/test/java/com/fireblocks/sdk/model/CosignersPaginatedResponseTest.java +src/test/java/com/fireblocks/sdk/model/CounterpartyGroupTest.java +src/test/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponseTest.java src/test/java/com/fireblocks/sdk/model/CreateAPIUserTest.java src/test/java/com/fireblocks/sdk/model/CreateAddressRequestTest.java src/test/java/com/fireblocks/sdk/model/CreateAddressResponseTest.java @@ -2536,6 +2576,7 @@ src/test/java/com/fireblocks/sdk/model/CreateConnectionResponseTest.java src/test/java/com/fireblocks/sdk/model/CreateConsoleUserTest.java src/test/java/com/fireblocks/sdk/model/CreateContractRequestTest.java src/test/java/com/fireblocks/sdk/model/CreateConversionConfigOperationRequestTest.java +src/test/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequestTest.java src/test/java/com/fireblocks/sdk/model/CreateDisbursementConfigOperationRequestTest.java src/test/java/com/fireblocks/sdk/model/CreateEarnActionRequestTest.java src/test/java/com/fireblocks/sdk/model/CreateEarnActionResponseTest.java @@ -3111,6 +3152,7 @@ src/test/java/com/fireblocks/sdk/model/TRLinkAssetDataTest.java src/test/java/com/fireblocks/sdk/model/TRLinkAssetFormatTest.java src/test/java/com/fireblocks/sdk/model/TRLinkAssetTest.java src/test/java/com/fireblocks/sdk/model/TRLinkAssetsListPagedResponseTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPiiTest.java src/test/java/com/fireblocks/sdk/model/TRLinkCancelTrmRequestTest.java src/test/java/com/fireblocks/sdk/model/TRLinkConnectIntegrationRequestTest.java src/test/java/com/fireblocks/sdk/model/TRLinkCreateCustomerRequestTest.java @@ -3122,10 +3164,16 @@ src/test/java/com/fireblocks/sdk/model/TRLinkDestinationTransferPeerPathTest.jav src/test/java/com/fireblocks/sdk/model/TRLinkDiscoverableStatusTest.java src/test/java/com/fireblocks/sdk/model/TRLinkFiatValueTest.java src/test/java/com/fireblocks/sdk/model/TRLinkGeographicAddressRequestTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponseTest.java src/test/java/com/fireblocks/sdk/model/TRLinkGetSupportedAssetResponseTest.java src/test/java/com/fireblocks/sdk/model/TRLinkIvmsResponseTest.java src/test/java/com/fireblocks/sdk/model/TRLinkIvmsTest.java src/test/java/com/fireblocks/sdk/model/TRLinkJwkPublicKeyTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionActionTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetailTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequestTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponseTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionSourceTest.java src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2Test.java src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionEnumTest.java src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionTest.java @@ -3155,6 +3203,11 @@ src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationResultFullPayloadTest.j src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationResultTest.java src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusEnumTest.java src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionDataTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkRequiredFieldTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionDataTest.java +src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionRequestTest.java src/test/java/com/fireblocks/sdk/model/TRLinkResultFullPayloadTest.java src/test/java/com/fireblocks/sdk/model/TRLinkResultTest.java src/test/java/com/fireblocks/sdk/model/TRLinkRuleBaseTest.java @@ -3300,6 +3353,7 @@ src/test/java/com/fireblocks/sdk/model/UnstakeRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateAssetUserMetadataRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateCallbackHandlerRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateCallbackHandlerResponseTest.java +src/test/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateDraftRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateLegalEntityRequestTest.java src/test/java/com/fireblocks/sdk/model/UpdateTagRequestTest.java diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 60a5e59e..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,239 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [v17.0.0](https://github.com/fireblocks/java-sdk/compare/v15.0.0...v17.0.0) - 2026-04-20 - -### Merged - -- Generated SDK #9605 (major) [`#132`](https://github.com/fireblocks/java-sdk/pull/132) - -## [v15.0.0](https://github.com/fireblocks/java-sdk/compare/v14.1.0...v15.0.0) - 2026-03-15 - -### Merged - -- Generated SDK #3733 (major) [`#128`](https://github.com/fireblocks/java-sdk/pull/128) - -## [v14.1.0](https://github.com/fireblocks/java-sdk/compare/v14.0.0...v14.1.0) - 2026-02-26 - -### Merged - -- Generated SDK #2167 [`#126`](https://github.com/fireblocks/java-sdk/pull/126) - -## [v14.0.0](https://github.com/fireblocks/java-sdk/compare/v13.0.0...v14.0.0) - 2026-02-03 - -### Merged - -- Generated SDK #4746 [`#121`](https://github.com/fireblocks/java-sdk/pull/121) - -## [v13.0.0](https://github.com/fireblocks/java-sdk/compare/v12.1.3...v13.0.0) - 2025-11-13 - -### Merged - -- Generated SDK #5834 [`#116`](https://github.com/fireblocks/java-sdk/pull/116) - -## [v12.1.3](https://github.com/fireblocks/java-sdk/compare/v12.1.2...v12.1.3) - 2025-10-22 - -### Merged - -- Generated SDK #8293 [`#115`](https://github.com/fireblocks/java-sdk/pull/115) - -## [v12.1.2](https://github.com/fireblocks/java-sdk/compare/v12.1.1...v12.1.2) - 2025-09-29 - -### Merged - -- Generated SDK #6061 [`#113`](https://github.com/fireblocks/java-sdk/pull/113) - -## [v12.1.1](https://github.com/fireblocks/java-sdk/compare/v12.1.0...v12.1.1) - 2025-09-10 - -### Merged - -- Generated SDK #1410 [`#111`](https://github.com/fireblocks/java-sdk/pull/111) - -## [v12.1.0](https://github.com/fireblocks/java-sdk/compare/v12.0.0...v12.1.0) - 2025-09-09 - -### Merged - -- Generated SDK #4521 [`#109`](https://github.com/fireblocks/java-sdk/pull/109) - -## [v12.0.0](https://github.com/fireblocks/java-sdk/compare/v11.2.0...v12.0.0) - 2025-09-01 - -### Merged - -- Generated SDK #7741 [`#108`](https://github.com/fireblocks/java-sdk/pull/108) - -## [v11.2.0](https://github.com/fireblocks/java-sdk/compare/v11.1.0...v11.2.0) - 2025-08-21 - -### Merged - -- Generated SDK #3302 [`#107`](https://github.com/fireblocks/java-sdk/pull/107) - -## [v11.1.0](https://github.com/fireblocks/java-sdk/compare/v11.0.0...v11.1.0) - 2025-08-11 - -### Merged - -- Generated SDK #1782 [`#105`](https://github.com/fireblocks/java-sdk/pull/105) - -## [v11.0.0](https://github.com/fireblocks/java-sdk/compare/v10.4.0...v11.0.0) - 2025-07-15 - -### Merged - -- Generated SDK #5610 [`#103`](https://github.com/fireblocks/java-sdk/pull/103) - -## [v10.4.0](https://github.com/fireblocks/java-sdk/compare/v10.3.0...v10.4.0) - 2025-06-29 - -### Merged - -- Generated SDK #1492 [`#101`](https://github.com/fireblocks/java-sdk/pull/101) - -## [v10.3.0](https://github.com/fireblocks/java-sdk/compare/v10.2.0...v10.3.0) - 2025-06-18 - -### Merged - -- Generated SDK #4009 [`#99`](https://github.com/fireblocks/java-sdk/pull/99) - -## [v10.2.0](https://github.com/fireblocks/java-sdk/compare/v10.1.1...v10.2.0) - 2025-06-04 - -### Merged - -- Generated SDK #8912 [`#98`](https://github.com/fireblocks/java-sdk/pull/98) - -## [v10.1.1](https://github.com/fireblocks/java-sdk/compare/v10.1.0...v10.1.1) - 2025-05-18 - -### Merged - -- Generated SDK #5019 [`#97`](https://github.com/fireblocks/java-sdk/pull/97) - -## [v10.1.0](https://github.com/fireblocks/java-sdk/compare/v10.0.2...v10.1.0) - 2025-05-07 - -### Merged - -- Generated SDK #7076 [`#95`](https://github.com/fireblocks/java-sdk/pull/95) - -## [v10.0.2](https://github.com/fireblocks/java-sdk/compare/v10.0.1...v10.0.2) - 2025-04-20 - -### Merged - -- Generated SDK #4794 [`#94`](https://github.com/fireblocks/java-sdk/pull/94) - -## [v10.0.1](https://github.com/fireblocks/java-sdk/compare/v10.0.0...v10.0.1) - 2025-04-07 - -### Merged - -- Generated SDK #3065 [`#93`](https://github.com/fireblocks/java-sdk/pull/93) - -## [v10.0.0](https://github.com/fireblocks/java-sdk/compare/v9.0.0...v10.0.0) - 2025-03-30 - -### Merged - -- Generated SDK #619 [`#90`](https://github.com/fireblocks/java-sdk/pull/90) - -## [v9.0.0](https://github.com/fireblocks/java-sdk/compare/v8.1.0...v9.0.0) - 2025-03-17 - -### Merged - -- Generated SDK #645 [`#89`](https://github.com/fireblocks/java-sdk/pull/89) - -## [v8.1.0](https://github.com/fireblocks/java-sdk/compare/v8.0.1...v8.1.0) - 2025-02-24 - -### Merged - -- Generated SDK #9833 [`#84`](https://github.com/fireblocks/java-sdk/pull/84) - -## [v8.0.1](https://github.com/fireblocks/java-sdk/compare/v8.0.0...v8.0.1) - 2025-02-12 - -### Merged - -- Generated SDK #4262 [`#82`](https://github.com/fireblocks/java-sdk/pull/82) - -## [v8.0.0](https://github.com/fireblocks/java-sdk/compare/v7.0.0...v8.0.0) - 2025-02-02 - -### Merged - -- Generated SDK #538 [`#80`](https://github.com/fireblocks/java-sdk/pull/80) - -## [v7.0.0](https://github.com/fireblocks/java-sdk/compare/v6.0.0...v7.0.0) - 2025-01-08 - -### Merged - -- Generated SDK #8699 [`#77`](https://github.com/fireblocks/java-sdk/pull/77) - -## [v6.0.0](https://github.com/fireblocks/java-sdk/compare/v5.0.0...v6.0.0) - 2024-12-05 - -### Merged - -- Generated SDK #1430 [`#73`](https://github.com/fireblocks/java-sdk/pull/73) - -## [v5.0.0](https://github.com/fireblocks/java-sdk/compare/v4.0.0...v5.0.0) - 2024-10-31 - -### Merged - -- Generated SDK #5184 [`#71`](https://github.com/fireblocks/java-sdk/pull/71) - -## [v4.0.0](https://github.com/fireblocks/java-sdk/compare/v3.1.0...v4.0.0) - 2024-09-17 - -### Merged - -- Generated SDK #237 [`#70`](https://github.com/fireblocks/java-sdk/pull/70) - -## [v3.1.0](https://github.com/fireblocks/java-sdk/compare/v3.0.0...v3.1.0) - 2024-07-25 - -### Merged - -- Generated SDK #6749 [`#67`](https://github.com/fireblocks/java-sdk/pull/67) - -## [v3.0.0](https://github.com/fireblocks/java-sdk/compare/v2.1.0...v3.0.0) - 2024-07-17 - -### Merged - -- Generated SDK #6152 [`#65`](https://github.com/fireblocks/java-sdk/pull/65) -- Generated SDK #7984 [`#62`](https://github.com/fireblocks/java-sdk/pull/62) -- Generated SDK #2873 [`#61`](https://github.com/fireblocks/java-sdk/pull/61) - -## [v2.1.0](https://github.com/fireblocks/java-sdk/compare/v2.0.1...v2.1.0) - 2024-06-04 - -### Merged - -- Generated SDK for version COR-46191/fix_pipelines [`#24`](https://github.com/fireblocks/java-sdk/pull/24) -- Generated SDK for version COR-46191/fix_pipelines [`#23`](https://github.com/fireblocks/java-sdk/pull/23) -- Generated SDK for version COR-46191/fix_pipelines [`#22`](https://github.com/fireblocks/java-sdk/pull/22) -- Generated SDK for version COR-46191/fix_pipelines [`#21`](https://github.com/fireblocks/java-sdk/pull/21) - -## [v2.0.1](https://github.com/fireblocks/java-sdk/compare/v2.0.0...v2.0.1) - 2024-06-04 - -### Merged - -- Generated SDK for version COR-46191/fix_pipelines [`#20`](https://github.com/fireblocks/java-sdk/pull/20) - -## [v2.0.0](https://github.com/fireblocks/java-sdk/compare/v1.1.0...v2.0.0) - 2024-05-08 - -### Merged - -- feat: add tokenization api [`#12`](https://github.com/fireblocks/java-sdk/pull/12) - -## [v1.1.0](https://github.com/fireblocks/java-sdk/compare/v1.0.1...v1.1.0) - 2024-04-17 - -### Merged - -- feat: add cosigners beta api [`#11`](https://github.com/fireblocks/java-sdk/pull/11) -- fix: fix readme doc headline [`#10`](https://github.com/fireblocks/java-sdk/pull/10) - -## [v1.0.1](https://github.com/fireblocks/java-sdk/compare/v1.0.0...v1.0.1) - 2024-04-07 - -### Merged - -- Generated SDK for version v1.0.1 [`#9`](https://github.com/fireblocks/java-sdk/pull/9) - -## v1.0.0 - 2024-04-07 - -### Merged - -- Generated SDK for version v1.0.0 GA [`#8`](https://github.com/fireblocks/java-sdk/pull/8) -- v0.0.1-beta [`#6`](https://github.com/fireblocks/java-sdk/pull/6) -- Update GitHub Actions workflows [`#5`](https://github.com/fireblocks/java-sdk/pull/5) -- Generated #1189972817 [`#3`](https://github.com/fireblocks/java-sdk/pull/3) -- Add installation instructions [`#2`](https://github.com/fireblocks/java-sdk/pull/2) -- Added Idempotency & NCW headers support #6 [`#1`](https://github.com/fireblocks/java-sdk/pull/1) diff --git a/README.md b/README.md index 1b19d28c..373fde4d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Add this dependency to your project's POM: com.fireblocks.sdk fireblocks-sdk - 17.0.0 + 0.0.0 compile ``` @@ -42,7 +42,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "com.fireblocks.sdk:fireblocks-sdk:17.0.0" +compile "com.fireblocks.sdk:fireblocks-sdk:0.0.0" ``` ### Others @@ -55,7 +55,7 @@ mvn clean package Then manually install the following JARs: -- `target/fireblocks-sdk-17.0.0.jar` +- `target/fireblocks-sdk-0.0.0.jar` - `target/lib/*.jar` @@ -155,19 +155,23 @@ Class | Method | HTTP request | Description *ComplianceApi* | [**activateByorkConfig**](docs/ComplianceApi.md#activateByorkConfig) | **POST** /screening/byork/config/activate | Activate BYORK Light *ComplianceApi* | [**addAddressRegistryVaultOptOuts**](docs/ComplianceApi.md#addAddressRegistryVaultOptOuts) | **POST** /address_registry/vaults | Add vault accounts to the address registry opt-out list *ComplianceApi* | [**assignVaultsToLegalEntity**](docs/ComplianceApi.md#assignVaultsToLegalEntity) | **POST** /legal_entities/{legalEntityId}/vaults | Assign vault accounts to a legal entity +*ComplianceApi* | [**createCounterpartyGroup**](docs/ComplianceApi.md#createCounterpartyGroup) | **POST** /counterparty_groups | Create a counterparty group *ComplianceApi* | [**deactivateByorkConfig**](docs/ComplianceApi.md#deactivateByorkConfig) | **POST** /screening/byork/config/deactivate | Deactivate BYORK Light +*ComplianceApi* | [**deleteCounterpartyGroup**](docs/ComplianceApi.md#deleteCounterpartyGroup) | **DELETE** /counterparty_groups/{groupId} | Delete a counterparty group *ComplianceApi* | [**getAddressRegistryTenantParticipationStatus**](docs/ComplianceApi.md#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry participation status for the authenticated workspace *ComplianceApi* | [**getAddressRegistryVaultOptOut**](docs/ComplianceApi.md#getAddressRegistryVaultOptOut) | **GET** /address_registry/vaults/{vaultAccountId} | Get whether a vault account is opted out of the address registry *ComplianceApi* | [**getAmlPostScreeningPolicy**](docs/ComplianceApi.md#getAmlPostScreeningPolicy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy *ComplianceApi* | [**getAmlScreeningPolicy**](docs/ComplianceApi.md#getAmlScreeningPolicy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy *ComplianceApi* | [**getByorkConfig**](docs/ComplianceApi.md#getByorkConfig) | **GET** /screening/byork/config | Get BYORK Light configuration *ComplianceApi* | [**getByorkVerdict**](docs/ComplianceApi.md#getByorkVerdict) | **GET** /screening/byork/verdict | Get BYORK Light verdict +*ComplianceApi* | [**getCounterpartyGroup**](docs/ComplianceApi.md#getCounterpartyGroup) | **GET** /counterparty_groups/{groupId} | Get a counterparty group *ComplianceApi* | [**getLegalEntity**](docs/ComplianceApi.md#getLegalEntity) | **GET** /legal_entities/{legalEntityId} | Get a legal entity *ComplianceApi* | [**getLegalEntityForAddress**](docs/ComplianceApi.md#getLegalEntityForAddress) | **GET** /address_registry/legal_entities/{address} | Look up legal entity by blockchain address *ComplianceApi* | [**getPostScreeningPolicy**](docs/ComplianceApi.md#getPostScreeningPolicy) | **GET** /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy *ComplianceApi* | [**getScreeningFullDetails**](docs/ComplianceApi.md#getScreeningFullDetails) | **GET** /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction. *ComplianceApi* | [**getScreeningPolicy**](docs/ComplianceApi.md#getScreeningPolicy) | **GET** /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy *ComplianceApi* | [**listAddressRegistryVaultOptOuts**](docs/ComplianceApi.md#listAddressRegistryVaultOptOuts) | **GET** /address_registry/vaults | List vault-level address registry opt-outs (paginated) +*ComplianceApi* | [**listCounterpartyGroups**](docs/ComplianceApi.md#listCounterpartyGroups) | **GET** /counterparty_groups | List counterparty groups *ComplianceApi* | [**listLegalEntities**](docs/ComplianceApi.md#listLegalEntities) | **GET** /legal_entities | List legal entities (Paginated) *ComplianceApi* | [**listVaultsForLegalEntity**](docs/ComplianceApi.md#listVaultsForLegalEntity) | **GET** /legal_entities/{legalEntityId}/vaults | List vault accounts for a legal entity (Paginated) *ComplianceApi* | [**optInAddressRegistryTenant**](docs/ComplianceApi.md#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt the workspace in to the address registry @@ -180,6 +184,7 @@ Class | Method | HTTP request | Description *ComplianceApi* | [**setByorkTimeouts**](docs/ComplianceApi.md#setByorkTimeouts) | **PUT** /screening/byork/config/timeouts | Set BYORK Light timeouts *ComplianceApi* | [**setByorkVerdict**](docs/ComplianceApi.md#setByorkVerdict) | **POST** /screening/byork/verdict | Set BYORK Light verdict *ComplianceApi* | [**updateAmlScreeningConfiguration**](docs/ComplianceApi.md#updateAmlScreeningConfiguration) | **PUT** /screening/aml/policy_configuration | Update AML Configuration +*ComplianceApi* | [**updateCounterpartyGroup**](docs/ComplianceApi.md#updateCounterpartyGroup) | **PATCH** /counterparty_groups/{groupId} | Update a counterparty group *ComplianceApi* | [**updateLegalEntity**](docs/ComplianceApi.md#updateLegalEntity) | **PUT** /legal_entities/{legalEntityId} | Update legal entity *ComplianceApi* | [**updateScreeningConfiguration**](docs/ComplianceApi.md#updateScreeningConfiguration) | **PUT** /screening/configurations | Tenant - Screening Configuration *ComplianceApi* | [**updateTravelRuleConfig**](docs/ComplianceApi.md#updateTravelRuleConfig) | **PUT** /screening/travel_rule/policy_configuration | Update Travel Rule Configuration @@ -426,6 +431,7 @@ Class | Method | HTTP request | Description *TrLinkApi* | [**connectTRLinkIntegration**](docs/TrLinkApi.md#connectTRLinkIntegration) | **PUT** /screening/trlink/customers/integration/{customerIntegrationId} | Connect customer integration *TrLinkApi* | [**createTRLinkCustomer**](docs/TrLinkApi.md#createTRLinkCustomer) | **POST** /screening/trlink/customers | Create customer *TrLinkApi* | [**createTRLinkIntegration**](docs/TrLinkApi.md#createTRLinkIntegration) | **POST** /screening/trlink/customers/integration | Create customer integration +*TrLinkApi* | [**createTRLinkManualDecision**](docs/TrLinkApi.md#createTRLinkManualDecision) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision | Manual decision for missing TRM *TrLinkApi* | [**createTRLinkTrm**](docs/TrLinkApi.md#createTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm | Create Travel Rule Message *TrLinkApi* | [**deleteTRLinkCustomer**](docs/TrLinkApi.md#deleteTRLinkCustomer) | **DELETE** /screening/trlink/customers/{customerId} | Delete customer *TrLinkApi* | [**disconnectTRLinkIntegration**](docs/TrLinkApi.md#disconnectTRLinkIntegration) | **DELETE** /screening/trlink/customers/integration/{customerIntegrationId} | Disconnect customer integration @@ -438,10 +444,12 @@ Class | Method | HTTP request | Description *TrLinkApi* | [**getTRLinkPolicy**](docs/TrLinkApi.md#getTRLinkPolicy) | **GET** /screening/trlink/policy | Get TRLink policy *TrLinkApi* | [**getTRLinkSupportedAsset**](docs/TrLinkApi.md#getTRLinkSupportedAsset) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID *TrLinkApi* | [**getTRLinkTrmById**](docs/TrLinkApi.md#getTRLinkTrmById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId} | Get TRM by ID +*TrLinkApi* | [**getTRLinkTrmRequiredActions**](docs/TrLinkApi.md#getTRLinkTrmRequiredActions) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions | Get required actions for a TRM *TrLinkApi* | [**getTRLinkVaspById**](docs/TrLinkApi.md#getTRLinkVaspById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId} | Get VASP by ID *TrLinkApi* | [**listTRLinkSupportedAssets**](docs/TrLinkApi.md#listTRLinkSupportedAssets) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets | List supported assets *TrLinkApi* | [**listTRLinkVasps**](docs/TrLinkApi.md#listTRLinkVasps) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps | List VASPs *TrLinkApi* | [**redirectTRLinkTrm**](docs/TrLinkApi.md#redirectTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect | Redirect Travel Rule Message +*TrLinkApi* | [**resolveActionTRLinkTrm**](docs/TrLinkApi.md#resolveActionTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_action | Resolve action for a TRM *TrLinkApi* | [**setTRLinkDestinationTravelRuleMessageId**](docs/TrLinkApi.md#setTRLinkDestinationTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/destination/travel_rule_message_id | Set destination travel rule message ID *TrLinkApi* | [**setTRLinkTransactionTravelRuleMessageId**](docs/TrLinkApi.md#setTRLinkTransactionTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/travel_rule_message_id | Set transaction travel rule message ID *TrLinkApi* | [**testTRLinkIntegrationConnection**](docs/TrLinkApi.md#testTRLinkIntegrationConnection) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/test_connection | Test connection @@ -482,6 +490,7 @@ Class | Method | HTTP request | Description *UtxoManagementBetaApi* | [**getUtxos**](docs/UtxoManagementBetaApi.md#getUtxos) | **GET** /utxo_management/{vaultAccountId}/{assetId}/unspent_outputs | List unspent outputs (UTXOs) *UtxoManagementBetaApi* | [**updateUtxoLabels**](docs/UtxoManagementBetaApi.md#updateUtxoLabels) | **PATCH** /utxo_management/{vaultAccountId}/{assetId}/labels | Attach or detach labels to/from UTXOs *VaultsApi* | [**activateAssetForVaultAccount**](docs/VaultsApi.md#activateAssetForVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/activate | Activate a wallet in a vault account +*VaultsApi* | [**activateCircleGatewayWalletBeta**](docs/VaultsApi.md#activateCircleGatewayWalletBeta) | **POST** /vault/accounts/{vaultAccountId}/circle_gateway/activate | Activate a Circle Gateway wallet *VaultsApi* | [**attachOrDetachTagsFromVaultAccounts**](docs/VaultsApi.md#attachOrDetachTagsFromVaultAccounts) | **POST** /vault/accounts/attached_tags | Attach or detach tags from vault accounts *VaultsApi* | [**createLegacyAddress**](docs/VaultsApi.md#createLegacyAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy | Convert a segwit address to legacy format *VaultsApi* | [**createMultipleAccounts**](docs/VaultsApi.md#createMultipleAccounts) | **POST** /vault/accounts/bulk | Bulk creation of new vault accounts @@ -489,7 +498,9 @@ Class | Method | HTTP request | Description *VaultsApi* | [**createVaultAccount**](docs/VaultsApi.md#createVaultAccount) | **POST** /vault/accounts | Create a new vault account *VaultsApi* | [**createVaultAccountAsset**](docs/VaultsApi.md#createVaultAccountAsset) | **POST** /vault/accounts/{vaultAccountId}/{assetId} | Create a new vault wallet *VaultsApi* | [**createVaultAccountAssetAddress**](docs/VaultsApi.md#createVaultAccountAssetAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses | Create new asset deposit address +*VaultsApi* | [**deactivateCircleGatewayWalletBeta**](docs/VaultsApi.md#deactivateCircleGatewayWalletBeta) | **POST** /vault/accounts/{vaultAccountId}/circle_gateway/deactivate | Deactivate a Circle Gateway wallet *VaultsApi* | [**getAssetWallets**](docs/VaultsApi.md#getAssetWallets) | **GET** /vault/asset_wallets | Get vault wallets (Paginated) +*VaultsApi* | [**getCircleGatewayWalletInfoBeta**](docs/VaultsApi.md#getCircleGatewayWalletInfoBeta) | **GET** /vault/accounts/{vaultAccountId}/circle_gateway | Get Circle Gateway wallet info *VaultsApi* | [**getCreateMultipleDepositAddressesJobStatus**](docs/VaultsApi.md#getCreateMultipleDepositAddressesJobStatus) | **GET** /vault/accounts/addresses/bulk/{jobId} | Get the job status of the bulk deposit address creation *VaultsApi* | [**getCreateMultipleVaultAccountsJobStatus**](docs/VaultsApi.md#getCreateMultipleVaultAccountsJobStatus) | **GET** /vault/accounts/bulk/{jobId} | Get job status of bulk creation of new vault accounts *VaultsApi* | [**getMaxBipIndexUsed**](docs/VaultsApi.md#getMaxBipIndexUsed) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used | Get maximum BIP44 index used @@ -687,6 +698,8 @@ Class | Method | HTTP request | Description - [ChapsAddress](docs/ChapsAddress.md) - [ChapsDestination](docs/ChapsDestination.md) - [ChapsPaymentInfo](docs/ChapsPaymentInfo.md) + - [CircleGatewayWalletInfoResponse](docs/CircleGatewayWalletInfoResponse.md) + - [CircleGatewayWalletStatusResponse](docs/CircleGatewayWalletStatusResponse.md) - [ClaimRewardsRequest](docs/ClaimRewardsRequest.md) - [CollectionBurnRequestDto](docs/CollectionBurnRequestDto.md) - [CollectionBurnResponseDto](docs/CollectionBurnResponseDto.md) @@ -765,6 +778,8 @@ Class | Method | HTTP request | Description - [ConvertAssetsResponse](docs/ConvertAssetsResponse.md) - [Cosigner](docs/Cosigner.md) - [CosignersPaginatedResponse](docs/CosignersPaginatedResponse.md) + - [CounterpartyGroup](docs/CounterpartyGroup.md) + - [CounterpartyGroupsPaginatedResponse](docs/CounterpartyGroupsPaginatedResponse.md) - [CreateAPIUser](docs/CreateAPIUser.md) - [CreateAddressRequest](docs/CreateAddressRequest.md) - [CreateAddressResponse](docs/CreateAddressResponse.md) @@ -775,6 +790,7 @@ Class | Method | HTTP request | Description - [CreateConsoleUser](docs/CreateConsoleUser.md) - [CreateContractRequest](docs/CreateContractRequest.md) - [CreateConversionConfigOperationRequest](docs/CreateConversionConfigOperationRequest.md) + - [CreateCounterpartyGroupRequest](docs/CreateCounterpartyGroupRequest.md) - [CreateDisbursementConfigOperationRequest](docs/CreateDisbursementConfigOperationRequest.md) - [CreateEarnActionRequest](docs/CreateEarnActionRequest.md) - [CreateEarnActionResponse](docs/CreateEarnActionResponse.md) @@ -1350,6 +1366,7 @@ Class | Method | HTTP request | Description - [TRLinkAssetData](docs/TRLinkAssetData.md) - [TRLinkAssetFormat](docs/TRLinkAssetFormat.md) - [TRLinkAssetsListPagedResponse](docs/TRLinkAssetsListPagedResponse.md) + - [TRLinkBeneficiaryPii](docs/TRLinkBeneficiaryPii.md) - [TRLinkCancelTrmRequest](docs/TRLinkCancelTrmRequest.md) - [TRLinkConnectIntegrationRequest](docs/TRLinkConnectIntegrationRequest.md) - [TRLinkCreateCustomerRequest](docs/TRLinkCreateCustomerRequest.md) @@ -1361,10 +1378,16 @@ Class | Method | HTTP request | Description - [TRLinkDiscoverableStatus](docs/TRLinkDiscoverableStatus.md) - [TRLinkFiatValue](docs/TRLinkFiatValue.md) - [TRLinkGeographicAddressRequest](docs/TRLinkGeographicAddressRequest.md) + - [TRLinkGetRequiredActionsResponse](docs/TRLinkGetRequiredActionsResponse.md) - [TRLinkGetSupportedAssetResponse](docs/TRLinkGetSupportedAssetResponse.md) - [TRLinkIvms](docs/TRLinkIvms.md) - [TRLinkIvmsResponse](docs/TRLinkIvmsResponse.md) - [TRLinkJwkPublicKey](docs/TRLinkJwkPublicKey.md) + - [TRLinkManualDecisionAction](docs/TRLinkManualDecisionAction.md) + - [TRLinkManualDecisionDestinationDetail](docs/TRLinkManualDecisionDestinationDetail.md) + - [TRLinkManualDecisionRequest](docs/TRLinkManualDecisionRequest.md) + - [TRLinkManualDecisionResponse](docs/TRLinkManualDecisionResponse.md) + - [TRLinkManualDecisionSource](docs/TRLinkManualDecisionSource.md) - [TRLinkMissingTrmAction](docs/TRLinkMissingTrmAction.md) - [TRLinkMissingTrmAction2](docs/TRLinkMissingTrmAction2.md) - [TRLinkMissingTrmActionEnum](docs/TRLinkMissingTrmActionEnum.md) @@ -1394,6 +1417,11 @@ Class | Method | HTTP request | Description - [TRLinkRegistrationResultFullPayload](docs/TRLinkRegistrationResultFullPayload.md) - [TRLinkRegistrationStatus](docs/TRLinkRegistrationStatus.md) - [TRLinkRegistrationStatusEnum](docs/TRLinkRegistrationStatusEnum.md) + - [TRLinkRequiredAction](docs/TRLinkRequiredAction.md) + - [TRLinkRequiredActionData](docs/TRLinkRequiredActionData.md) + - [TRLinkRequiredField](docs/TRLinkRequiredField.md) + - [TRLinkResolveActionData](docs/TRLinkResolveActionData.md) + - [TRLinkResolveActionRequest](docs/TRLinkResolveActionRequest.md) - [TRLinkResult](docs/TRLinkResult.md) - [TRLinkResultFullPayload](docs/TRLinkResultFullPayload.md) - [TRLinkRuleBase](docs/TRLinkRuleBase.md) @@ -1539,6 +1567,7 @@ Class | Method | HTTP request | Description - [UpdateAssetUserMetadataRequest](docs/UpdateAssetUserMetadataRequest.md) - [UpdateCallbackHandlerRequest](docs/UpdateCallbackHandlerRequest.md) - [UpdateCallbackHandlerResponse](docs/UpdateCallbackHandlerResponse.md) + - [UpdateCounterpartyGroupRequest](docs/UpdateCounterpartyGroupRequest.md) - [UpdateDraftRequest](docs/UpdateDraftRequest.md) - [UpdateLegalEntityRequest](docs/UpdateLegalEntityRequest.md) - [UpdateTagRequest](docs/UpdateTagRequest.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index eaea9bb5..153eb85d 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -20,7 +20,7 @@ paths: deprecated: true description: |- DEPRECATED - Please use `/vault/accounts_paged` endpoint instead. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getVaultAccounts parameters: - explode: true @@ -84,7 +84,7 @@ paths: Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: createVaultAccount parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -157,7 +157,7 @@ paths: get: description: |- Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getPagedVaultAccounts parameters: - explode: true @@ -323,7 +323,7 @@ paths: get: description: |- Get a vault account by its unique ID. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getVaultAccount parameters: - description: The ID of the vault account @@ -381,7 +381,7 @@ paths: put: description: |- Renames the requested vault account. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. operationId: updateVaultAccount parameters: - description: The ID of the vault account to edit @@ -468,8 +468,8 @@ paths: get: description: "Get all vault wallets of the vault accounts in your workspace.\ \ \nA vault wallet is an asset in a vault account. \n\nThis method allows\ - \ fast traversal of all account balances.\n
Endpoint Permission: Admin,\ - \ Non-Signing Admin, Signer, Approver, Editor, Viewer." + \ fast traversal of all account balances.\nEndpoint Permission: Admin, Non-Signing\ + \ Admin, Signer, Approver, Editor, Viewer." operationId: getAssetWallets parameters: - description: "When specified, only vault wallets with total balance greater\ @@ -589,7 +589,7 @@ paths: Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: hideVaultAccount parameters: - description: The vault account to hide @@ -665,7 +665,7 @@ paths: post: description: |- Makes a hidden vault account visible in web console view. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: unhideVaultAccount parameters: - description: The vault account to unhide @@ -741,7 +741,7 @@ paths: post: description: "Initiates activation for a wallet in a vault account. \nActivation\ \ is required for tokens that need an on-chain transaction for creation (XLM\ - \ tokens, SOL tokens etc).\n
Endpoint Permission: Admin, Non-Signing Admin,\ + \ tokens, SOL tokens etc).\nEndpoint Permission: Admin, Non-Signing Admin,\ \ Signer, Approver, Editor." operationId: activateAssetForVaultAccount parameters: @@ -832,7 +832,7 @@ paths: post: description: "Assigns an AML/KYT customer reference ID for the vault account.\ \ Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies).\ - \
Endpoint Permission: Admin, Non-Signing Admin." + \ Endpoint Permission: Admin, Non-Signing Admin." operationId: setVaultAccountCustomerRefId parameters: - description: The vault account ID @@ -919,7 +919,7 @@ paths: Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: setVaultAccountAutoFuel parameters: - description: The vault account ID @@ -992,16 +992,15 @@ paths: x-content-type: application/json x-accepts: - application/json - /vault/accounts/{vaultAccountId}/{assetId}: + /vault/accounts/{vaultAccountId}/circle_gateway: get: description: |- - Returns a specific vault wallet balance information for a specific asset. - -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, - Viewer. - operationId: getVaultAccountAsset + Returns the Circle Gateway wallet information associated with the given vault account. + **Note:** This endpoint is currently in beta and might be subject to changes. +
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + operationId: getCircleGatewayWalletInfoBeta parameters: - - description: The ID of the vault account to return + - description: The ID of the vault account explode: false in: path name: vaultAccountId @@ -1011,69 +1010,57 @@ paths: type: string x-fb-entity: vault_account style: simple - - description: The ID of the asset - explode: false - in: path - name: assetId - required: true - schema: - type: string - x-fb-entity: asset - style: simple responses: "200": content: application/json: schema: - $ref: "#/components/schemas/VaultAsset" - description: A VaultAsset object + $ref: "#/components/schemas/CircleGatewayWalletInfoResponse" + description: Circle Gateway wallet information + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" default: $ref: "#/components/responses/Error" - summary: Get the asset balance for a vault account + summary: Get Circle Gateway wallet info tags: - Vaults x-rate-limit-category: read x-readme: code-samples: - - language: python - code: "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id,\ - \ asset_id)" - name: Fireblocks SDK Python example (Legacy) - - language: javascript - code: "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId,\ - \ assetId);" - name: Fireblocks SDK Javascript example - language: typescript - code: "const response: Promise> = fireblocks.vaults.getVaultAccountAsset(vaultsApiGetVaultAccountAssetRequest);" + code: "const response: Promise>\ + \ = fireblocks.vaults.getCircleGatewayWalletInfoBeta(vaultsApiGetCircleGatewayWalletInfoBetaRequest);" name: Fireblocks SDK TypeScript example - language: java - code: "CompletableFuture> response = fireblocks.vaults().getVaultAccountAsset(vaultAccountId,\ - \ assetId);" + code: CompletableFuture> response + = fireblocks.vaults().getCircleGatewayWalletInfoBeta(vaultAccountId); name: Fireblocks SDK Java example - language: python - code: "response = fireblocks.vaults.get_vault_account_asset(vault_account_id,\ - \ asset_id);" + code: response = fireblocks.vaults.get_circle_gateway_wallet_info_beta(vault_account_id); name: Fireblocks SDK Python example x-codeSamples: - lang: TypeScript - source: "const response: Promise> = fireblocks.vaults.getVaultAccountAsset(vaultsApiGetVaultAccountAssetRequest);" + source: "const response: Promise>\ + \ = fireblocks.vaults.getCircleGatewayWalletInfoBeta(vaultsApiGetCircleGatewayWalletInfoBetaRequest);" - lang: Java - source: "CompletableFuture> response = fireblocks.vaults().getVaultAccountAsset(vaultAccountId,\ - \ assetId);" + source: CompletableFuture> response + = fireblocks.vaults().getCircleGatewayWalletInfoBeta(vaultAccountId); - lang: Python - source: "response = fireblocks.vaults.get_vault_account_asset(vault_account_id,\ - \ asset_id);" + source: response = fireblocks.vaults.get_circle_gateway_wallet_info_beta(vault_account_id); x-accepts: - application/json + /vault/accounts/{vaultAccountId}/circle_gateway/activate: post: description: |- - Creates a wallet for a specific asset in a vault account. - Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - operationId: createVaultAccountAsset + Activates the Circle Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. + + **Note:** This endpoint is currently in beta and might be subject to changes. + +
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + operationId: activateCircleGatewayWalletBeta parameters: - - description: "The ID of the vault account to return, or 'default' for the\ - \ default vault account" + - description: The ID of the vault account explode: false in: path name: vaultAccountId @@ -1083,14 +1070,80 @@ paths: type: string x-fb-entity: vault_account style: simple - - description: The ID of the asset + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/CircleGatewayWalletStatusResponse" + description: Circle Gateway wallet activated successfully + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Activate a Circle Gateway wallet + tags: + - Vaults + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.vaults.activateCircleGatewayWalletBeta(vaultsApiActivateCircleGatewayWalletBetaRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture>\ + \ response = fireblocks.vaults().activateCircleGatewayWalletBeta(vaultAccountId,\ + \ idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.vaults.activate_circle_gateway_wallet_beta(vault_account_id,\ + \ idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.vaults.activateCircleGatewayWalletBeta(vaultsApiActivateCircleGatewayWalletBetaRequest);" + - lang: Java + source: "CompletableFuture>\ + \ response = fireblocks.vaults().activateCircleGatewayWalletBeta(vaultAccountId,\ + \ idempotencyKey);" + - lang: Python + source: "response = fireblocks.vaults.activate_circle_gateway_wallet_beta(vault_account_id,\ + \ idempotency_key);" + x-accepts: + - application/json + /vault/accounts/{vaultAccountId}/circle_gateway/deactivate: + post: + description: |- + Deactivates the Circle Gateway wallet associated with the given vault account. + + **Note:** This endpoint is currently in beta and might be subject to changes. + +
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + operationId: deactivateCircleGatewayWalletBeta + parameters: + - description: The ID of the vault account explode: false in: path - name: assetId + name: vaultAccountId required: true schema: + format: numeric type: string - x-fb-entity: asset + x-fb-entity: vault_account style: simple - description: "A unique identifier for the request. If the request is sent\ \ multiple times with the same idempotency key, the server will return the\ @@ -1103,82 +1156,58 @@ paths: schema: type: string style: simple - - description: Optional immutable blockchain wallet type to store per tenant+vault - explode: true - in: query - name: blockchainWalletType - required: false - schema: - type: string - style: form - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAssetsRequest" - required: false responses: "200": content: application/json: schema: - $ref: "#/components/schemas/CreateVaultAssetResponse" - description: OK + $ref: "#/components/schemas/CircleGatewayWalletStatusResponse" + description: Circle Gateway wallet deactivated successfully headers: X-Request-ID: $ref: "#/components/headers/X-Request-ID" default: $ref: "#/components/responses/Error" - summary: Create a new vault wallet + summary: Deactivate a Circle Gateway wallet tags: - Vaults x-rate-limit-category: write x-readme: code-samples: - - language: python - code: "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)" - name: Fireblocks SDK Python example (Legacy) - - language: javascript - code: "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId,\ - \ assetId);" - name: Fireblocks SDK Javascript example - language: typescript - code: "const response: Promise>\ - \ = fireblocks.vaults.createVaultAccountAsset(vaultsApiCreateVaultAccountAssetRequest);" + code: "const response: Promise>\ + \ = fireblocks.vaults.deactivateCircleGatewayWalletBeta(vaultsApiDeactivateCircleGatewayWalletBetaRequest);" name: Fireblocks SDK TypeScript example - language: java - code: "CompletableFuture> response\ - \ = fireblocks.vaults().createVaultAccountAsset(vaultAccountId, assetId,\ - \ createAssetsRequest, blockchainWalletType, idempotencyKey);" + code: "CompletableFuture>\ + \ response = fireblocks.vaults().deactivateCircleGatewayWalletBeta(vaultAccountId,\ + \ idempotencyKey);" name: Fireblocks SDK Java example - language: python - code: "response = fireblocks.vaults.create_vault_account_asset(vault_account_id,\ - \ asset_id, create_assets_request, blockchain_wallet_type, idempotency_key);" + code: "response = fireblocks.vaults.deactivate_circle_gateway_wallet_beta(vault_account_id,\ + \ idempotency_key);" name: Fireblocks SDK Python example x-codeSamples: - lang: TypeScript - source: "const response: Promise>\ - \ = fireblocks.vaults.createVaultAccountAsset(vaultsApiCreateVaultAccountAssetRequest);" + source: "const response: Promise>\ + \ = fireblocks.vaults.deactivateCircleGatewayWalletBeta(vaultsApiDeactivateCircleGatewayWalletBetaRequest);" - lang: Java - source: "CompletableFuture> response\ - \ = fireblocks.vaults().createVaultAccountAsset(vaultAccountId, assetId,\ - \ createAssetsRequest, blockchainWalletType, idempotencyKey);" + source: "CompletableFuture>\ + \ response = fireblocks.vaults().deactivateCircleGatewayWalletBeta(vaultAccountId,\ + \ idempotencyKey);" - lang: Python - source: "response = fireblocks.vaults.create_vault_account_asset(vault_account_id,\ - \ asset_id, create_assets_request, blockchain_wallet_type, idempotency_key);" - x-content-type: application/json + source: "response = fireblocks.vaults.deactivate_circle_gateway_wallet_beta(vault_account_id,\ + \ idempotency_key);" x-accepts: - application/json - /vault/accounts/{vaultAccountId}/{assetId}/balance: - post: + /vault/accounts/{vaultAccountId}/{assetId}: + get: description: |- - Updates the balance of a specific asset in a vault account. - - This API endpoint is subject to a strict rate limit. - Should be used by clients in very specific scenarios. + Returns a specific vault wallet balance information for a specific asset. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - operationId: updateVaultAccountAssetBalance + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + Viewer. + operationId: getVaultAccountAsset parameters: - description: The ID of the vault account to return explode: false @@ -1199,17 +1228,6 @@ paths: type: string x-fb-entity: asset style: simple - - description: "A unique identifier for the request. If the request is sent\ - \ multiple times with the same idempotency key, the server will return the\ - \ same response as the first request. The idempotency key is valid for 24\ - \ hours." - explode: false - in: header - name: Idempotency-Key - required: false - schema: - type: string - style: simple responses: "200": content: @@ -1217,61 +1235,53 @@ paths: schema: $ref: "#/components/schemas/VaultAsset" description: A VaultAsset object - headers: - X-Request-ID: - $ref: "#/components/headers/X-Request-ID" default: $ref: "#/components/responses/Error" - summary: Refresh asset balance data + summary: Get the asset balance for a vault account tags: - Vaults - x-rate-limit-category: high_compute + x-rate-limit-category: read x-readme: code-samples: - language: python - code: "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id,\ + code: "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id,\ \ asset_id)" name: Fireblocks SDK Python example (Legacy) - language: javascript - code: "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId,\ + code: "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId,\ \ assetId);" name: Fireblocks SDK Javascript example - language: typescript - code: "const response: Promise> = fireblocks.vaults.updateVaultAccountAssetBalance(vaultsApiUpdateVaultAccountAssetBalanceRequest);" + code: "const response: Promise> = fireblocks.vaults.getVaultAccountAsset(vaultsApiGetVaultAccountAssetRequest);" name: Fireblocks SDK TypeScript example - language: java - code: "CompletableFuture> response = fireblocks.vaults().updateVaultAccountAssetBalance(vaultAccountId,\ - \ assetId, idempotencyKey);" + code: "CompletableFuture> response = fireblocks.vaults().getVaultAccountAsset(vaultAccountId,\ + \ assetId);" name: Fireblocks SDK Java example - language: python - code: "response = fireblocks.vaults.update_vault_account_asset_balance(vault_account_id,\ - \ asset_id, idempotency_key);" + code: "response = fireblocks.vaults.get_vault_account_asset(vault_account_id,\ + \ asset_id);" name: Fireblocks SDK Python example x-codeSamples: - lang: TypeScript - source: "const response: Promise> = fireblocks.vaults.updateVaultAccountAssetBalance(vaultsApiUpdateVaultAccountAssetBalanceRequest);" + source: "const response: Promise> = fireblocks.vaults.getVaultAccountAsset(vaultsApiGetVaultAccountAssetRequest);" - lang: Java - source: "CompletableFuture> response = fireblocks.vaults().updateVaultAccountAssetBalance(vaultAccountId,\ - \ assetId, idempotencyKey);" + source: "CompletableFuture> response = fireblocks.vaults().getVaultAccountAsset(vaultAccountId,\ + \ assetId);" - lang: Python - source: "response = fireblocks.vaults.update_vault_account_asset_balance(vault_account_id,\ - \ asset_id, idempotency_key);" + source: "response = fireblocks.vaults.get_vault_account_asset(vault_account_id,\ + \ asset_id);" x-accepts: - application/json - /vault/accounts/{vaultAccountId}/{assetId}/addresses: - get: - deprecated: true + post: description: |- - DEPRECATED! - - - If your application logic or scripts rely on the deprecated endpoint, you should update to account for GET/V1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated before Mar 31,2024. - - All workspaces created after Mar 31,2024. will have it disabled. If it is disabled for your workspace and you attempt to use it, you will receive the following error message: "This endpoint is unavailable. - - Please use the GET /v1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated endpoint to return all the wallet addresses associated with the specified vault account and asset in a paginated list. - -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - operationId: getVaultAccountAssetAddresses + Creates a wallet for a specific asset in a vault account. + Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + operationId: createVaultAccountAsset parameters: - - description: The ID of the vault account to return + - description: "The ID of the vault account to return, or 'default' for the\ + \ default vault account" explode: false in: path name: vaultAccountId @@ -1290,44 +1300,242 @@ paths: type: string x-fb-entity: asset style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + - description: Optional immutable blockchain wallet type to store per tenant+vault + explode: true + in: query + name: blockchainWalletType + required: false + schema: + type: string + style: form + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAssetsRequest" + required: false responses: "200": content: application/json: schema: - $ref: "#/components/schemas/GetVaultAccountAssetAddressesResponse" - description: A list of deposit addresses + $ref: "#/components/schemas/CreateVaultAssetResponse" + description: OK headers: X-Request-ID: $ref: "#/components/headers/X-Request-ID" default: $ref: "#/components/responses/Error" - summary: Get asset addresses + summary: Create a new vault wallet tags: - Vaults - x-internal: true - x-rate-limit-category: query + x-rate-limit-category: write x-readme: code-samples: - language: python - code: "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id,\ - \ asset_id)" + code: "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)" name: Fireblocks SDK Python example (Legacy) - language: javascript - code: "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId,\ + code: "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId,\ \ assetId);" name: Fireblocks SDK Javascript example + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.vaults.createVaultAccountAsset(vaultsApiCreateVaultAccountAssetRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response\ + \ = fireblocks.vaults().createVaultAccountAsset(vaultAccountId, assetId,\ + \ createAssetsRequest, blockchainWalletType, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.vaults.create_vault_account_asset(vault_account_id,\ + \ asset_id, create_assets_request, blockchain_wallet_type, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.vaults.createVaultAccountAsset(vaultsApiCreateVaultAccountAssetRequest);" + - lang: Java + source: "CompletableFuture> response\ + \ = fireblocks.vaults().createVaultAccountAsset(vaultAccountId, assetId,\ + \ createAssetsRequest, blockchainWalletType, idempotencyKey);" + - lang: Python + source: "response = fireblocks.vaults.create_vault_account_asset(vault_account_id,\ + \ asset_id, create_assets_request, blockchain_wallet_type, idempotency_key);" + x-content-type: application/json x-accepts: - application/json + /vault/accounts/{vaultAccountId}/{assetId}/balance: post: description: |- - Creates a new deposit address for an asset of a vault account. - Should be used for UTXO or Tag/Memo based assets ONLY. + Updates the balance of a specific asset in a vault account. - Requests with account based assets will fail. + This API endpoint is subject to a strict rate limit. + Should be used by clients in very specific scenarios. -
Endpoint Permission: Admin, Non-Signing Admin. - operationId: createVaultAccountAssetAddress + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + operationId: updateVaultAccountAssetBalance + parameters: + - description: The ID of the vault account to return + explode: false + in: path + name: vaultAccountId + required: true + schema: + format: numeric + type: string + x-fb-entity: vault_account + style: simple + - description: The ID of the asset + explode: false + in: path + name: assetId + required: true + schema: + type: string + x-fb-entity: asset + style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/VaultAsset" + description: A VaultAsset object + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Refresh asset balance data + tags: + - Vaults + x-rate-limit-category: high_compute + x-readme: + code-samples: + - language: python + code: "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id,\ + \ asset_id)" + name: Fireblocks SDK Python example (Legacy) + - language: javascript + code: "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId,\ + \ assetId);" + name: Fireblocks SDK Javascript example + - language: typescript + code: "const response: Promise> = fireblocks.vaults.updateVaultAccountAssetBalance(vaultsApiUpdateVaultAccountAssetBalanceRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response = fireblocks.vaults().updateVaultAccountAssetBalance(vaultAccountId,\ + \ assetId, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.vaults.update_vault_account_asset_balance(vault_account_id,\ + \ asset_id, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise> = fireblocks.vaults.updateVaultAccountAssetBalance(vaultsApiUpdateVaultAccountAssetBalanceRequest);" + - lang: Java + source: "CompletableFuture> response = fireblocks.vaults().updateVaultAccountAssetBalance(vaultAccountId,\ + \ assetId, idempotencyKey);" + - lang: Python + source: "response = fireblocks.vaults.update_vault_account_asset_balance(vault_account_id,\ + \ asset_id, idempotency_key);" + x-accepts: + - application/json + /vault/accounts/{vaultAccountId}/{assetId}/addresses: + get: + deprecated: true + description: |- + DEPRECATED! + + - If your application logic or scripts rely on the deprecated endpoint, you should update to account for GET/V1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated before Mar 31,2024. + - All workspaces created after Mar 31,2024. will have it disabled. If it is disabled for your workspace and you attempt to use it, you will receive the following error message: "This endpoint is unavailable. + - Please use the GET /v1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated endpoint to return all the wallet addresses associated with the specified vault account and asset in a paginated list. + + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + operationId: getVaultAccountAssetAddresses + parameters: + - description: The ID of the vault account to return + explode: false + in: path + name: vaultAccountId + required: true + schema: + format: numeric + type: string + x-fb-entity: vault_account + style: simple + - description: The ID of the asset + explode: false + in: path + name: assetId + required: true + schema: + type: string + x-fb-entity: asset + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetVaultAccountAssetAddressesResponse" + description: A list of deposit addresses + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Get asset addresses + tags: + - Vaults + x-internal: true + x-rate-limit-category: query + x-readme: + code-samples: + - language: python + code: "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id,\ + \ asset_id)" + name: Fireblocks SDK Python example (Legacy) + - language: javascript + code: "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId,\ + \ assetId);" + name: Fireblocks SDK Javascript example + x-accepts: + - application/json + post: + description: |- + Creates a new deposit address for an asset of a vault account. + Should be used for UTXO or Tag/Memo based assets ONLY. + + Requests with account based assets will fail. + + Endpoint Permission: Admin, Non-Signing Admin. + operationId: createVaultAccountAssetAddress parameters: - description: The ID of the vault account to return explode: false @@ -1422,7 +1630,7 @@ paths: get: description: |- Returns a paginated response of the addresses for a given vault account and asset. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getVaultAccountAssetAddressesPaginated parameters: - description: The ID of the vault account to return @@ -1679,7 +1887,7 @@ paths: put: description: |- Updates the description of an existing address of an asset in a vault account. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: updateVaultAccountAssetAddress parameters: - description: The ID of the vault account @@ -1782,7 +1990,7 @@ paths: post: description: |- Sets an AML/KYT customer reference ID for a specific address. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: setCustomerRefIdForAddress parameters: - description: The ID of the vault account @@ -1885,7 +2093,7 @@ paths: post: description: |- Converts an existing segwit address to the legacy format. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: createLegacyAddress parameters: - description: The ID of the vault account @@ -1975,7 +2183,7 @@ paths: description: |- Returns unspent inputs information of an UTXO asset in a vault account. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getUnspentInputs parameters: - description: The ID of the vault account @@ -2391,7 +2599,7 @@ paths: get: description: |- Gets the public key information based on derivation path and signing algorithm. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getPublicKeyInfo parameters: - explode: true @@ -2469,7 +2677,7 @@ paths: get: description: |- Get the public key information for a specific asset in a vault account. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getPublicKeyInfoForAddress parameters: - explode: false @@ -2565,7 +2773,7 @@ paths: description: |- Gets the assets amount summary for all accounts or filtered accounts. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getVaultAssets parameters: - explode: true @@ -2637,7 +2845,7 @@ paths: description: |- Get the total balance of an asset across all the vault accounts. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getVaultBalanceByAsset parameters: - explode: false @@ -4619,8 +4827,8 @@ paths: \ such as when you have a security breach.\nTo unfreeze a workspace, the workspace\ \ Owner must submit a request to Fireblocks Support.\n**NOTE:** \n- This operation\ \ can only be performed by the workspace Admins - Your workspace continues\ - \ to receive incoming transfers during this time.\n
Endpoint Permission:\ - \ Admin, Non-Signing Admin." + \ to receive incoming transfers during this time.\nEndpoint Permission: Admin,\ + \ Non-Signing Admin." operationId: freezeWorkspace parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -4654,7 +4862,7 @@ paths: deprecated: true description: |- DEPRECATED - Please use the `/exchange_accounts/paged` endpoint. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getExchangeAccounts responses: "200": @@ -4756,7 +4964,7 @@ paths: /exchange_accounts/paged: get: description: "Returns a list of the connected exchange accounts in your workspace.\ - \
Endpoint Permission: Admin, Non-Signing Admin." + \ Endpoint Permission: Admin, Non-Signing Admin." operationId: getPagedExchangeAccounts parameters: - explode: true @@ -4838,7 +5046,7 @@ paths: get: description: |- Returns an exchange account by ID. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getExchangeAccount parameters: - description: The ID of the exchange account to return @@ -4896,7 +5104,7 @@ paths: description: |- Transfers funds between trading accounts under the same exchange account. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: internalTransfer parameters: - description: The ID of the exchange account to return @@ -4973,7 +5181,7 @@ paths: description: |- Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: convertAssets parameters: - description: "The ID of the exchange account. Please make sure the exchange\ @@ -5050,7 +5258,7 @@ paths: get: description: |- Returns an asset for an exchange account. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getExchangeAccountAsset parameters: - description: The ID of the exchange account to return @@ -5165,7 +5373,7 @@ paths: get: description: |- Returns all fiat accounts. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getFiatAccounts responses: "200": @@ -5215,7 +5423,7 @@ paths: get: description: |- Returns a fiat account by ID. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getFiatAccount parameters: - description: The ID of the fiat account to return @@ -5511,7 +5719,8 @@ paths: /connected_accounts/{accountId}: delete: description: | - Disconnect a connected account by ID.
+ Disconnect a connected account by ID. + **Note**: - This endpoint is currently in beta and might be subject to changes. operationId: disconnectConnectedAccount @@ -5961,6 +6170,350 @@ paths: \ page_size, page_cursor);" x-accepts: - application/json + /counterparty_groups: + get: + description: | + Returns a paginated list of counterparty groups. + + **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. + operationId: listCounterpartyGroups + parameters: + - description: Cursor of the required page + explode: true + in: query + name: pageCursor + required: false + schema: + type: string + style: form + - description: Maximum number of items in the page + explode: true + in: query + name: pageSize + required: false + schema: + default: 50 + maximum: 100 + minimum: 1 + type: integer + style: form + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/CounterpartyGroupsPaginatedResponse" + description: A paginated list of counterparty groups + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: List counterparty groups + tags: + - Compliance + x-rate-limit-category: query + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.compliance.listCounterpartyGroups(complianceApiListCounterpartyGroupsRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture>\ + \ response = fireblocks.compliance().listCounterpartyGroups(pageCursor,\ + \ pageSize);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.compliance.list_counterparty_groups(page_cursor,\ + \ page_size);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.compliance.listCounterpartyGroups(complianceApiListCounterpartyGroupsRequest);" + - lang: Java + source: "CompletableFuture>\ + \ response = fireblocks.compliance().listCounterpartyGroups(pageCursor,\ + \ pageSize);" + - lang: Python + source: "response = fireblocks.compliance.list_counterparty_groups(page_cursor,\ + \ page_size);" + x-accepts: + - application/json + post: + description: | + Creates a new counterparty group. + + **Endpoint Permissions:** Admin, Non-Signing Admin. + operationId: createCounterpartyGroup + parameters: + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCounterpartyGroupRequest" + required: true + responses: + "201": + content: + application/json: + schema: + $ref: "#/components/schemas/CounterpartyGroup" + description: Counterparty group created successfully + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Create a counterparty group + tags: + - Compliance + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise> =\ + \ fireblocks.compliance.createCounterpartyGroup(complianceApiCreateCounterpartyGroupRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response = fireblocks.compliance().createCounterpartyGroup(createCounterpartyGroupRequest,\ + \ idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.compliance.create_counterparty_group(create_counterparty_group_request,\ + \ idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise> =\ + \ fireblocks.compliance.createCounterpartyGroup(complianceApiCreateCounterpartyGroupRequest);" + - lang: Java + source: "CompletableFuture> response = fireblocks.compliance().createCounterpartyGroup(createCounterpartyGroupRequest,\ + \ idempotencyKey);" + - lang: Python + source: "response = fireblocks.compliance.create_counterparty_group(create_counterparty_group_request,\ + \ idempotency_key);" + x-content-type: application/json + x-accepts: + - application/json + /counterparty_groups/{groupId}: + delete: + description: | + Permanently deletes a counterparty group. + + **Endpoint Permissions:** Admin, Non-Signing Admin. + operationId: deleteCounterpartyGroup + parameters: + - description: The unique identifier of the counterparty group + explode: false + in: path + name: groupId + required: true + schema: + format: uuid + type: string + style: simple + responses: + "204": + description: Counterparty group deleted successfully + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorSchema" + description: Counterparty group not found + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Delete a counterparty group + tags: + - Compliance + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise> = fireblocks.compliance.deleteCounterpartyGroup(complianceApiDeleteCounterpartyGroupRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: CompletableFuture> response = fireblocks.compliance().deleteCounterpartyGroup(groupId); + name: Fireblocks SDK Java example + - language: python + code: response = fireblocks.compliance.delete_counterparty_group(group_id); + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise> = fireblocks.compliance.deleteCounterpartyGroup(complianceApiDeleteCounterpartyGroupRequest);" + - lang: Java + source: CompletableFuture> response = fireblocks.compliance().deleteCounterpartyGroup(groupId); + - lang: Python + source: response = fireblocks.compliance.delete_counterparty_group(group_id); + x-accepts: + - application/json + get: + description: | + Returns the details of a specific counterparty group. + + **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. + operationId: getCounterpartyGroup + parameters: + - description: The unique identifier of the counterparty group + explode: false + in: path + name: groupId + required: true + schema: + format: uuid + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/CounterpartyGroup" + description: A counterparty group object + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorSchema" + description: Counterparty group not found + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Get a counterparty group + tags: + - Compliance + x-rate-limit-category: read + x-readme: + code-samples: + - language: typescript + code: "const response: Promise> =\ + \ fireblocks.compliance.getCounterpartyGroup(complianceApiGetCounterpartyGroupRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: CompletableFuture> response = fireblocks.compliance().getCounterpartyGroup(groupId); + name: Fireblocks SDK Java example + - language: python + code: response = fireblocks.compliance.get_counterparty_group(group_id); + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise> =\ + \ fireblocks.compliance.getCounterpartyGroup(complianceApiGetCounterpartyGroupRequest);" + - lang: Java + source: CompletableFuture> response = fireblocks.compliance().getCounterpartyGroup(groupId); + - lang: Python + source: response = fireblocks.compliance.get_counterparty_group(group_id); + x-accepts: + - application/json + patch: + description: | + Updates an existing counterparty group. + + **Endpoint Permissions:** Admin, Non-Signing Admin. + operationId: updateCounterpartyGroup + parameters: + - description: The unique identifier of the counterparty group + explode: false + in: path + name: groupId + required: true + schema: + format: uuid + type: string + style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateCounterpartyGroupRequest" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/CounterpartyGroup" + description: Counterparty group updated successfully + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorSchema" + description: Counterparty group not found + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Update a counterparty group + tags: + - Compliance + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise> =\ + \ fireblocks.compliance.updateCounterpartyGroup(complianceApiUpdateCounterpartyGroupRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response = fireblocks.compliance().updateCounterpartyGroup(updateCounterpartyGroupRequest,\ + \ groupId, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.compliance.update_counterparty_group(update_counterparty_group_request,\ + \ group_id, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise> =\ + \ fireblocks.compliance.updateCounterpartyGroup(complianceApiUpdateCounterpartyGroupRequest);" + - lang: Java + source: "CompletableFuture> response = fireblocks.compliance().updateCounterpartyGroup(updateCounterpartyGroupRequest,\ + \ groupId, idempotencyKey);" + - lang: Python + source: "response = fireblocks.compliance.update_counterparty_group(update_counterparty_group_request,\ + \ group_id, idempotency_key);" + x-content-type: application/json + x-accepts: + - application/json /network_connections: get: description: |- @@ -8261,7 +8814,7 @@ paths: - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getExternalWallets responses: "200": @@ -8315,7 +8868,7 @@ paths: - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: createExternalWallet parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -8385,7 +8938,7 @@ paths: /external_wallets/{walletId}: delete: description: "Deletes an external wallet by ID. External Wallet is a whitelisted\ - \ address of a wallet that belongs to your users/counterparties.
Endpoint\ + \ address of a wallet that belongs to your users/counterparties. Endpoint\ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: deleteExternalWallet parameters: @@ -8437,7 +8990,7 @@ paths: - application/json get: description: "Returns an external wallet by ID. External Wallet is a whitelisted\ - \ address of a wallet that belongs to your users/counterparties.
Endpoint\ + \ address of a wallet that belongs to your users/counterparties. Endpoint\ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer." operationId: getExternalWallet parameters: @@ -8495,8 +9048,8 @@ paths: post: description: "Sets an AML/KYT customer reference ID for the specific external\ \ wallet. External Wallet is a whitelisted address of a wallet that belongs\ - \ to your users/counterparties.
Endpoint Permission: Admin, Non-Signing\ - \ Admin, Signer, Approver, Editor." + \ to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin,\ + \ Signer, Approver, Editor." operationId: setExternalWalletCustomerRefId parameters: - description: The wallet ID @@ -8571,8 +9124,8 @@ paths: - application/json /external_wallets/{walletId}/{assetId}: delete: - description: "Deletes an external wallet asset by ID.
Endpoint Permission:\ - \ Admin, Non-Signing Admin, Signer, Approver, Editor." + description: "Deletes an external wallet asset by ID. Endpoint Permission: Admin,\ + \ Non-Signing Admin, Signer, Approver, Editor." operationId: removeAssetFromExternalWallet parameters: - description: The ID of the wallet @@ -8638,7 +9191,7 @@ paths: get: description: "Returns an external wallet by wallet ID and asset ID. External\ \ Wallet is a whitelisted address of a wallet that belongs to your users/counterparties.\ - \
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,\ + \ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,\ \ Viewer." operationId: getExternalWalletAsset parameters: @@ -8710,7 +9263,7 @@ paths: x-accepts: - application/json post: - description: "Adds an asset to an existing external wallet.
Endpoint Permission:\ + description: "Adds an asset to an existing external wallet. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: addAssetToExternalWallet parameters: @@ -8800,8 +9353,8 @@ paths: - application/json /contracts: get: - description: "Gets a list of whitelisted contracts.
Endpoint Permission:\ - \ Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer." + description: "Gets a list of whitelisted contracts. Endpoint Permission: Admin,\ + \ Non-Signing Admin, Signer, Approver, Editor, Viewer." operationId: getContracts responses: "200": @@ -8842,7 +9395,7 @@ paths: x-accepts: - application/json post: - description: "Adds a contract to the workspace whitelist.
Endpoint Permission:\ + description: "Adds a contract to the workspace whitelist. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: createContract parameters: @@ -8905,7 +9458,7 @@ paths: - application/json /contracts/{contractId}: delete: - description: "Deletes a contract by ID.
Endpoint Permission: Admin, Non-Signing\ + description: "Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing\ \ Admin, Signer, Approver, Editor." operationId: deleteContract parameters: @@ -8950,7 +9503,7 @@ paths: x-accepts: - application/json get: - description: "Returns a whitelisted contract by Fireblocks Contract ID.
Endpoint\ + description: "Returns a whitelisted contract by Fireblocks Contract ID. Endpoint\ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: getContract parameters: @@ -9000,7 +9553,7 @@ paths: - application/json /contracts/{contractId}/{assetId}: delete: - description: "Deletes a whitelisted contract asset by ID.
Endpoint Permission:\ + description: "Deletes a whitelisted contract asset by ID. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: deleteContractAsset parameters: @@ -9058,7 +9611,7 @@ paths: x-accepts: - application/json get: - description: "Returns a whitelisted contract's asset by ID.
Endpoint Permission:\ + description: "Returns a whitelisted contract's asset by ID. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: getContractAsset parameters: @@ -9120,7 +9673,7 @@ paths: x-accepts: - application/json post: - description: "Adds an asset to a whitelisted contract.
Endpoint Permission:\ + description: "Adds an asset to a whitelisted contract. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: addContractAsset parameters: @@ -9533,7 +10086,7 @@ paths: /assets/{id}: get: description: | - Returns an asset by ID or legacyID.
+ Returns an asset by ID or legacyID. **Note**: @@ -9806,7 +10359,7 @@ paths: /blockchains: get: description: | - Returns all blockchains supported by Fireblocks.
+ Returns all blockchains supported by Fireblocks. operationId: listBlockchains parameters: - description: Blockchain protocol @@ -10330,11 +10883,10 @@ paths: description: |- Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. - - **Note**: Supports all Fireblocks assets except ZCash (ZEC). + The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). -
Endpoint Permission: Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Signer, Approver, Editor. operationId: estimateTransactionFee parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -10410,7 +10962,7 @@ paths: get: description: |- Get a specific transaction data by Fireblocks Transaction ID -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getTransaction parameters: - description: The ID of the transaction to return @@ -10472,7 +11024,7 @@ paths: get: description: |- Returns transaction by external transaction ID. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getTransactionByExternalId parameters: - description: The external ID of the transaction to return @@ -10532,7 +11084,7 @@ paths: post: description: |- Overrides the required number of confirmations for transaction completion Fireblocks Transaction ID. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: setTransactionConfirmationThreshold parameters: - description: The ID of the transaction @@ -10614,7 +11166,7 @@ paths: post: description: |- Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: dropTransaction parameters: - description: The ID of the transaction @@ -10708,7 +11260,7 @@ paths: Cancels a transaction by Fireblocks Transaction ID. Can be used only for transactions that did not get to the BROADCASTING state. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: cancelTransaction parameters: - description: The ID of the transaction to cancel @@ -10795,7 +11347,7 @@ paths: description: "Freezes a transaction by ID.\n\nUsually used for AML integrations\ \ when the incoming funds should be quarantined.\nFor account based assets\ \ - the entire amount of the transaction is frozen \nFor UTXO based assets\ - \ - all UTXOs of the specified transaction are frozen\n
Endpoint Permission:\ + \ - all UTXOs of the specified transaction are frozen\nEndpoint Permission:\ \ Admin, Non-Signing Admin." operationId: freezeTransaction parameters: @@ -10880,7 +11432,7 @@ paths: post: description: |- Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available again. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: unfreezeTransaction parameters: - description: The ID of the transaction to unfreeze @@ -10964,7 +11516,7 @@ paths: get: description: |- Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: validateAddress parameters: - description: The asset of the address @@ -11034,7 +11586,7 @@ paths: post: description: |- Overrides the required number of confirmations for transaction completion by transaction hash. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: setConfirmationThresholdByTransactionHash parameters: - description: The TxHash @@ -11127,7 +11679,7 @@ paths: - For other assets, the response will contain the `networkFee` parameter. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: estimateNetworkFee parameters: - description: The asset for which to estimate the fee @@ -11188,18 +11740,33 @@ paths: /payments/payout: post: description: | - **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
-
These endpoints are currently in beta and might be subject to changes.
-
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
-
Create a payout instruction set.
- A payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts.
- The instruction set defines:
-
    -
  • the payment account and its account type (vault, exchange, or fiat).
    • -
  • the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account.
    • -
- Learn more about Fireblocks Payments - Payouts in the following [guide](https://developers.fireblocks.com/docs/create-payouts). -
Endpoint Permission: Admin, Non-Signing Admin. + **Note:** The reference content in this section documents the Payments + Engine endpoint. The Payments Engine endpoints include APIs available only + for customers with Payments Engine enabled on their accounts. + + These endpoints are currently in beta and might be subject to + changes. + + If you want to learn more about Fireblocks Payments Engine, please + contact your Fireblocks Customer Success Manager or email + CSM@fireblocks.com. + + **Create a payout instruction set.** + + A payout instruction set is a set of instructions for distributing payments + from a single payment account to a list of payee accounts. + + The instruction set defines: + + - the payment account and its account type (vault, exchange, or fiat). + - the account type (vault account, exchange account, whitelisted address, + network connection, fiat account, or merchant account), the amount, and the + asset of payment for each payee account. + + Learn more about Fireblocks Payments - Payouts in the following + [guide](https://developers.fireblocks.com/docs/create-payouts). + + Endpoint Permission: Admin, Non-Signing Admin. operationId: createPayout parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -11325,13 +11892,27 @@ paths: /payments/payout/{payoutId}/actions/execute: post: description: | - **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
-
These endpoints are currently in beta and might be subject to changes.
-
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
-
Execute a payout instruction set.
-
The instruction set will be verified and executed.
- Source locking
 - If you are executing a payout instruction set from a payment account with an already active payout the active payout will complete before the new payout instruction set can be executed.
+ **Note:** The reference content in this section documents the Payments + Engine endpoint. The Payments Engine endpoints include APIs available only + for customers with Payments Engine enabled on their accounts. + + These endpoints are currently in beta and might be subject to + changes. + + If you want to learn more about Fireblocks Payments Engine, please + contact your Fireblocks Customer Success Manager or email + CSM@fireblocks.com. + + **Execute a payout instruction set.** + + The instruction set will be verified and executed. + + **Source locking** + + If you are executing a payout instruction set from a payment account with an + already active payout the active payout will complete before the new payout + instruction set can be executed. + You cannot execute the same payout instruction set more than once. operationId: executePayoutAction parameters: @@ -11416,11 +11997,13 @@ paths: - application/json /payments/payout/{payoutId}: get: - description: | - **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
-
These endpoints are currently in beta and might be subject to changes.
-
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
-
Endpoint Permission: Admin, Non-Signing Admin. + description: "**Note:** The reference content in this section documents the\ + \ Payments Engine endpoint. The Payments Engine endpoints include APIs available\ + \ only for customers with Payments Engine enabled on their accounts. \nThese\ + \ endpoints are currently in beta and might be subject to changes.\nIf you\ + \ want to learn more about Fireblocks Payments Engine, please contact your\ + \ Fireblocks Customer Success Manager or email CSM@fireblocks.com. \nEndpoint\ + \ Permission: Admin, Non-Signing Admin.\n" operationId: getPayout parameters: - description: the payout id received from the creation of the payout instruction @@ -11807,7 +12390,7 @@ paths: get: description: |- Returns gas station settings and ETH balance. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getGasStationInfo responses: "200": @@ -11859,7 +12442,7 @@ paths: get: description: |- Returns gas station settings and balances for a requested asset. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getGasStationByAssetId parameters: - description: The ID of the asset @@ -11922,7 +12505,7 @@ paths: description: |- Configures gas station settings for ETH. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: updateGasStationConfiguration parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -12000,7 +12583,7 @@ paths: description: |- Configures gas station settings for a requested asset. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: updateGasStationConfigurationByAssetId parameters: - description: The ID of the asset @@ -12080,7 +12663,7 @@ paths: Get all user groups in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getUserGroups responses: "200": @@ -12125,7 +12708,7 @@ paths: post: description: |- Create a new user group. Users with the Viewer role cannot be added to groups. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: createUserGroup parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -12193,7 +12776,7 @@ paths: /management/user_groups/{groupId}: delete: description: | - Delete a user group by ID.
+ Delete a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. @@ -12242,7 +12825,7 @@ paths: - application/json get: description: | - Get a user group by ID.
+ Get a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. @@ -12297,7 +12880,7 @@ paths: - application/json put: description: | - Update a user group by ID.
+ Update a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. @@ -12429,7 +13012,7 @@ paths: Get Audit logs for the last Day/Week. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getAuditLogs parameters: - description: The last time period to fetch audit logs @@ -12496,7 +13079,7 @@ paths: description: |- Add collateral and create deposit request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: addOffExchange parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -12561,7 +13144,7 @@ paths: description: |- Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: removeOffExchange parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -12627,7 +13210,7 @@ paths: description: |- Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: settleOffExchangeTrades parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -12691,7 +13274,7 @@ paths: description: |- Get settlements transactions from exchange. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getOffExchangeSettlementTransactions parameters: - explode: true @@ -12741,7 +13324,7 @@ paths: description: |- Returns a collateral account by mainExchangeAccountId. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getOffExchangeCollateralAccounts parameters: - description: The id of the main exchange account for which the requested collateral @@ -12796,7 +13379,7 @@ paths: Learn more about Fireblocks Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: resendWebhooks parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -14096,7 +14679,7 @@ paths: get: description: |- Return minimal representation of all the contract templates available for the workspace. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getContractTemplates parameters: - description: Items per page (max 100) @@ -15118,7 +15701,7 @@ paths: post: description: |- Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status "PENDING" until the token is deployed or "SUCCESS" if no deployment is needed. -
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. + Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. operationId: issueNewToken parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -16349,7 +16932,7 @@ paths: get: description: |- Get collections (paginated). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getLinkedCollections parameters: - description: "Page cursor to get the next page, for example - \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\"" @@ -16425,7 +17008,7 @@ paths: post: description: |- Create a new collection and link it as a token. -
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. + Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. operationId: createNewCollection parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -16790,7 +17373,7 @@ paths: get: description: |- Return deployed contract's ABI by blockchain native asset id and contract address. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. operationId: getDeployedContractAbi parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -17055,7 +17638,7 @@ paths: get: description: "Retrieve the transaction receipt by blockchain native asset ID\ \ and transaction hash\n> **Note** > This functionality is exclusively available\ - \ for EVM (Ethereum Virtual Machine) compatible chains. \n
Endpoint Permission:\ + \ for EVM (Ethereum Virtual Machine) compatible chains. \nEndpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer." operationId: getTransactionReceipt parameters: @@ -18166,7 +18749,7 @@ paths: get: description: |- Returns an alphabetical list of blockchains supported for staking by the current workspace context. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getChains responses: "200": @@ -18355,8 +18938,8 @@ paths: \ regardless of existing delegations. For Cosmos chains and Ethereum liquid\ \ staking (Lido): automatically add to existing positions for the same validator\ \ provider and same vault account if one exists, otherwise create a new position.\ - \ For Solana and Polygon: always create new positions regardless of existing\ - \ delegations." + \ For Solana and Polygon (MATIC/POL): always create new positions regardless\ + \ of existing delegations." operationId: stake parameters: - description: "Protocol identifier for the stake staking operation (e.g., ATOM_COS/AXL/CELESTIA)." @@ -18591,9 +19174,10 @@ paths: - application/json /staking/chains/{chainDescriptor}/withdraw: post: - description: Withdraws funds that have completed the unbonding period. Typically - requires the position to be deactivated first (unstake → unbond → withdraw). - Amount and timing vary by chain protocol. + description: |- + Withdraws funds that have completed the unbonding period. Typically requires the position to be deactivated first (unstake → unbond → withdraw). Amount and timing vary by chain protocol. + + Partial withdrawal is supported for ETH compounding validators (EIP-7251/Pectra) and Cosmos chains via the optional 'amount' field. For ETH compounding validators, the remaining balance must be at least 32 ETH after the withdrawal. For all other chains, omitting 'amount' withdraws the entire available balance. operationId: withdraw parameters: - description: "Protocol identifier for the withdraw staking operation (e.g.,\ @@ -18710,12 +19294,12 @@ paths: /staking/chains/{chainDescriptor}/claim_rewards: post: description: "Claims available staking rewards for the specified chain and vault.\ - \ Supported chains: Solana and Polygon (Matic). Behavior depends on protocol\ + \ Supported chains: Solana and Polygon (POL/Matic). Behavior depends on protocol\ \ reward distribution." operationId: claimRewards parameters: - description: "Protocol identifier for the claim rewards staking operation\ - \ (e.g., MATIC/SOL)." + \ (e.g., POL/MATIC/SOL)." example: SOL explode: false in: path @@ -18726,6 +19310,8 @@ paths: - SOL - SOL_TEST - MATIC + - POL + - POL_TEST type: string style: simple - description: "A unique identifier for the request. If the request is sent\ @@ -18959,7 +19545,7 @@ paths: post: description: |- Merges the source stake account into the destination, consolidating the balance into the destination and closing the source account once complete. Both accounts must be from the same validator provider and of same vault account.. Supported chains: Solana (SOL). -
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: mergeStakeAccounts parameters: - description: "Protocol identifier for the merge staking operation (e.g., SOL)." @@ -19087,8 +19673,8 @@ paths: /staking/chains/{chainDescriptor}/consolidate: post: description: |- - Consolidates the source staking position into the destination, merging the balance into the destination and closing the source position once complete. Both positions must be from the same funding vaults account (i.e. same withdrawals credentials). On chain, this translates into a consolidation transaction, where the source validator is consolidated into the destination validator. Supported chains: Ethereum (ETH) only. -
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. + Consolidates the source staking position into the destination, merging the balance into the destination and closing the source position once complete. Both positions must be from the same vault account (i.e. same withdrawal credentials). On chain, this translates into a consolidation transaction, where the source validator is consolidated into the destination validator. Supported chains: Ethereum (ETH) only. + Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. **Note:** This endpoint is currently in beta and might be subject to changes. operationId: consolidate parameters: @@ -19219,10 +19805,10 @@ paths: get: description: |- Returns all staking positions with core details: amounts, rewards, status, chain, and vault. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getAllDelegations parameters: - - description: "Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}).\ + - description: "Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA).\ \ If omitted, positions across all supported chains are returned." explode: true in: query @@ -19336,10 +19922,10 @@ paths: get: description: |- Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getPositions parameters: - - description: "Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}).\ + - description: "Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA).\ \ If omitted, positions across all supported chains are returned." explode: true in: query @@ -19812,7 +20398,7 @@ paths: get: description: |- Returns all available staking providers with metadata such as name, ID, and supported chains. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: getProviders responses: "200": @@ -21887,7 +22473,7 @@ paths: Updates all tokens and balances per blockchain and vault account. Learn more about Fireblocks NFT management in the following [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: updateOwnershipTokens parameters: - description: Blockchain descriptor filter @@ -23672,7 +24258,7 @@ paths: Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary's jurisdiction. Learn more about Fireblocks Travel Rule management in the following [guide](https://developers.fireblocks.com/docs/define-travel-rule-policies). -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: validateTravelRuleTransaction parameters: - description: |- @@ -26644,133 +27230,367 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/TRLinkTrmInfoResponse" - description: TRM retrieved successfully - headers: - X-Request-ID: - $ref: "#/components/headers/X-Request-ID" + $ref: "#/components/schemas/TRLinkTrmInfoResponse" + description: TRM retrieved successfully + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Get TRM by ID + tags: + - TRLink + x-rate-limit-category: read + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.tRLink.getTRLinkTrmById(tRLinkApiGetTRLinkTrmByIdRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response =\ + \ fireblocks.tRLink().getTRLinkTrmById(customerIntegrationId, trmId);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.t_r_link.get_t_r_link_trm_by_id(customer_integration_id,\ + \ trm_id);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.tRLink.getTRLinkTrmById(tRLinkApiGetTRLinkTrmByIdRequest);" + - lang: Java + source: "CompletableFuture> response =\ + \ fireblocks.tRLink().getTRLinkTrmById(customerIntegrationId, trmId);" + - lang: Python + source: "response = fireblocks.t_r_link.get_t_r_link_trm_by_id(customer_integration_id,\ + \ trm_id);" + x-accepts: + - application/json + /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel: + post: + description: Cancels a travel rule message. The TRM status will be updated to + cancelled and the partner will be notified. + operationId: cancelTRLinkTrm + parameters: + - description: Customer integration unique identifier + explode: false + in: path + name: customerIntegrationId + required: true + schema: + format: uuid + type: string + style: simple + - description: Travel Rule Message unique identifier + explode: false + in: path + name: trmId + required: true + schema: + type: string + style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkCancelTrmRequest" + required: true + responses: + "202": + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkTrmInfoResponse" + description: Transaction cancellation request accepted + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Cancel Travel Rule Message + tags: + - TRLink + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.tRLink.cancelTRLinkTrm(tRLinkApiCancelTRLinkTrmRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response =\ + \ fireblocks.tRLink().cancelTRLinkTrm(tRLinkCancelTrmRequest, customerIntegrationId,\ + \ trmId, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.t_r_link.cancel_t_r_link_trm(t_r_link_cancel_trm_request,\ + \ customer_integration_id, trm_id, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.tRLink.cancelTRLinkTrm(tRLinkApiCancelTRLinkTrmRequest);" + - lang: Java + source: "CompletableFuture> response =\ + \ fireblocks.tRLink().cancelTRLinkTrm(tRLinkCancelTrmRequest, customerIntegrationId,\ + \ trmId, idempotencyKey);" + - lang: Python + source: "response = fireblocks.t_r_link.cancel_t_r_link_trm(t_r_link_cancel_trm_request,\ + \ customer_integration_id, trm_id, idempotency_key);" + x-content-type: application/json + x-accepts: + - application/json + /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect: + post: + description: Redirects a Travel Rule Message to a subsidiary VASP. This operation + requires the partner to support nested VASPs functionality. + operationId: redirectTRLinkTrm + parameters: + - description: Customer integration unique identifier + explode: false + in: path + name: customerIntegrationId + required: true + schema: + format: uuid + type: string + style: simple + - description: Travel Rule Message unique identifier + explode: false + in: path + name: trmId + required: true + schema: + type: string + style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkRedirectTrmRequest" + required: true + responses: + "202": + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkTrmInfoResponse" + description: Transaction redirect request accepted + headers: + X-Request-ID: + $ref: "#/components/headers/X-Request-ID" + default: + $ref: "#/components/responses/Error" + summary: Redirect Travel Rule Message + tags: + - TRLink + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.tRLink.redirectTRLinkTrm(tRLinkApiRedirectTRLinkTrmRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response =\ + \ fireblocks.tRLink().redirectTRLinkTrm(tRLinkRedirectTrmRequest, customerIntegrationId,\ + \ trmId, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.t_r_link.redirect_t_r_link_trm(t_r_link_redirect_trm_request,\ + \ customer_integration_id, trm_id, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.tRLink.redirectTRLinkTrm(tRLinkApiRedirectTRLinkTrmRequest);" + - lang: Java + source: "CompletableFuture> response =\ + \ fireblocks.tRLink().redirectTRLinkTrm(tRLinkRedirectTrmRequest, customerIntegrationId,\ + \ trmId, idempotencyKey);" + - lang: Python + source: "response = fireblocks.t_r_link.redirect_t_r_link_trm(t_r_link_redirect_trm_request,\ + \ customer_integration_id, trm_id, idempotency_key);" + x-content-type: application/json + x-accepts: + - application/json + /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision: + post: + description: Accept or reject destinations stuck in NoTRM step without waiting + for TRP webhook or policy timeout. + operationId: createTRLinkManualDecision + parameters: + - description: Customer integration unique identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + explode: false + in: path + name: customerIntegrationId + required: true + schema: + format: uuid + type: string + style: simple + - description: Fireblocks transaction unique identifier + example: b70701f4-d7b1-4795-a8ee-b09cdb5b850e + explode: false + in: path + name: txId + required: true + schema: + format: uuid + type: string + style: simple + - description: "A unique identifier for the request. If the request is sent\ + \ multiple times with the same idempotency key, the server will return the\ + \ same response as the first request. The idempotency key is valid for 24\ + \ hours." + explode: false + in: header + name: Idempotency-Key + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkManualDecisionRequest" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkManualDecisionResponse" + description: Decision applied successfully + default: + $ref: "#/components/responses/Error" + summary: Manual decision for missing TRM + tags: + - TRLink + x-rate-limit-category: write + x-readme: + code-samples: + - language: typescript + code: "const response: Promise>\ + \ = fireblocks.tRLink.createTRLinkManualDecision(tRLinkApiCreateTRLinkManualDecisionRequest);" + name: Fireblocks SDK TypeScript example + - language: java + code: "CompletableFuture> response\ + \ = fireblocks.tRLink().createTRLinkManualDecision(tRLinkManualDecisionRequest,\ + \ customerIntegrationId, txId, idempotencyKey);" + name: Fireblocks SDK Java example + - language: python + code: "response = fireblocks.t_r_link.create_t_r_link_manual_decision(t_r_link_manual_decision_request,\ + \ customer_integration_id, tx_id, idempotency_key);" + name: Fireblocks SDK Python example + x-codeSamples: + - lang: TypeScript + source: "const response: Promise>\ + \ = fireblocks.tRLink.createTRLinkManualDecision(tRLinkApiCreateTRLinkManualDecisionRequest);" + - lang: Java + source: "CompletableFuture> response\ + \ = fireblocks.tRLink().createTRLinkManualDecision(tRLinkManualDecisionRequest,\ + \ customerIntegrationId, txId, idempotencyKey);" + - lang: Python + source: "response = fireblocks.t_r_link.create_t_r_link_manual_decision(t_r_link_manual_decision_request,\ + \ customer_integration_id, tx_id, idempotency_key);" + x-content-type: application/json + x-accepts: + - application/json + /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions: + get: + description: "Retrieves the list of required actions (e.g., PII fields) needed\ + \ to process the Travel Rule Message." + operationId: getTRLinkTrmRequiredActions + parameters: + - description: Customer integration unique identifier + explode: false + in: path + name: customerIntegrationId + required: true + schema: + format: uuid + type: string + style: simple + - description: Travel Rule Message unique identifier + explode: false + in: path + name: trmId + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/TRLinkGetRequiredActionsResponse" + description: Required actions retrieved successfully default: $ref: "#/components/responses/Error" - summary: Get TRM by ID + summary: Get required actions for a TRM tags: - TRLink - x-rate-limit-category: read + x-rate-limit-category: query x-readme: code-samples: - language: typescript - code: "const response: Promise>\ - \ = fireblocks.tRLink.getTRLinkTrmById(tRLinkApiGetTRLinkTrmByIdRequest);" + code: "const response: Promise>\ + \ = fireblocks.tRLink.getTRLinkTrmRequiredActions(tRLinkApiGetTRLinkTrmRequiredActionsRequest);" name: Fireblocks SDK TypeScript example - language: java - code: "CompletableFuture> response =\ - \ fireblocks.tRLink().getTRLinkTrmById(customerIntegrationId, trmId);" + code: "CompletableFuture>\ + \ response = fireblocks.tRLink().getTRLinkTrmRequiredActions(customerIntegrationId,\ + \ trmId);" name: Fireblocks SDK Java example - language: python - code: "response = fireblocks.t_r_link.get_t_r_link_trm_by_id(customer_integration_id,\ + code: "response = fireblocks.t_r_link.get_t_r_link_trm_required_actions(customer_integration_id,\ \ trm_id);" name: Fireblocks SDK Python example x-codeSamples: - lang: TypeScript - source: "const response: Promise>\ - \ = fireblocks.tRLink.getTRLinkTrmById(tRLinkApiGetTRLinkTrmByIdRequest);" + source: "const response: Promise>\ + \ = fireblocks.tRLink.getTRLinkTrmRequiredActions(tRLinkApiGetTRLinkTrmRequiredActionsRequest);" - lang: Java - source: "CompletableFuture> response =\ - \ fireblocks.tRLink().getTRLinkTrmById(customerIntegrationId, trmId);" + source: "CompletableFuture>\ + \ response = fireblocks.tRLink().getTRLinkTrmRequiredActions(customerIntegrationId,\ + \ trmId);" - lang: Python - source: "response = fireblocks.t_r_link.get_t_r_link_trm_by_id(customer_integration_id,\ + source: "response = fireblocks.t_r_link.get_t_r_link_trm_required_actions(customer_integration_id,\ \ trm_id);" x-accepts: - application/json - /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel: - post: - description: Cancels a travel rule message. The TRM status will be updated to - cancelled and the partner will be notified. - operationId: cancelTRLinkTrm - parameters: - - description: Customer integration unique identifier - explode: false - in: path - name: customerIntegrationId - required: true - schema: - format: uuid - type: string - style: simple - - description: Travel Rule Message unique identifier - explode: false - in: path - name: trmId - required: true - schema: - type: string - style: simple - - description: "A unique identifier for the request. If the request is sent\ - \ multiple times with the same idempotency key, the server will return the\ - \ same response as the first request. The idempotency key is valid for 24\ - \ hours." - explode: false - in: header - name: Idempotency-Key - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/TRLinkCancelTrmRequest" - required: true - responses: - "202": - content: - application/json: - schema: - $ref: "#/components/schemas/TRLinkTrmInfoResponse" - description: Transaction cancellation request accepted - headers: - X-Request-ID: - $ref: "#/components/headers/X-Request-ID" - default: - $ref: "#/components/responses/Error" - summary: Cancel Travel Rule Message - tags: - - TRLink - x-rate-limit-category: write - x-readme: - code-samples: - - language: typescript - code: "const response: Promise>\ - \ = fireblocks.tRLink.cancelTRLinkTrm(tRLinkApiCancelTRLinkTrmRequest);" - name: Fireblocks SDK TypeScript example - - language: java - code: "CompletableFuture> response =\ - \ fireblocks.tRLink().cancelTRLinkTrm(tRLinkCancelTrmRequest, customerIntegrationId,\ - \ trmId, idempotencyKey);" - name: Fireblocks SDK Java example - - language: python - code: "response = fireblocks.t_r_link.cancel_t_r_link_trm(t_r_link_cancel_trm_request,\ - \ customer_integration_id, trm_id, idempotency_key);" - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: "const response: Promise>\ - \ = fireblocks.tRLink.cancelTRLinkTrm(tRLinkApiCancelTRLinkTrmRequest);" - - lang: Java - source: "CompletableFuture> response =\ - \ fireblocks.tRLink().cancelTRLinkTrm(tRLinkCancelTrmRequest, customerIntegrationId,\ - \ trmId, idempotencyKey);" - - lang: Python - source: "response = fireblocks.t_r_link.cancel_t_r_link_trm(t_r_link_cancel_trm_request,\ - \ customer_integration_id, trm_id, idempotency_key);" - x-content-type: application/json - x-accepts: - - application/json - /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect: + /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_action: post: - description: Redirects a Travel Rule Message to a subsidiary VASP. This operation - requires the partner to support nested VASPs functionality. - operationId: redirectTRLinkTrm + description: "Submits required data (e.g., beneficiary PII) to resolve a pending\ + \ Travel Rule Message action." + operationId: resolveActionTRLinkTrm parameters: - description: Customer integration unique identifier explode: false @@ -26804,21 +27624,18 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/TRLinkRedirectTrmRequest" + $ref: "#/components/schemas/TRLinkResolveActionRequest" required: true responses: - "202": + "200": content: application/json: schema: $ref: "#/components/schemas/TRLinkTrmInfoResponse" - description: Transaction redirect request accepted - headers: - X-Request-ID: - $ref: "#/components/headers/X-Request-ID" + description: Action resolved successfully default: $ref: "#/components/responses/Error" - summary: Redirect Travel Rule Message + summary: Resolve action for a TRM tags: - TRLink x-rate-limit-category: write @@ -26826,27 +27643,27 @@ paths: code-samples: - language: typescript code: "const response: Promise>\ - \ = fireblocks.tRLink.redirectTRLinkTrm(tRLinkApiRedirectTRLinkTrmRequest);" + \ = fireblocks.tRLink.resolveActionTRLinkTrm(tRLinkApiResolveActionTRLinkTrmRequest);" name: Fireblocks SDK TypeScript example - language: java code: "CompletableFuture> response =\ - \ fireblocks.tRLink().redirectTRLinkTrm(tRLinkRedirectTrmRequest, customerIntegrationId,\ - \ trmId, idempotencyKey);" + \ fireblocks.tRLink().resolveActionTRLinkTrm(tRLinkResolveActionRequest,\ + \ customerIntegrationId, trmId, idempotencyKey);" name: Fireblocks SDK Java example - language: python - code: "response = fireblocks.t_r_link.redirect_t_r_link_trm(t_r_link_redirect_trm_request,\ + code: "response = fireblocks.t_r_link.resolve_action_t_r_link_trm(t_r_link_resolve_action_request,\ \ customer_integration_id, trm_id, idempotency_key);" name: Fireblocks SDK Python example x-codeSamples: - lang: TypeScript source: "const response: Promise>\ - \ = fireblocks.tRLink.redirectTRLinkTrm(tRLinkApiRedirectTRLinkTrmRequest);" + \ = fireblocks.tRLink.resolveActionTRLinkTrm(tRLinkApiResolveActionTRLinkTrmRequest);" - lang: Java source: "CompletableFuture> response =\ - \ fireblocks.tRLink().redirectTRLinkTrm(tRLinkRedirectTrmRequest, customerIntegrationId,\ - \ trmId, idempotencyKey);" + \ fireblocks.tRLink().resolveActionTRLinkTrm(tRLinkResolveActionRequest,\ + \ customerIntegrationId, trmId, idempotencyKey);" - lang: Python - source: "response = fireblocks.t_r_link.redirect_t_r_link_trm(t_r_link_redirect_trm_request,\ + source: "response = fireblocks.t_r_link.resolve_action_t_r_link_trm(t_r_link_resolve_action_request,\ \ customer_integration_id, trm_id, idempotency_key);" x-content-type: application/json x-accepts: @@ -27169,7 +27986,7 @@ paths: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getWorkspaceStatus responses: "200": @@ -27211,12 +28028,12 @@ paths: /tap/active_policy: get: description: "Legacy Endpoint – Returns the active policy and its validation.\ - \
\n**Note:** \n- This endpoint will remain available for the foreseeable\ - \ future and is not deprecated.
- The `getActivePolicy` endpoint under\ - \ policy/paths provides policy type-specific operations and improved functionality.
\ - \ - These endpoints are currently in beta and might be subject to changes.
\n\ - If you want to participate and learn more about the Fireblocks TAP, please\ - \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" + \ \n**Note:** \n- This endpoint will remain available for the foreseeable\ + \ future and is not deprecated. - The `getActivePolicy` endpoint under policy/paths\ + \ provides policy type-specific operations and improved functionality. - These\ + \ endpoints are currently in beta and might be subject to changes.\nIf you\ + \ want to participate and learn more about the Fireblocks TAP, please contact\ + \ your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" operationId: getActivePolicyLegacy responses: "200": @@ -27267,12 +28084,12 @@ paths: /tap/draft: get: description: "Legacy Endpoint – Returns the active draft and its validation.\ - \
\n**Note:** \n- This endpoint will remain available for the foreseeable\ - \ future and is not deprecated.
- The `getDraft` endpoint under policy/paths\ - \ provides policy type-specific operations and improved functionality.
\ - \ - These endpoints are currently in beta and might be subject to changes.
\n\ - If you want to participate and learn more about the Fireblocks TAP, please\ - \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" + \ \n**Note:** \n- This endpoint will remain available for the foreseeable\ + \ future and is not deprecated. - The `getDraft` endpoint under policy/paths\ + \ provides policy type-specific operations and improved functionality. - These\ + \ endpoints are currently in beta and might be subject to changes.\nIf you\ + \ want to participate and learn more about the Fireblocks TAP, please contact\ + \ your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" operationId: getDraftLegacy responses: "200": @@ -27322,10 +28139,10 @@ paths: - application/json post: description: "Legacy Endpoint – Send publish request of certain draft id and\ - \ returns the response.
\n**Note:** \n- This endpoint will remain available\ - \ for the foreseeable future and is not deprecated.
- The `publishDraft`\ - \ endpoint under policy/paths provides improved functionality and better performance.
\ - \ - These endpoints are currently in beta and might be subject to changes.
\n\ + \ returns the response. \n**Note:** \n- This endpoint will remain available\ + \ for the foreseeable future and is not deprecated. - The `publishDraft` endpoint\ + \ under policy/paths provides improved functionality and better performance.\ + \ - These endpoints are currently in beta and might be subject to changes.\n\ If you want to participate and learn more about the Fireblocks TAP, please\ \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" operationId: publishDraftLegacy @@ -27398,12 +28215,12 @@ paths: - application/json put: description: "Legacy Endpoint – Update the draft and return its validation.\ - \
\n**Note:** \n- This endpoint will remain available for the foreseeable\ - \ future and is not deprecated.
- The `updateDraft` endpoint under policy/paths\ - \ provides policy type-specific operations and improved functionality.
\ - \ - These endpoints are currently in beta and might be subject to changes.
\n\ - If you want to participate and learn more about the Fireblocks TAP, please\ - \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" + \ \n**Note:** \n- This endpoint will remain available for the foreseeable\ + \ future and is not deprecated. - The `updateDraft` endpoint under policy/paths\ + \ provides policy type-specific operations and improved functionality. - These\ + \ endpoints are currently in beta and might be subject to changes.\nIf you\ + \ want to participate and learn more about the Fireblocks TAP, please contact\ + \ your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n" operationId: updateDraftLegacy parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -27476,10 +28293,11 @@ paths: - application/json /tap/publish: post: - description: | - Send publish request of set of policy rules and returns the response.
- **Note:** These endpoints are currently in beta and might be subject to changes. - If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. + description: "Send publish request of set of policy rules and returns the response.\ + \ \n**Note:** These endpoints are currently in beta and might be subject to\ + \ changes.\nIf you want to participate and learn more about the Fireblocks\ + \ TAP, please contact your Fireblocks Customer Success Manager or send an\ + \ email to CSM@fireblocks.com.\n" operationId: publishPolicyRules parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -27616,9 +28434,9 @@ paths: - application/json /policy/draft: get: - description: | - Returns the active draft and its validation for a specific policy type.
- **Note:** These endpoints are currently in beta and might be subject to changes. + description: "Returns the active draft and its validation for a specific policy\ + \ type. \n**Note:** These endpoints are currently in beta and might be subject\ + \ to changes.\n" operationId: getDraft parameters: - description: "The policy type(s) to retrieve. Can be a single type or multiple\ @@ -27678,10 +28496,11 @@ paths: x-accepts: - application/json post: - description: | - Send publish request of certain draft id and returns the response.
- **Note:** These endpoints are currently in beta and might be subject to changes. - If you want to participate and learn more about the Fireblocks Policy Editor, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. + description: "Send publish request of certain draft id and returns the response.\ + \ \n**Note:** These endpoints are currently in beta and might be subject to\ + \ changes.\nIf you want to participate and learn more about the Fireblocks\ + \ Policy Editor, please contact your Fireblocks Customer Success Manager or\ + \ send an email to CSM@fireblocks.com.\n" operationId: publishDraft parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -27747,9 +28566,9 @@ paths: x-accepts: - application/json put: - description: | - Update the draft and return its validation for specific policy types.
- **Note:** These endpoints are currently in beta and might be subject to changes. + description: "Update the draft and return its validation for specific policy\ + \ types. \n**Note:** These endpoints are currently in beta and might be subject\ + \ to changes.\n" operationId: updateDraft parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -27823,7 +28642,7 @@ paths: description: |- Get console users for your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getConsoleUsers responses: "200": @@ -27904,7 +28723,7 @@ paths: Create console users in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following [guide](https://developers.fireblocks.com/docs/manage-users). -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: createConsoleUser parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -28006,7 +28825,7 @@ paths: description: |- List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getApiUsers responses: "200": @@ -28084,7 +28903,7 @@ paths: description: |- Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: createApiUser parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -28186,7 +29005,7 @@ paths: description: |- Resets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: resetDevice parameters: - description: The ID of the console user @@ -28281,7 +29100,7 @@ paths: description: |- Get a list of the whitelisted IP addresses for a specific API Key - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: getWhitelistIpAddresses parameters: - description: The ID of the api user @@ -28633,7 +29452,7 @@ paths: - application/json /smart-transfers/{ticketId}: get: - description: "Find Smart Transfer ticket by id.
Endpoint Permission: Admin,\ + description: "Find Smart Transfer ticket by id. Endpoint Permission: Admin,\ \ Non-Signing Admin, Signer, Approver, Editor, Viewer." operationId: findTicketById parameters: @@ -28693,7 +29512,7 @@ paths: - application/json /smart-transfers/{ticketId}/expires-in: put: - description: "Set expiration date on Smart Transfer ticket.
Endpoint Permission:\ + description: "Set expiration date on Smart Transfer ticket. Endpoint Permission:\ \ Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: setTicketExpiration parameters: @@ -28781,8 +29600,8 @@ paths: - application/json /smart-transfers/{ticketId}/external-id: put: - description: "Set external id Smart Transfer ticket.
Endpoint Permission:\ - \ Admin, Non-Signing Admin, Signer, Approver, Editor." + description: "Set external id Smart Transfer ticket. Endpoint Permission: Admin,\ + \ Non-Signing Admin, Signer, Approver, Editor." operationId: setExternalRefId parameters: - explode: false @@ -28870,7 +29689,7 @@ paths: /smart-transfers/{ticketId}/submit: put: description: "Submit Smart Transfer ticket - change status into ready for approval\ - \ if auto approval is not turned on, or OPEN if auto approval is on.
Endpoint\ + \ if auto approval is not turned on, or OPEN if auto approval is on. Endpoint\ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: submitTicket parameters: @@ -28959,7 +29778,7 @@ paths: /smart-transfers/{ticketId}/fulfill: put: description: "Manually fulfill ticket, in case when all terms (legs) are funded\ - \ manually.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver,\ + \ manually. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver,\ \ Editor." operationId: fulfillTicket parameters: @@ -29124,8 +29943,8 @@ paths: - application/json /smart-transfers/{ticketId}/cancel: put: - description: "Cancel Smart Transfer ticket.
Endpoint Permission: Admin,\ - \ Non-Signing Admin, Signer, Approver, Editor." + description: "Cancel Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing\ + \ Admin, Signer, Approver, Editor." operationId: cancelTicket parameters: - explode: false @@ -29204,7 +30023,7 @@ paths: description: "Creates new smart transfer ticket term (when the ticket status\ \ is DRAFT). Learn more about Fireblocks Smart Transfers in the following\ \ [guide](https://developers.fireblocks.com/docs/execute-smart-transfers).\ - \
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor." + \ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor." operationId: createTicketTerm parameters: - explode: false @@ -29346,7 +30165,7 @@ paths: x-accepts: - application/json get: - description: "Find a specific term of a specific Smart Transfer ticket.
Endpoint\ + description: "Find a specific term of a specific Smart Transfer ticket. Endpoint\ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer." operationId: findTicketTermById parameters: @@ -29503,8 +30322,8 @@ paths: /smart-transfers/{ticketId}/terms/{termId}/fund: put: description: "Set funding source for ticket term (in case of ASYNC tickets,\ - \ this will execute transfer immediately).
Endpoint Permission: Admin,\ - \ Non-Signing Admin, Signer, Approver, Editor." + \ this will execute transfer immediately). Endpoint Permission: Admin, Non-Signing\ + \ Admin, Signer, Approver, Editor." operationId: fundTicketTerm parameters: - explode: false @@ -29695,7 +30514,7 @@ paths: put: description: |- Manually set ticket term transaction. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: manuallyFundTicketTerm parameters: - explode: false @@ -29791,7 +30610,7 @@ paths: get: description: |- Get Smart Transfer user groups. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getSmartTransferUserGroups parameters: [] responses: @@ -29844,7 +30663,7 @@ paths: post: description: |- Set Smart Transfers user group to receive email notifications for Smart Transfers. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: setUserGroups parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -30446,7 +31265,7 @@ paths: description: |- Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: getCosigners parameters: - description: ASC / DESC ordering (default DESC) @@ -30527,7 +31346,7 @@ paths: post: description: |- Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: addCosigner parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -30595,7 +31414,7 @@ paths: description: |- Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: getCosigner parameters: - description: The unique identifier of the cosigner @@ -30648,7 +31467,7 @@ paths: description: |- Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: renameCosigner parameters: - description: The unique identifier of the cosigner @@ -30713,7 +31532,7 @@ paths: description: |- Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: getApiKeys parameters: - description: The unique identifier of the cosigner @@ -30807,7 +31626,7 @@ paths: delete: description: |- Unpair an API key from a cosigner -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: unpairApiKey parameters: - description: The unique identifier of the cosigner @@ -30875,7 +31694,7 @@ paths: description: |- Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: getApiKey parameters: - description: The unique identifier of the cosigner @@ -30938,7 +31757,7 @@ paths: patch: description: |- Update the callback handler of an API key -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: updateCallbackHandler parameters: - description: The unique identifier of the cosigner @@ -31016,7 +31835,7 @@ paths: put: description: |- Pair an API key to a cosigner -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: pairApiKey parameters: - description: The unique identifier of the cosigner @@ -31104,7 +31923,7 @@ paths: get: description: |- Get the status of an asynchronous request -
Endpoint Permission: Admin and Non-Signing Admin. + Endpoint Permission: Admin and Non-Signing Admin. operationId: getRequestStatus parameters: - description: The unique identifier of the cosigner @@ -31178,7 +31997,7 @@ paths: description: |- Returns a paginated list of unspent transaction outputs (UTXOs) for a UTXO-based asset in a vault account, with optional filters for labels, statuses, amounts, and more. **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getUtxos parameters: - description: The ID of the vault account @@ -31396,7 +32215,7 @@ paths: Attach or detach labels to/from UTXOs in a vault account. Labels can be used for organizing and filtering UTXOs. Labels are applied additively — `labelsToAttach` adds to the existing label set and `labelsToDetach` removes from it. Neither operation replaces the full set. **Note:** These endpoints are currently in beta and might be subject to changes. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. operationId: updateUtxoLabels parameters: - description: The ID of the vault account @@ -31485,7 +32304,7 @@ paths: description: |- Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: listLegalEntities parameters: - description: "The ID of the vault account. When provided, returns the legal\ @@ -31569,7 +32388,7 @@ paths: post: description: |- Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: registerLegalEntity parameters: - description: "A unique identifier for the request. If the request is sent\ @@ -31675,7 +32494,7 @@ paths: get: description: |- Returns details of a specific legal entity registration, including GLEIF data when available. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: getLegalEntity parameters: - description: The unique ID of the legal entity registration @@ -31739,7 +32558,7 @@ paths: put: description: |- Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: updateLegalEntity parameters: - description: The unique ID of the legal entity registration @@ -31835,7 +32654,7 @@ paths: get: description: |- Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. -
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. operationId: listVaultsForLegalEntity parameters: - description: The unique ID of the legal entity registration @@ -31922,7 +32741,7 @@ paths: post: description: |- Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. -
Endpoint Permission: Admin, Non-Signing Admin. + Endpoint Permission: Admin, Non-Signing Admin. operationId: assignVaultsToLegalEntity parameters: - description: The unique ID of the legal entity registration @@ -32612,21 +33431,20 @@ components: type: boolean vaultType: default: MPC - description: "Type of vault account. The default type will be set to MPC.
\ - \ If the workspace does not support the selected type, it will return\ - \ an error." + description: | + Type of vault account. The default type will be set to MPC. + If the workspace does not support the selected type, it will return an error. enum: - MPC - KEY_LINK type: string autoAssign: default: false - description: "Applicable only when the vault account type is KEY_LINK. For\ - \ MPC, this parameter will be ignored.
If set to true and there are\ - \ available keys, random keys will be assigned to the newly created vault\ - \ account.
If set to true and there are no available keys to be assigned,\ - \ it will return an error.
If set to false, the vault account will\ - \ be created without any keys." + description: | + Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored. + If set to true and there are available keys, random keys will be assigned to the newly created vault account. + If set to true and there are no available keys to be assigned, it will return an error. + If set to false, the vault account will be created without any keys. type: boolean type: object VaultAccountsPagedResponse: @@ -32937,6 +33755,68 @@ components: description: Auto Fuel type: boolean type: object + CircleGatewayWalletInfoResponse: + example: + walletId: b68a9e08-b59c-4ff9-893f-52d4f78c21e6 + symbol: USDC + assetIds: + - USDC + type: CIRCLEGATEWAY + status: ACTIVATED + properties: + walletId: + description: The Circle Gateway wallet identifier + example: b68a9e08-b59c-4ff9-893f-52d4f78c21e6 + type: string + type: + description: The Circle Gateway provider identifier + example: CIRCLEGATEWAY + type: string + status: + description: Current activation status of the Circle Gateway wallet + enum: + - ACTIVATED + - DEACTIVATED + example: ACTIVATED + type: string + symbol: + description: The token symbol supported by this wallet (e.g. USDC) + example: USDC + type: string + assetIds: + description: Fireblocks asset IDs available for this wallet + example: + - USDC + items: + type: string + type: array + required: + - assetIds + - status + - symbol + - type + - walletId + type: object + CircleGatewayWalletStatusResponse: + example: + walletId: b68a9e08-b59c-4ff9-893f-52d4f78c21e6 + status: ACTIVATED + properties: + walletId: + description: The Circle Gateway wallet identifier + example: b68a9e08-b59c-4ff9-893f-52d4f78c21e6 + type: string + status: + description: Current activation status of the Circle Gateway wallet + enum: + - ACTIVATED + - DEACTIVATED + example: ACTIVATED + type: string + required: + - status + - walletId + type: object CreateAssetsRequest: example: eosAccountName: eosAccountName @@ -33211,6 +34091,10 @@ components: type: object CreateMultipleVaultAccountsJobStatus: example: + approvalRequestId: "12345" + tagIds: + - a1b2c3d4-e5f6-7890-abcd-ef1234567890 + - b2c3d4e5-f6a7-8901-bcde-f12345678901 vaultAccounts: "0": BTC_TEST: bcrt1qs0zzqytuw49w2jqkmfhzgdh2lylzde2uw4zncz @@ -33219,6 +34103,8 @@ components: status: Success properties: status: + description: "Status of the job. Possible values - Success, In Progress,\ + \ Failed, Pending Approval, Cancelled" example: Success type: string vaultAccounts: @@ -33233,9 +34119,24 @@ components: BTC_TEST: bcrt1qs0zzqytuw49w2jqkmfhzgdh2lylzde2uw4zncz ETH_TEST: 0x460395Edb2338023c6f137259C6e20B6C37dDE95 type: object + tagIds: + description: List of tag IDs successfully attached to each of the created + vault accounts + example: + - a1b2c3d4-e5f6-7890-abcd-ef1234567890 + - b2c3d4e5-f6a7-8901-bcde-f12345678901 + items: + format: uuid + type: string + type: array errorMessage: example: Asset not supported type: string + approvalRequestId: + description: Approval request ID if the job has protected tags to attach + to the vault accounts + example: "12345" + type: string required: - status type: object @@ -33498,6 +34399,8 @@ components: status: Success properties: status: + description: "Status of the job. Possible values - Success, In Progress,\ + \ Failed" example: Success type: string addresses: @@ -35327,6 +36230,166 @@ components: required: - data type: object + CounterpartyGroup: + description: A counterparty group used to classify counterparties for compliance + and routing purposes + example: + createdAt: 2024-01-15T10:30:00Z + groupId: 44fcead0-7053-4831-a53a-df7fb90d440f + name: APAC Financial Partners + description: Group for all APAC-based financial institution counterparties + jurisdictionCodes: + - US + - SG + isActive: true + updatedAt: 2024-01-15T10:30:00Z + properties: + groupId: + description: Unique identifier of the counterparty group + example: 44fcead0-7053-4831-a53a-df7fb90d440f + format: uuid + type: string + name: + description: Human-readable name of the group + example: APAC Financial Partners + minLength: 1 + type: string + description: + description: Optional description of the group + example: Group for all APAC-based financial institution counterparties + type: string + jurisdictionCodes: + description: List of jurisdiction codes associated with the group + example: + - US + - SG + items: + type: string + type: array + isActive: + description: Whether the counterparty group is currently active + example: true + type: boolean + createdAt: + description: ISO 8601 timestamp when the group was created + example: 2024-01-15T10:30:00Z + format: date-time + type: string + updatedAt: + description: ISO 8601 timestamp when the group was last updated + example: 2024-01-15T10:30:00Z + format: date-time + type: string + required: + - createdAt + - groupId + - isActive + - name + - updatedAt + type: object + CounterpartyGroupsPaginatedResponse: + description: Paginated list of counterparty groups + example: + next: eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9 + total: 42 + data: + - createdAt: 2024-01-15T10:30:00Z + groupId: 44fcead0-7053-4831-a53a-df7fb90d440f + name: APAC Financial Partners + description: Group for all APAC-based financial institution counterparties + jurisdictionCodes: + - US + - SG + isActive: true + updatedAt: 2024-01-15T10:30:00Z + - createdAt: 2024-01-15T10:30:00Z + groupId: 44fcead0-7053-4831-a53a-df7fb90d440f + name: APAC Financial Partners + description: Group for all APAC-based financial institution counterparties + jurisdictionCodes: + - US + - SG + isActive: true + updatedAt: 2024-01-15T10:30:00Z + properties: + data: + description: The counterparty groups in the current page + items: + $ref: "#/components/schemas/CounterpartyGroup" + type: array + total: + description: Total number of counterparty groups + example: 42 + type: integer + next: + description: Cursor for the next page + example: eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9 + type: string + required: + - data + type: object + CreateCounterpartyGroupRequest: + description: Request body for creating a new counterparty group + example: + name: APAC Financial Partners + jurisdictionCodes: + - US + - SG + description: Group for all APAC-based financial institution counterparties + properties: + name: + description: Human-readable name of the group + example: APAC Financial Partners + minLength: 1 + type: string + jurisdictionCodes: + description: List of jurisdiction codes to associate with the group + example: + - US + - SG + items: + type: string + type: array + description: + description: Optional description of the group + example: Group for all APAC-based financial institution counterparties + type: string + required: + - jurisdictionCodes + - name + type: object + UpdateCounterpartyGroupRequest: + description: Request body for updating an existing counterparty group + example: + name: APAC Financial Partners + description: Group for all APAC-based financial institution counterparties + jurisdictionCodes: + - US + - SG + isActive: true + properties: + name: + description: Updated human-readable name of the group + example: APAC Financial Partners + minLength: 1 + type: string + description: + description: Updated description of the group + example: Group for all APAC-based financial institution counterparties + type: string + jurisdictionCodes: + description: Updated list of jurisdiction codes for the group + example: + - US + - SG + items: + type: string + type: array + isActive: + description: Whether the counterparty group should be active + example: true + type: boolean + type: object NetworkChannel: deprecated: true description: Deprecated in the only used reference - NetworkConnectionResponse @@ -36803,8 +37866,14 @@ components: - AIRTEL - MTN - TIGO + - WAVE example: MTN type: string + email: + description: The email address of the account holder + example: john.doe@example.com + format: email + type: string beneficiaryDocumentId: description: The document ID of the beneficiary example: GHA-123456789-0 @@ -36818,6 +37887,7 @@ components: - accountHolderSurname - addressingSystem - country + - email - mobilePhoneNumber - provider - rail @@ -46459,12 +47529,21 @@ components: status: $ref: "#/components/schemas/PayoutStatus" reasonOfFailure: - description: "
    \n
  • INSUFFICIENT_BALANCE
    • \n
  • SOURCE_TRANSLATION
    • \n\ -
  • SOURCE_NOT_UNIQUE
    • \n
  • SOURCE_NOT_FOUND
    • \n
  • SOURCE_TYPE_NOT_SUPPORTED
    • \n\ -
  • EMPTY_SOURCE
    • \n
  • DESTINATION_TRANSLATION
    • \n
  • DESTINATION_NOT_UNIQUE
    • \n\ -
  • DESTINATION_NOT_FOUND
    • \n
  • EMPTY_DESTINATION
    • \n
  • PARSING\ - \
    • \n
  • UNKNOWN
    • \n
  • FIREBLOCKS_CLIENT
    • \n
  • TRANSACTION_SUBMISSION
    • \n\ -
\n" + description: | + - INSUFFICIENT_BALANCE + - SOURCE_TRANSLATION + - SOURCE_NOT_UNIQUE + - SOURCE_NOT_FOUND + - SOURCE_TYPE_NOT_SUPPORTED + - EMPTY_SOURCE + - DESTINATION_TRANSLATION + - DESTINATION_NOT_UNIQUE + - DESTINATION_NOT_FOUND + - EMPTY_DESTINATION + - PARSING + - UNKNOWN + - FIREBLOCKS_CLIENT + - TRANSACTION_SUBMISSION type: string initMethod: $ref: "#/components/schemas/PayoutInitMethod" @@ -55377,6 +56456,8 @@ components: - MANTRA - MATIC - OSMO + - POL + - POL_TEST - SOL - SOL_TEST - STETH_ETH @@ -55614,10 +56695,12 @@ components: example: "withdraw request id b70701f4-d7b1-4795-a8ee-b09cdb5b850d #ETH" type: string amount: - description: "Amount of tokens to withdraw. Only supported for Cosmos chains\ - \ to enable partial withdrawals. For other chains, this field is ignored\ - \ and the entire available amount will be withdrawn. If not provided,\ - \ the entire available amount will be withdrawn." + description: "Amount of tokens to withdraw. Only supported for ETH compounding\ + \ validators (EIP-7251/Pectra) and Cosmos chains to enable partial withdrawals.\ + \ For ETH compounding validators, the remaining balance must be at least\ + \ 32 ETH after withdrawal. For other chains, this field is ignored and\ + \ the entire available amount will be withdrawn. If not provided, the\ + \ entire available amount will be withdrawn." example: "7" type: string required: @@ -58069,6 +59152,256 @@ components: - BUY - SELL type: string + PersonalEntityTypeEnum: + enum: + - INDIVIDUAL + type: string + ParticipantRelationshipType: + enum: + - FirstParty + - SecondParty + - ThirdParty + example: FirstParty + type: string + PostalAddress: + example: + streetName: Fifth Avenue + buildingNumber: "350" + postalCode: "10118" + city: New York + subdivision: NY + district: Manhattan + country: US + properties: + streetName: + type: string + buildingNumber: + type: string + postalCode: + type: string + city: + type: string + subdivision: + type: string + district: + type: string + country: + type: string + required: + - buildingNumber + - city + - country + - district + - postalCode + - streetName + - subdivision + type: object + PersonalIdentificationType: + description: "Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD':\ + \ National Identification Number (NIN) Slip Card - temporary identification\ + \ card issued in Nigeria - 'BVN': Bank Verification Number - unique identity\ + \ number for bank account holders in Nigeria - 'ID_CARD': General national\ + \ identity card - 'ID_BOOK': Identity book or booklet format identification\ + \ document - 'NATIONAL_ID': National identity document issued by government\ + \ authorities - 'ALIEN_CARD': Alien registration card for foreign nationals\ + \ - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD':\ + \ Economic Community of West African States identification card - 'RWANDA_CARD':\ + \ Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license\ + \ or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident\ + \ card - 'VOTER_ID': Voter identification card used for electoral registration\ + \ - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD':\ + \ Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID':\ + \ Refugee identification document - 'SSNIT': Social Security and National\ + \ Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID':\ + \ Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD':\ + \ National registration card issued by national registration authority" + enum: + - NIN_SLIP_CARD + - BVN + - ID_CARD + - ID_BOOK + - NATIONAL_ID + - ALIEN_CARD + - PASSPORT + - ECOWAS_CARD + - RWANDA_CARD + - DRIVERS_LICENSE + - RESIDENT_CARD + - VOTER_ID + - HEALTH_INSURANCE_ID + - GHANA_CARD + - REFUGEE_ID + - SSNIT + - NON_CITIZEN_ID + - NATIONAL_REGISTRATION_CARD + type: string + PersonalIdentification: + example: + externalReferenceId: person_ref_7f3e2d1c4b8a5e9f + entityType: INDIVIDUAL + participantRelationshipType: FirstParty + fullName: + firstName: Alexander + lastName: Johnson + dateOfBirth: 1985-03-15 + postalAddress: + streetName: Oak Street + buildingNumber: "742" + postalCode: "90210" + city: Beverly Hills + subdivision: CA + district: Los Angeles County + country: US + email: alexander.johnson@example.com + phone: "+14155551234" + idNumber: "12345678901" + idType: PASSPORT + additionalIdNumber: BVN987654321 + additionalIdType: BVN + properties: + externalReferenceId: + type: string + entityType: + $ref: "#/components/schemas/PersonalEntityTypeEnum" + participantRelationshipType: + $ref: "#/components/schemas/ParticipantRelationshipType" + fullName: + $ref: "#/components/schemas/PersonalIdentification_fullName" + dateOfBirth: + format: date + type: string + postalAddress: + $ref: "#/components/schemas/PostalAddress" + email: + format: email + type: string + phone: + description: Mobile phone number in E.164 format + example: "+14155551234" + pattern: "^\\+[1-9]\\d{1,14}$" + type: string + idNumber: + description: The identification number corresponding to the primary identification + document type specified in idType + type: string + idType: + $ref: "#/components/schemas/PersonalIdentificationType" + additionalIdNumber: + description: The identification number corresponding to the additional identification + document type specified in additionalIdType + type: string + additionalIdType: + $ref: "#/components/schemas/PersonalIdentificationType" + required: + - dateOfBirth + - entityType + - externalReferenceId + - fullName + - participantRelationshipType + - postalAddress + type: object + BusinessEntityTypeEnum: + enum: + - BUSINESS + type: string + BusinessIdentification: + example: + externalReferenceId: bus_ref_9f3e2d1c4b8a7e5f + entityType: BUSINESS + participantRelationshipType: COUNTERPARTY + businessName: TechCorp Solutions LLC + registrationNumber: TC-2023-001547 + email: techcorp@example.com + phone: "+14155551234" + postalAddress: + streetAddress: 789 Innovation Drive + city: San Francisco + state: CA + postalCode: "94105" + country: US + properties: + externalReferenceId: + type: string + entityType: + $ref: "#/components/schemas/BusinessEntityTypeEnum" + participantRelationshipType: + $ref: "#/components/schemas/ParticipantRelationshipType" + businessName: + type: string + registrationNumber: + type: string + postalAddress: + $ref: "#/components/schemas/PostalAddress" + email: + format: email + type: string + phone: + description: Mobile phone number in E.164 format + example: "+14155551234" + pattern: "^\\+[1-9]\\d{1,14}$" + type: string + required: + - businessName + - entityType + - externalReferenceId + - participantRelationshipType + - postalAddress + - registrationNumber + type: object + Identification: + discriminator: + mapping: + INDIVIDUAL: "#/components/schemas/PersonalIdentification" + BUSINESS: "#/components/schemas/BusinessIdentification" + propertyName: entityType + oneOf: + - $ref: "#/components/schemas/PersonalIdentification" + - $ref: "#/components/schemas/BusinessIdentification" + ParticipantsIdentification: + description: KYC/AML participant identification + example: + originator: + externalReferenceId: user_123456 + entityType: INDIVIDUAL + participantRelationshipType: FirstParty + fullName: + firstName: John + lastName: Smith + dateOfBirth: 1985-03-15 + email: john.smith@example.com + phone: "+14155551234" + postalAddress: + streetName: Main Street + buildingNumber: "123" + postalCode: "10001" + city: New York + subdivision: NY + district: Manhattan + country: US + beneficiary: + externalReferenceId: user_789012 + entityType: INDIVIDUAL + participantRelationshipType: ThirdParty + fullName: + firstName: Alice + lastName: Johnson + dateOfBirth: 1990-07-22 + email: alice.johnson@example.com + phone: "+14155551234" + postalAddress: + streetName: Broadway + buildingNumber: "456" + postalCode: "10002" + city: New York + subdivision: NY + district: Manhattan + country: US + properties: + originator: + $ref: "#/components/schemas/Identification" + beneficiary: + $ref: "#/components/schemas/Identification" + type: object CreateQuote: example: scope: @@ -58121,6 +59454,8 @@ components: $ref: "#/components/schemas/DVPSettlement" side: $ref: "#/components/schemas/Side" + participantsIdentification: + $ref: "#/components/schemas/ParticipantsIdentification" required: - baseAmount - baseAssetId @@ -58303,6 +59638,10 @@ components: expiresAt: description: The expiration time of the quote in ISO format. type: string + orderCreationRequirements: + description: | + A JSON Schema Draft-7 document in string format describing the fields required when creating an order for this quote. The schema mirrors the structure of CreateOrderRequest.participantsIdentification json schema, so clients can validate their order payload before sending. + type: string required: - baseAmount - baseAssetId @@ -58696,256 +60035,6 @@ components: oneOf: - $ref: "#/components/schemas/PrefundedSettlement" - $ref: "#/components/schemas/DVPSettlement" - PersonalEntityTypeEnum: - enum: - - INDIVIDUAL - type: string - ParticipantRelationshipType: - enum: - - FirstParty - - SecondParty - - ThirdParty - example: FirstParty - type: string - PostalAddress: - example: - streetName: Fifth Avenue - buildingNumber: "350" - postalCode: "10118" - city: New York - subdivision: NY - district: Manhattan - country: US - properties: - streetName: - type: string - buildingNumber: - type: string - postalCode: - type: string - city: - type: string - subdivision: - type: string - district: - type: string - country: - type: string - required: - - buildingNumber - - city - - country - - district - - postalCode - - streetName - - subdivision - type: object - PersonalIdentificationType: - description: "Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD':\ - \ National Identification Number (NIN) Slip Card - temporary identification\ - \ card issued in Nigeria - 'BVN': Bank Verification Number - unique identity\ - \ number for bank account holders in Nigeria - 'ID_CARD': General national\ - \ identity card - 'ID_BOOK': Identity book or booklet format identification\ - \ document - 'NATIONAL_ID': National identity document issued by government\ - \ authorities - 'ALIEN_CARD': Alien registration card for foreign nationals\ - \ - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD':\ - \ Economic Community of West African States identification card - 'RWANDA_CARD':\ - \ Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license\ - \ or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident\ - \ card - 'VOTER_ID': Voter identification card used for electoral registration\ - \ - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD':\ - \ Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID':\ - \ Refugee identification document - 'SSNIT': Social Security and National\ - \ Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID':\ - \ Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD':\ - \ National registration card issued by national registration authority" - enum: - - NIN_SLIP_CARD - - BVN - - ID_CARD - - ID_BOOK - - NATIONAL_ID - - ALIEN_CARD - - PASSPORT - - ECOWAS_CARD - - RWANDA_CARD - - DRIVERS_LICENSE - - RESIDENT_CARD - - VOTER_ID - - HEALTH_INSURANCE_ID - - GHANA_CARD - - REFUGEE_ID - - SSNIT - - NON_CITIZEN_ID - - NATIONAL_REGISTRATION_CARD - type: string - PersonalIdentification: - example: - externalReferenceId: person_ref_7f3e2d1c4b8a5e9f - entityType: INDIVIDUAL - participantRelationshipType: FirstParty - fullName: - firstName: Alexander - lastName: Johnson - dateOfBirth: 1985-03-15 - postalAddress: - streetName: Oak Street - buildingNumber: "742" - postalCode: "90210" - city: Beverly Hills - subdivision: CA - district: Los Angeles County - country: US - email: alexander.johnson@example.com - phone: "+14155551234" - idNumber: "12345678901" - idType: PASSPORT - additionalIdNumber: BVN987654321 - additionalIdType: BVN - properties: - externalReferenceId: - type: string - entityType: - $ref: "#/components/schemas/PersonalEntityTypeEnum" - participantRelationshipType: - $ref: "#/components/schemas/ParticipantRelationshipType" - fullName: - $ref: "#/components/schemas/PersonalIdentification_fullName" - dateOfBirth: - format: date - type: string - postalAddress: - $ref: "#/components/schemas/PostalAddress" - email: - format: email - type: string - phone: - description: Mobile phone number in E.164 format - example: "+14155551234" - pattern: "^\\+[1-9]\\d{1,14}$" - type: string - idNumber: - description: The identification number corresponding to the primary identification - document type specified in idType - type: string - idType: - $ref: "#/components/schemas/PersonalIdentificationType" - additionalIdNumber: - description: The identification number corresponding to the additional identification - document type specified in additionalIdType - type: string - additionalIdType: - $ref: "#/components/schemas/PersonalIdentificationType" - required: - - dateOfBirth - - entityType - - externalReferenceId - - fullName - - participantRelationshipType - - postalAddress - type: object - BusinessEntityTypeEnum: - enum: - - BUSINESS - type: string - BusinessIdentification: - example: - externalReferenceId: bus_ref_9f3e2d1c4b8a7e5f - entityType: BUSINESS - participantRelationshipType: COUNTERPARTY - businessName: TechCorp Solutions LLC - registrationNumber: TC-2023-001547 - email: techcorp@example.com - phone: "+14155551234" - postalAddress: - streetAddress: 789 Innovation Drive - city: San Francisco - state: CA - postalCode: "94105" - country: US - properties: - externalReferenceId: - type: string - entityType: - $ref: "#/components/schemas/BusinessEntityTypeEnum" - participantRelationshipType: - $ref: "#/components/schemas/ParticipantRelationshipType" - businessName: - type: string - registrationNumber: - type: string - postalAddress: - $ref: "#/components/schemas/PostalAddress" - email: - format: email - type: string - phone: - description: Mobile phone number in E.164 format - example: "+14155551234" - pattern: "^\\+[1-9]\\d{1,14}$" - type: string - required: - - businessName - - entityType - - externalReferenceId - - participantRelationshipType - - postalAddress - - registrationNumber - type: object - Identification: - discriminator: - mapping: - INDIVIDUAL: "#/components/schemas/PersonalIdentification" - BUSINESS: "#/components/schemas/BusinessIdentification" - propertyName: entityType - oneOf: - - $ref: "#/components/schemas/PersonalIdentification" - - $ref: "#/components/schemas/BusinessIdentification" - ParticipantsIdentification: - description: KYC/AML participant identification - example: - originator: - externalReferenceId: user_123456 - entityType: INDIVIDUAL - participantRelationshipType: FirstParty - fullName: - firstName: John - lastName: Smith - dateOfBirth: 1985-03-15 - email: john.smith@example.com - phone: "+14155551234" - postalAddress: - streetName: Main Street - buildingNumber: "123" - postalCode: "10001" - city: New York - subdivision: NY - district: Manhattan - country: US - beneficiary: - externalReferenceId: user_789012 - entityType: INDIVIDUAL - participantRelationshipType: ThirdParty - fullName: - firstName: Alice - lastName: Johnson - dateOfBirth: 1990-07-22 - email: alice.johnson@example.com - phone: "+14155551234" - postalAddress: - streetName: Broadway - buildingNumber: "456" - postalCode: "10002" - city: New York - subdivision: NY - district: Manhattan - country: US - properties: - originator: - $ref: "#/components/schemas/Identification" - beneficiary: - $ref: "#/components/schemas/Identification" - type: object CreateOrderRequest: example: via: @@ -69041,6 +70130,428 @@ components: required: - subsidiaryVaspId type: object + TRLinkManualDecisionAction: + description: Decision action for destinations in NoTRM status + enum: + - ACCEPT + - REJECT + example: ACCEPT + type: string + TRLinkManualDecisionRequest: + description: Request to manually accept or reject destinations stuck in NoTRM + status + example: + reason: Internal KYC approved + action: ACCEPT + properties: + action: + $ref: "#/components/schemas/TRLinkManualDecisionAction" + reason: + description: Optional reason for the manual decision (e.g. 'Internal KYC + approved'). Do not include PII. + example: Internal KYC approved + maxLength: 500 + type: string + required: + - action + type: object + TRLinkManualDecisionSource: + description: Source of the manual decision + enum: + - MANUAL + - POLICY + example: MANUAL + type: string + TRLinkManualDecisionDestinationDetail: + description: Per-destination result of the manual decision + example: + destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + properties: + destinationScreeningId: + description: Destination screening record ID + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + type: string + applied: + description: Whether the decision was applied to this destination + example: true + type: boolean + skipReason: + description: Reason if the destination was skipped + nullable: true + type: string + example: null + required: + - applied + - destinationScreeningId + type: object + TRLinkManualDecisionResponse: + description: Response containing the result of the manual decision + example: + destinationsSkipped: 0 + destinationsAffected: 2 + action: ACCEPT + txId: b70701f4-d7b1-4795-a8ee-b09cdb5b850e + details: + - destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + - destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + - destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + - destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + - destinationScreeningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + applied: true + skipReason: skipReason + source: MANUAL + properties: + action: + $ref: "#/components/schemas/TRLinkManualDecisionAction" + source: + $ref: "#/components/schemas/TRLinkManualDecisionSource" + txId: + description: Transaction ID + example: b70701f4-d7b1-4795-a8ee-b09cdb5b850e + type: string + destinationsAffected: + description: Number of destinations where the decision was applied + example: 2 + type: integer + destinationsSkipped: + description: Number of destinations that were skipped + example: 0 + type: integer + details: + description: Per-destination details + items: + $ref: "#/components/schemas/TRLinkManualDecisionDestinationDetail" + maxItems: 100 + minItems: 0 + type: array + required: + - action + - destinationsAffected + - destinationsSkipped + - details + - source + - txId + type: object + TRLinkRequiredField: + description: An IVMS101 field requirement with its type and path + example: + path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + properties: + type: + description: The person type for this field + example: naturalPerson + type: string + path: + description: IVMS101 field path + example: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: string + required: + - path + - type + type: object + TRLinkRequiredActionData: + description: | + Data describing what fields are required to resolve the action. + The structure varies by action type and is defined by the TRP provider. + + For UPLOAD_BENEFICIARY_PII action type: + Contains beneficiaryRequiredFields and/or originatorRequiredFields + listing the IVMS101 field paths that must be provided. + example: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + nullable: true + properties: + beneficiaryRequiredFields: + description: List of required beneficiary IVMS101 fields + items: + $ref: "#/components/schemas/TRLinkRequiredField" + maxItems: 30 + minItems: 0 + type: array + originatorRequiredFields: + description: List of required originator IVMS101 fields + items: + $ref: "#/components/schemas/TRLinkRequiredField" + maxItems: 30 + minItems: 0 + type: array + type: object + TRLinkRequiredAction: + description: A required action for processing the TRM + example: + data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + properties: + type: + description: "The action type identifier as defined by the Travel Rule provider.\ + \ Values are provider-specific and may vary across different TRP implementations,\ + \ so this field is intentionally not restricted to a fixed set of values." + example: UPLOAD_BENEFICIARY_PII + type: string + description: + description: Human-readable description of the action + example: Provide beneficiary PII fields to process the TR message + nullable: true + type: string + data: + $ref: "#/components/schemas/TRLinkRequiredActionData" + required: + - type + type: object + TRLinkGetRequiredActionsResponse: + description: Response containing the list of required actions for a TRM + example: + actions: + - data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + - data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + - data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + - data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + - data: + originatorRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + beneficiaryRequiredFields: + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + - path: "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier" + type: naturalPerson + description: Provide beneficiary PII fields to process the TR message + type: UPLOAD_BENEFICIARY_PII + properties: + actions: + description: List of required actions for the TRM + items: + $ref: "#/components/schemas/TRLinkRequiredAction" + maxItems: 10 + minItems: 0 + type: array + required: + - actions + type: object + TRLinkBeneficiaryPii: + description: Beneficiary PII data in IVMS101 format + example: + ivms101: + data: aGVsbG8gd29ybGQgdGhpcyBpcyBlbmNyeXB0ZWQgZGF0YQ== + filledFields: + - "Beneficiary.beneficiaryPersons[].legalPerson.name.nameIdentifier" + - "Beneficiary.beneficiaryPersons[].naturalPerson.name.nameIdentifier" + version: IVMS101.2023 + properties: + ivms101: + $ref: "#/components/schemas/TRLinkIvms" + required: + - ivms101 + type: object + TRLinkResolveActionData: + description: | + Data to submit when resolving an action. + The structure varies by action type and is validated by the TRP provider. + + For UPLOAD_BENEFICIARY_PII action type: + Contains beneficiaryPii with IVMS101-encoded PII data. + example: + beneficiaryPii: + ivms101: + data: aGVsbG8gd29ybGQgdGhpcyBpcyBlbmNyeXB0ZWQgZGF0YQ== + filledFields: + - "Beneficiary.beneficiaryPersons[].legalPerson.name.nameIdentifier" + - "Beneficiary.beneficiaryPersons[].naturalPerson.name.nameIdentifier" + version: IVMS101.2023 + nullable: true + properties: + beneficiaryPii: + $ref: "#/components/schemas/TRLinkBeneficiaryPii" + type: object + TRLinkResolveActionRequest: + description: Request to resolve a pending TRM action + example: + data: + beneficiaryPii: + ivms101: + data: aGVsbG8gd29ybGQgdGhpcyBpcyBlbmNyeXB0ZWQgZGF0YQ== + filledFields: + - "Beneficiary.beneficiaryPersons[].legalPerson.name.nameIdentifier" + - "Beneficiary.beneficiaryPersons[].naturalPerson.name.nameIdentifier" + version: IVMS101.2023 + type: UPLOAD_BENEFICIARY_PII + properties: + type: + description: The action type identifier as defined by the Travel Rule provider. + Must match one of the types returned by the get required actions endpoint. + Values are provider-specific and may vary across different TRP implementations. + example: UPLOAD_BENEFICIARY_PII + type: string + data: + $ref: "#/components/schemas/TRLinkResolveActionData" + required: + - type + type: object ScreeningPolicyAmountRange: description: Minimum and maximum amount range specification properties: @@ -69325,6 +70836,7 @@ components: - action type: object TRLinkMissingTrmAction-2: + description: TRLink missing TRM action enum: - WAIT - REJECT @@ -77810,6 +79322,16 @@ components: - $ref: "#/components/schemas/SolanaBlockchainData" - $ref: "#/components/schemas/EthereumBlockchainData" - $ref: "#/components/schemas/StEthBlockchainData" + PersonalIdentification_fullName: + properties: + firstName: + type: string + lastName: + type: string + required: + - firstName + - lastName + type: object CreateQuote_scope_inner: oneOf: - $ref: "#/components/schemas/ScopeItem" @@ -77822,16 +79344,6 @@ components: oneOf: - $ref: "#/components/schemas/MarketRequoteRequestDetails" - $ref: "#/components/schemas/RetryRequoteRequestDetails" - PersonalIdentification_fullName: - properties: - firstName: - type: string - lastName: - type: string - required: - - firstName - - lastName - type: object PaymentInstructions_oneOf: allOf: - $ref: "#/components/schemas/FiatDestination" diff --git a/build.gradle b/build.gradle index ff75a2e7..62baedca 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'com.diffplug.spotless' group = 'com.fireblocks.sdk' -version = '17.0.0' +version = '0.0.0' buildscript { repositories { diff --git a/docs/ApiUserApi.md b/docs/ApiUserApi.md index 1271017a..4f5f48c9 100644 --- a/docs/ApiUserApi.md +++ b/docs/ApiUserApi.md @@ -15,7 +15,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Create API Key -Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). </br>Endpoint Permission: Admin, Non-Signing Admin. +Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -103,7 +103,7 @@ No authorization required Get API Keys -List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/AuditLogsApi.md b/docs/AuditLogsApi.md index 2c235574..ac889baa 100644 --- a/docs/AuditLogsApi.md +++ b/docs/AuditLogsApi.md @@ -14,7 +14,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Get audit logs -Get Audit logs for the last Day/Week. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Get Audit logs for the last Day/Week. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/BlockchainsAssetsApi.md b/docs/BlockchainsAssetsApi.md index 78d261a2..8a3830fd 100644 --- a/docs/BlockchainsAssetsApi.md +++ b/docs/BlockchainsAssetsApi.md @@ -21,7 +21,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Get an asset -Returns an asset by ID or legacyID.</br> **Note**: - We will continue displaying and supporting the legacy ID (API ID). Since not all Fireblocks services fully support the new Assets UUID, please use only the legacy ID until further notice. +Returns an asset by ID or legacyID. **Note**: - We will continue displaying and supporting the legacy ID (API ID). Since not all Fireblocks services fully support the new Assets UUID, please use only the legacy ID until further notice. ### Example @@ -372,7 +372,7 @@ No authorization required List blockchains -Returns all blockchains supported by Fireblocks.</br> +Returns all blockchains supported by Fireblocks. ### Example diff --git a/docs/ChainDescriptor.md b/docs/ChainDescriptor.md index 268bdc18..215ac335 100644 --- a/docs/ChainDescriptor.md +++ b/docs/ChainDescriptor.md @@ -29,6 +29,10 @@ * `OSMO` (value: `"OSMO"`) +* `POL` (value: `"POL"`) + +* `POL_TEST` (value: `"POL_TEST"`) + * `SOL` (value: `"SOL"`) * `SOL_TEST` (value: `"SOL_TEST"`) diff --git a/docs/CircleGatewayWalletInfoResponse.md b/docs/CircleGatewayWalletInfoResponse.md new file mode 100644 index 00000000..0199e350 --- /dev/null +++ b/docs/CircleGatewayWalletInfoResponse.md @@ -0,0 +1,26 @@ + + +# CircleGatewayWalletInfoResponse + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**walletId** | **String** | The Circle Gateway wallet identifier | | +|**type** | **String** | The Circle Gateway provider identifier | | +|**status** | [**StatusEnum**](#StatusEnum) | Current activation status of the Circle Gateway wallet | | +|**symbol** | **String** | The token symbol supported by this wallet (e.g. USDC) | | +|**assetIds** | **List<String>** | Fireblocks asset IDs available for this wallet | | + + + +## Enum: StatusEnum + +| Name | Value | +|---- | -----| +| ACTIVATED | "ACTIVATED" | +| DEACTIVATED | "DEACTIVATED" | + + + diff --git a/docs/CircleGatewayWalletStatusResponse.md b/docs/CircleGatewayWalletStatusResponse.md new file mode 100644 index 00000000..47f70fde --- /dev/null +++ b/docs/CircleGatewayWalletStatusResponse.md @@ -0,0 +1,23 @@ + + +# CircleGatewayWalletStatusResponse + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**walletId** | **String** | The Circle Gateway wallet identifier | | +|**status** | [**StatusEnum**](#StatusEnum) | Current activation status of the Circle Gateway wallet | | + + + +## Enum: StatusEnum + +| Name | Value | +|---- | -----| +| ACTIVATED | "ACTIVATED" | +| DEACTIVATED | "DEACTIVATED" | + + + diff --git a/docs/ComplianceApi.md b/docs/ComplianceApi.md index 16053222..52fecc8b 100644 --- a/docs/ComplianceApi.md +++ b/docs/ComplianceApi.md @@ -7,19 +7,23 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | [**activateByorkConfig**](ComplianceApi.md#activateByorkConfig) | **POST** /screening/byork/config/activate | Activate BYORK Light | | [**addAddressRegistryVaultOptOuts**](ComplianceApi.md#addAddressRegistryVaultOptOuts) | **POST** /address_registry/vaults | Add vault accounts to the address registry opt-out list | | [**assignVaultsToLegalEntity**](ComplianceApi.md#assignVaultsToLegalEntity) | **POST** /legal_entities/{legalEntityId}/vaults | Assign vault accounts to a legal entity | +| [**createCounterpartyGroup**](ComplianceApi.md#createCounterpartyGroup) | **POST** /counterparty_groups | Create a counterparty group | | [**deactivateByorkConfig**](ComplianceApi.md#deactivateByorkConfig) | **POST** /screening/byork/config/deactivate | Deactivate BYORK Light | +| [**deleteCounterpartyGroup**](ComplianceApi.md#deleteCounterpartyGroup) | **DELETE** /counterparty_groups/{groupId} | Delete a counterparty group | | [**getAddressRegistryTenantParticipationStatus**](ComplianceApi.md#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry participation status for the authenticated workspace | | [**getAddressRegistryVaultOptOut**](ComplianceApi.md#getAddressRegistryVaultOptOut) | **GET** /address_registry/vaults/{vaultAccountId} | Get whether a vault account is opted out of the address registry | | [**getAmlPostScreeningPolicy**](ComplianceApi.md#getAmlPostScreeningPolicy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy | | [**getAmlScreeningPolicy**](ComplianceApi.md#getAmlScreeningPolicy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy | | [**getByorkConfig**](ComplianceApi.md#getByorkConfig) | **GET** /screening/byork/config | Get BYORK Light configuration | | [**getByorkVerdict**](ComplianceApi.md#getByorkVerdict) | **GET** /screening/byork/verdict | Get BYORK Light verdict | +| [**getCounterpartyGroup**](ComplianceApi.md#getCounterpartyGroup) | **GET** /counterparty_groups/{groupId} | Get a counterparty group | | [**getLegalEntity**](ComplianceApi.md#getLegalEntity) | **GET** /legal_entities/{legalEntityId} | Get a legal entity | | [**getLegalEntityForAddress**](ComplianceApi.md#getLegalEntityForAddress) | **GET** /address_registry/legal_entities/{address} | Look up legal entity by blockchain address | | [**getPostScreeningPolicy**](ComplianceApi.md#getPostScreeningPolicy) | **GET** /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy | | [**getScreeningFullDetails**](ComplianceApi.md#getScreeningFullDetails) | **GET** /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction. | | [**getScreeningPolicy**](ComplianceApi.md#getScreeningPolicy) | **GET** /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy | | [**listAddressRegistryVaultOptOuts**](ComplianceApi.md#listAddressRegistryVaultOptOuts) | **GET** /address_registry/vaults | List vault-level address registry opt-outs (paginated) | +| [**listCounterpartyGroups**](ComplianceApi.md#listCounterpartyGroups) | **GET** /counterparty_groups | List counterparty groups | | [**listLegalEntities**](ComplianceApi.md#listLegalEntities) | **GET** /legal_entities | List legal entities (Paginated) | | [**listVaultsForLegalEntity**](ComplianceApi.md#listVaultsForLegalEntity) | **GET** /legal_entities/{legalEntityId}/vaults | List vault accounts for a legal entity (Paginated) | | [**optInAddressRegistryTenant**](ComplianceApi.md#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt the workspace in to the address registry | @@ -32,6 +36,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | [**setByorkTimeouts**](ComplianceApi.md#setByorkTimeouts) | **PUT** /screening/byork/config/timeouts | Set BYORK Light timeouts | | [**setByorkVerdict**](ComplianceApi.md#setByorkVerdict) | **POST** /screening/byork/verdict | Set BYORK Light verdict | | [**updateAmlScreeningConfiguration**](ComplianceApi.md#updateAmlScreeningConfiguration) | **PUT** /screening/aml/policy_configuration | Update AML Configuration | +| [**updateCounterpartyGroup**](ComplianceApi.md#updateCounterpartyGroup) | **PATCH** /counterparty_groups/{groupId} | Update a counterparty group | | [**updateLegalEntity**](ComplianceApi.md#updateLegalEntity) | **PUT** /legal_entities/{legalEntityId} | Update legal entity | | [**updateScreeningConfiguration**](ComplianceApi.md#updateScreeningConfiguration) | **PUT** /screening/configurations | Tenant - Screening Configuration | | [**updateTravelRuleConfig**](ComplianceApi.md#updateTravelRuleConfig) | **PUT** /screening/travel_rule/policy_configuration | Update Travel Rule Configuration | @@ -214,7 +219,7 @@ No authorization required Assign vault accounts to a legal entity -Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. </br>Endpoint Permission: Admin, Non-Signing Admin. +Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -296,6 +301,91 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## createCounterpartyGroup + +> CompletableFuture> createCounterpartyGroup createCounterpartyGroup(createCounterpartyGroupRequest, idempotencyKey) + +Create a counterparty group + +Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.ComplianceApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + CreateCounterpartyGroupRequest createCounterpartyGroupRequest = new CreateCounterpartyGroupRequest(); // CreateCounterpartyGroupRequest | + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.compliance().createCounterpartyGroup(createCounterpartyGroupRequest, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling ComplianceApi#createCounterpartyGroup"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling ComplianceApi#createCounterpartyGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **createCounterpartyGroupRequest** | [**CreateCounterpartyGroupRequest**](CreateCounterpartyGroupRequest.md)| | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **201** | Counterparty group created successfully | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## deactivateByorkConfig > CompletableFuture> deactivateByorkConfig deactivateByorkConfig(idempotencyKey) @@ -380,6 +470,89 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## deleteCounterpartyGroup + +> CompletableFuture> deleteCounterpartyGroup deleteCounterpartyGroup(groupId) + +Delete a counterparty group + +Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.ComplianceApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + UUID groupId = UUID.randomUUID(); // UUID | The unique identifier of the counterparty group + try { + CompletableFuture> response = fireblocks.compliance().deleteCounterpartyGroup(groupId); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling ComplianceApi#deleteCounterpartyGroup"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling ComplianceApi#deleteCounterpartyGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **UUID**| The unique identifier of the counterparty group | | + +### Return type + + +CompletableFuture> + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Counterparty group deleted successfully | * X-Request-ID -
| +| **404** | Counterparty group not found | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## getAddressRegistryTenantParticipationStatus > CompletableFuture> getAddressRegistryTenantParticipationStatus getAddressRegistryTenantParticipationStatus() @@ -865,13 +1038,97 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## getCounterpartyGroup + +> CompletableFuture> getCounterpartyGroup getCounterpartyGroup(groupId) + +Get a counterparty group + +Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.ComplianceApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + UUID groupId = UUID.randomUUID(); // UUID | The unique identifier of the counterparty group + try { + CompletableFuture> response = fireblocks.compliance().getCounterpartyGroup(groupId); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling ComplianceApi#getCounterpartyGroup"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling ComplianceApi#getCounterpartyGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **UUID**| The unique identifier of the counterparty group | | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A counterparty group object | * X-Request-ID -
| +| **404** | Counterparty group not found | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## getLegalEntity > CompletableFuture> getLegalEntity getLegalEntity(legalEntityId) Get a legal entity -Returns details of a specific legal entity registration, including GLEIF data when available. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1361,13 +1618,98 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## listCounterpartyGroups + +> CompletableFuture> listCounterpartyGroups listCounterpartyGroups(pageCursor, pageSize) + +List counterparty groups + +Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.ComplianceApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + String pageCursor = "pageCursor_example"; // String | Cursor of the required page + Integer pageSize = 50; // Integer | Maximum number of items in the page + try { + CompletableFuture> response = fireblocks.compliance().listCounterpartyGroups(pageCursor, pageSize); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling ComplianceApi#listCounterpartyGroups"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling ComplianceApi#listCounterpartyGroups"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pageCursor** | **String**| Cursor of the required page | [optional] | +| **pageSize** | **Integer**| Maximum number of items in the page | [optional] [default to 50] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A paginated list of counterparty groups | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## listLegalEntities > CompletableFuture> listLegalEntities listLegalEntities(vaultAccountId, pageCursor, pageSize) List legal entities (Paginated) -Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1454,7 +1796,7 @@ No authorization required List vault accounts for a legal entity (Paginated) -Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1704,7 +2046,7 @@ No authorization required Register a new legal entity -Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. </br>Endpoint Permission: Admin, Non-Signing Admin. +Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -2380,13 +2722,101 @@ No authorization required | **200** | Configuration updated successfully. | - | +## updateCounterpartyGroup + +> CompletableFuture> updateCounterpartyGroup updateCounterpartyGroup(updateCounterpartyGroupRequest, groupId, idempotencyKey) + +Update a counterparty group + +Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.ComplianceApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + UpdateCounterpartyGroupRequest updateCounterpartyGroupRequest = new UpdateCounterpartyGroupRequest(); // UpdateCounterpartyGroupRequest | + UUID groupId = UUID.randomUUID(); // UUID | The unique identifier of the counterparty group + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.compliance().updateCounterpartyGroup(updateCounterpartyGroupRequest, groupId, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling ComplianceApi#updateCounterpartyGroup"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling ComplianceApi#updateCounterpartyGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **updateCounterpartyGroupRequest** | [**UpdateCounterpartyGroupRequest**](UpdateCounterpartyGroupRequest.md)| | | +| **groupId** | **UUID**| The unique identifier of the counterparty group | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Counterparty group updated successfully | * X-Request-ID -
| +| **404** | Counterparty group not found | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## updateLegalEntity > CompletableFuture> updateLegalEntity updateLegalEntity(updateLegalEntityRequest, legalEntityId, idempotencyKey) Update legal entity -Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. </br>Endpoint Permission: Admin, Non-Signing Admin. +Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/ConnectedAccountsBetaApi.md b/docs/ConnectedAccountsBetaApi.md index 5a5c01dd..4d89a1ed 100644 --- a/docs/ConnectedAccountsBetaApi.md +++ b/docs/ConnectedAccountsBetaApi.md @@ -20,7 +20,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Disconnect connected account -Disconnect a connected account by ID. </br> **Note**: - This endpoint is currently in beta and might be subject to changes. +Disconnect a connected account by ID. **Note**: - This endpoint is currently in beta and might be subject to changes. ### Example diff --git a/docs/ConsoleUserApi.md b/docs/ConsoleUserApi.md index 668d9c45..abd002ad 100644 --- a/docs/ConsoleUserApi.md +++ b/docs/ConsoleUserApi.md @@ -15,7 +15,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Create console user -Create console users in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following [guide](https://developers.fireblocks.com/docs/manage-users). </br>Endpoint Permission: Admin, Non-Signing Admin. +Create console users in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following [guide](https://developers.fireblocks.com/docs/manage-users). Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -103,7 +103,7 @@ No authorization required Get console users -Get console users for your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Get console users for your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/ContractInteractionsApi.md b/docs/ContractInteractionsApi.md index 57d08391..4d140f8e 100644 --- a/docs/ContractInteractionsApi.md +++ b/docs/ContractInteractionsApi.md @@ -196,7 +196,7 @@ No authorization required Return deployed contract's ABI -Return deployed contract's ABI by blockchain native asset id and contract address. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. +Return deployed contract's ABI by blockchain native asset id and contract address. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. ### Example @@ -283,7 +283,7 @@ No authorization required Get transaction receipt -Retrieve the transaction receipt by blockchain native asset ID and transaction hash > **Note** > This functionality is exclusively available for EVM (Ethereum Virtual Machine) compatible chains. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. +Retrieve the transaction receipt by blockchain native asset ID and transaction hash > **Note** > This functionality is exclusively available for EVM (Ethereum Virtual Machine) compatible chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. ### Example diff --git a/docs/ContractTemplatesApi.md b/docs/ContractTemplatesApi.md index d330766d..5b7ff8d1 100644 --- a/docs/ContractTemplatesApi.md +++ b/docs/ContractTemplatesApi.md @@ -362,7 +362,7 @@ No authorization required List all contract templates -Return minimal representation of all the contract templates available for the workspace. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Return minimal representation of all the contract templates available for the workspace. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example diff --git a/docs/ContractsApi.md b/docs/ContractsApi.md index 3f096c01..5d40c5d9 100644 --- a/docs/ContractsApi.md +++ b/docs/ContractsApi.md @@ -20,7 +20,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Add an asset to a whitelisted contract -Adds an asset to a whitelisted contract. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Adds an asset to a whitelisted contract. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -109,7 +109,7 @@ No authorization required Add a contract -Adds a contract to the workspace whitelist. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Adds a contract to the workspace whitelist. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -194,7 +194,7 @@ No authorization required Delete a contract -Deletes a contract by ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -276,7 +276,7 @@ No authorization required Delete an asset from a whitelisted contract -Deletes a whitelisted contract asset by ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Deletes a whitelisted contract asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -360,7 +360,7 @@ No authorization required Find a Specific Whitelisted Contract -Returns a whitelisted contract by Fireblocks Contract ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns a whitelisted contract by Fireblocks Contract ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -443,7 +443,7 @@ No authorization required Find a whitelisted contract's asset -Returns a whitelisted contract's asset by ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns a whitelisted contract's asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -528,7 +528,7 @@ No authorization required List Whitelisted Contracts -Gets a list of whitelisted contracts. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Gets a list of whitelisted contracts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example diff --git a/docs/CosignersBetaApi.md b/docs/CosignersBetaApi.md index 56d6f87e..bb3efd64 100644 --- a/docs/CosignersBetaApi.md +++ b/docs/CosignersBetaApi.md @@ -23,7 +23,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Add cosigner -Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired </br>Endpoint Permission: Admin and Non-Signing Admin. +Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -108,7 +108,7 @@ No authorization required Get API key -Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. +Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -193,7 +193,7 @@ No authorization required Get all API keys -Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. +Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -282,7 +282,7 @@ No authorization required Get cosigner -Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. +Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -365,7 +365,7 @@ No authorization required Get all cosigners -Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. +Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -452,7 +452,7 @@ No authorization required Get request status -Get the status of an asynchronous request </br>Endpoint Permission: Admin and Non-Signing Admin. +Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -539,7 +539,7 @@ No authorization required Pair API key -Pair an API key to a cosigner </br>Endpoint Permission: Admin and Non-Signing Admin. +Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -628,7 +628,7 @@ No authorization required Rename cosigner -Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. +Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -713,7 +713,7 @@ No authorization required Unpair API key -Unpair an API key from a cosigner </br>Endpoint Permission: Admin and Non-Signing Admin. +Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -798,7 +798,7 @@ No authorization required Update API key callback handler -Update the callback handler of an API key </br>Endpoint Permission: Admin and Non-Signing Admin. +Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. ### Example diff --git a/docs/CounterpartyGroup.md b/docs/CounterpartyGroup.md new file mode 100644 index 00000000..21cfde58 --- /dev/null +++ b/docs/CounterpartyGroup.md @@ -0,0 +1,20 @@ + + +# CounterpartyGroup + +A counterparty group used to classify counterparties for compliance and routing purposes + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Unique identifier of the counterparty group | | +|**name** | **String** | Human-readable name of the group | | +|**description** | **String** | Optional description of the group | [optional] | +|**jurisdictionCodes** | **List<String>** | List of jurisdiction codes associated with the group | [optional] | +|**isActive** | **Boolean** | Whether the counterparty group is currently active | | +|**createdAt** | **OffsetDateTime** | ISO 8601 timestamp when the group was created | | +|**updatedAt** | **OffsetDateTime** | ISO 8601 timestamp when the group was last updated | | + + + diff --git a/docs/CounterpartyGroupsPaginatedResponse.md b/docs/CounterpartyGroupsPaginatedResponse.md new file mode 100644 index 00000000..78dd9164 --- /dev/null +++ b/docs/CounterpartyGroupsPaginatedResponse.md @@ -0,0 +1,16 @@ + + +# CounterpartyGroupsPaginatedResponse + +Paginated list of counterparty groups + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**List<CounterpartyGroup>**](CounterpartyGroup.md) | The counterparty groups in the current page | | +|**total** | **Integer** | Total number of counterparty groups | [optional] | +|**next** | **String** | Cursor for the next page | [optional] | + + + diff --git a/docs/CreateCounterpartyGroupRequest.md b/docs/CreateCounterpartyGroupRequest.md new file mode 100644 index 00000000..dc890617 --- /dev/null +++ b/docs/CreateCounterpartyGroupRequest.md @@ -0,0 +1,16 @@ + + +# CreateCounterpartyGroupRequest + +Request body for creating a new counterparty group + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Human-readable name of the group | | +|**jurisdictionCodes** | **List<String>** | List of jurisdiction codes to associate with the group | | +|**description** | **String** | Optional description of the group | [optional] | + + + diff --git a/docs/CreateMultipleDepositAddressesJobStatus.md b/docs/CreateMultipleDepositAddressesJobStatus.md index c0e58fc9..f1ac3b57 100644 --- a/docs/CreateMultipleDepositAddressesJobStatus.md +++ b/docs/CreateMultipleDepositAddressesJobStatus.md @@ -7,7 +7,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**status** | **String** | | | +|**status** | **String** | Status of the job. Possible values - Success, In Progress, Failed | | |**addresses** | [**List<NewAddress>**](NewAddress.md) | | [optional] | |**errorMessage** | **String** | | [optional] | diff --git a/docs/CreateMultipleVaultAccountsJobStatus.md b/docs/CreateMultipleVaultAccountsJobStatus.md index 196d010f..10de9522 100644 --- a/docs/CreateMultipleVaultAccountsJobStatus.md +++ b/docs/CreateMultipleVaultAccountsJobStatus.md @@ -7,9 +7,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**status** | **String** | | | +|**status** | **String** | Status of the job. Possible values - Success, In Progress, Failed, Pending Approval, Cancelled | | |**vaultAccounts** | **Map<String, Map<String, String>>** | Mapping between VaultAccountId to a mapping of asset to address | [optional] | +|**tagIds** | **List<UUID>** | List of tag IDs successfully attached to each of the created vault accounts | [optional] | |**errorMessage** | **String** | | [optional] | +|**approvalRequestId** | **String** | Approval request ID if the job has protected tags to attach to the vault accounts | [optional] | diff --git a/docs/CreateQuote.md b/docs/CreateQuote.md index 257965dd..1e897424 100644 --- a/docs/CreateQuote.md +++ b/docs/CreateQuote.md @@ -16,6 +16,7 @@ |**slippageBps** | **BigDecimal** | Slippage tolerance in basis points (bps) for defi quotes - 1 is 0.01% and 10000 is 100% | [optional] | |**settlement** | [**DVPSettlement**](DVPSettlement.md) | | [optional] | |**side** | **Side** | | | +|**participantsIdentification** | [**ParticipantsIdentification**](ParticipantsIdentification.md) | | [optional] | diff --git a/docs/CreateVaultAccountRequest.md b/docs/CreateVaultAccountRequest.md index dd7f824e..906e2fa5 100644 --- a/docs/CreateVaultAccountRequest.md +++ b/docs/CreateVaultAccountRequest.md @@ -11,8 +11,8 @@ |**hiddenOnUI** | **Boolean** | Optional - if true, the created account and all related transactions will not be shown on Fireblocks console | [optional] | |**customerRefId** | **String** | Optional - Sets a customer reference ID | [optional] | |**autoFuel** | **Boolean** | Optional - Sets the autoFuel property of the vault account | [optional] | -|**vaultType** | [**VaultTypeEnum**](#VaultTypeEnum) | Type of vault account. The default type will be set to MPC.<br/> If the workspace does not support the selected type, it will return an error. | [optional] | -|**autoAssign** | **Boolean** | Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored.<br/> If set to true and there are available keys, random keys will be assigned to the newly created vault account.<br/> If set to true and there are no available keys to be assigned, it will return an error.<br/> If set to false, the vault account will be created without any keys. | [optional] | +|**vaultType** | [**VaultTypeEnum**](#VaultTypeEnum) | Type of vault account. The default type will be set to MPC. If the workspace does not support the selected type, it will return an error. | [optional] | +|**autoAssign** | **Boolean** | Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored. If set to true and there are available keys, random keys will be assigned to the newly created vault account. If set to true and there are no available keys to be assigned, it will return an error. If set to false, the vault account will be created without any keys. | [optional] | diff --git a/docs/ExchangeAccountsApi.md b/docs/ExchangeAccountsApi.md index 119ba386..29229b47 100644 --- a/docs/ExchangeAccountsApi.md +++ b/docs/ExchangeAccountsApi.md @@ -105,7 +105,7 @@ No authorization required Convert exchange account funds -Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). </br>Endpoint Permission: Admin, Non-Signing Admin. +Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -192,7 +192,7 @@ No authorization required Get a specific exchange account -Returns an exchange account by ID. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns an exchange account by ID. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -275,7 +275,7 @@ No authorization required Get an asset for an exchange account -Returns an asset for an exchange account. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns an asset for an exchange account. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -439,7 +439,7 @@ No authorization required List connected exchange accounts -Returns a list of the connected exchange accounts in your workspace. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns a list of the connected exchange accounts in your workspace. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -526,7 +526,7 @@ No authorization required Internal transfer for exchange accounts -Transfers funds between trading accounts under the same exchange account. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). </br>Endpoint Permission: Admin, Non-Signing Admin. +Transfers funds between trading accounts under the same exchange account. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/ExternalWalletsApi.md b/docs/ExternalWalletsApi.md index a2f04583..6fd948c5 100644 --- a/docs/ExternalWalletsApi.md +++ b/docs/ExternalWalletsApi.md @@ -21,7 +21,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Add an asset to an external wallet. -Adds an asset to an existing external wallet. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Adds an asset to an existing external wallet. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -110,7 +110,7 @@ No authorization required Create an external wallet -Creates a new external wallet with the requested name. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Creates a new external wallet with the requested name. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -195,7 +195,7 @@ No authorization required Delete an external wallet -Deletes an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Deletes an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -277,7 +277,7 @@ No authorization required Find an external wallet -Returns an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -360,7 +360,7 @@ No authorization required Get an asset from an external wallet -Returns an external wallet by wallet ID and asset ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns an external wallet by wallet ID and asset ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -445,7 +445,7 @@ No authorization required List external wallets -Gets a list of external wallets under the workspace. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Gets a list of external wallets under the workspace. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. - You cannot see the balance of the external wallet. - You cannot initiate transactions from an external wallet as the source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -524,7 +524,7 @@ No authorization required Delete an asset from an external wallet -Deletes an external wallet asset by ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Deletes an external wallet asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -608,7 +608,7 @@ No authorization required Set an AML customer reference ID for an external wallet -Sets an AML/KYT customer reference ID for the specific external wallet. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Sets an AML/KYT customer reference ID for the specific external wallet. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/FiatAccountsApi.md b/docs/FiatAccountsApi.md index 84af6a02..8fa3a979 100644 --- a/docs/FiatAccountsApi.md +++ b/docs/FiatAccountsApi.md @@ -104,7 +104,7 @@ No authorization required Find a specific fiat account -Returns a fiat account by ID. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns a fiat account by ID. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -187,7 +187,7 @@ No authorization required List fiat accounts -Returns all fiat accounts. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns all fiat accounts. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/GasStationsApi.md b/docs/GasStationsApi.md index 78dbf052..118d52f4 100644 --- a/docs/GasStationsApi.md +++ b/docs/GasStationsApi.md @@ -17,7 +17,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Get gas station settings by asset -Returns gas station settings and balances for a requested asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns gas station settings and balances for a requested asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -100,7 +100,7 @@ No authorization required Get gas station settings -Returns gas station settings and ETH balance. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns gas station settings and ETH balance. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -179,7 +179,7 @@ No authorization required Edit gas station settings -Configures gas station settings for ETH. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Configures gas station settings for ETH. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -264,7 +264,7 @@ No authorization required Edit gas station settings for an asset -Configures gas station settings for a requested asset. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Configures gas station settings for a requested asset. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/MomoPaymentInfo.md b/docs/MomoPaymentInfo.md index ab31e247..317b84b8 100644 --- a/docs/MomoPaymentInfo.md +++ b/docs/MomoPaymentInfo.md @@ -15,6 +15,7 @@ Mobile Money (MOMO) payment information for African mobile payment services |**country** | **String** | The country for the transfer (ISO 3166-1 alpha-2 code) | | |**mobilePhoneNumber** | **String** | The mobile phone number associated with the mobile money account | | |**provider** | [**ProviderEnum**](#ProviderEnum) | The mobile money service provider | | +|**email** | **String** | The email address of the account holder | | |**beneficiaryDocumentId** | **String** | The document ID of the beneficiary | [optional] | |**beneficiaryRelationship** | **String** | The relationship between sender and beneficiary | [optional] | @@ -44,6 +45,7 @@ Mobile Money (MOMO) payment information for African mobile payment services | AIRTEL | "AIRTEL" | | MTN | "MTN" | | TIGO | "TIGO" | +| WAVE | "WAVE" | diff --git a/docs/NftsApi.md b/docs/NftsApi.md index 890f09af..dd3858e4 100644 --- a/docs/NftsApi.md +++ b/docs/NftsApi.md @@ -582,7 +582,7 @@ No authorization required Refresh vault account tokens -Updates all tokens and balances per blockchain and vault account. Learn more about Fireblocks NFT management in the following [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Updates all tokens and balances per blockchain and vault account. Learn more about Fireblocks NFT management in the following [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/OffExchangesApi.md b/docs/OffExchangesApi.md index f6ee4ca1..5b82aba8 100644 --- a/docs/OffExchangesApi.md +++ b/docs/OffExchangesApi.md @@ -18,7 +18,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Add Collateral -Add collateral and create deposit request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Add collateral and create deposit request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -103,7 +103,7 @@ No authorization required Find a specific collateral exchange account -Returns a collateral account by mainExchangeAccountId. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns a collateral account by mainExchangeAccountId. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -186,7 +186,7 @@ No authorization required Get Settlements Transactions -Get settlements transactions from exchange. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Get settlements transactions from exchange. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -269,7 +269,7 @@ No authorization required Remove Collateral -Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -354,7 +354,7 @@ No authorization required Create Settlement for a Trader -Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/PaymentsPayoutApi.md b/docs/PaymentsPayoutApi.md index 61251b0e..1336a883 100644 --- a/docs/PaymentsPayoutApi.md +++ b/docs/PaymentsPayoutApi.md @@ -16,7 +16,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Create a payout instruction set -**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. </br> </br>These endpoints are currently in beta and might be subject to changes.</br> </br>If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. </br> </br> <b u>Create a payout instruction set.</b> </u></br> A payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts. </br> The instruction set defines: </br> <ul> <li>the payment account and its account type (vault, exchange, or fiat). </li> <li>the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account.</li> </ul> Learn more about Fireblocks Payments - Payouts in the following [guide](https://developers.fireblocks.com/docs/create-payouts). </br>Endpoint Permission: Admin, Non-Signing Admin. +**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. These endpoints are currently in beta and might be subject to changes. If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. **Create a payout instruction set.** A payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts. The instruction set defines: - the payment account and its account type (vault, exchange, or fiat). - the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account. Learn more about Fireblocks Payments - Payouts in the following [guide](https://developers.fireblocks.com/docs/create-payouts). Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -103,7 +103,7 @@ No authorization required Execute a payout instruction set -**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. </br> </br>These endpoints are currently in beta and might be subject to changes.</br> </br>If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. </br> </br><b u>Execute a payout instruction set.</b> </u> </br> </br>The instruction set will be verified and executed.</br> <b><u>Source locking</br></b> </u> If you are executing a payout instruction set from a payment account with an already active payout the active payout will complete before the new payout instruction set can be executed. </br> You cannot execute the same payout instruction set more than once. +**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. These endpoints are currently in beta and might be subject to changes. If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. **Execute a payout instruction set.** The instruction set will be verified and executed. **Source locking** If you are executing a payout instruction set from a payment account with an already active payout the active payout will complete before the new payout instruction set can be executed. You cannot execute the same payout instruction set more than once. ### Example @@ -190,7 +190,7 @@ No authorization required Get the status of a payout instruction set -**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. </br> </br>These endpoints are currently in beta and might be subject to changes.</br> </br>If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. </br> </br>Endpoint Permission: Admin, Non-Signing Admin. +**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. These endpoints are currently in beta and might be subject to changes. If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/PayoutResponse.md b/docs/PayoutResponse.md index fc723455..59e2e309 100644 --- a/docs/PayoutResponse.md +++ b/docs/PayoutResponse.md @@ -12,7 +12,7 @@ |**createdAt** | **BigDecimal** | | | |**state** | **PayoutState** | | | |**status** | **PayoutStatus** | | | -|**reasonOfFailure** | **String** | <ul> <li> INSUFFICIENT_BALANCE</li> <li> SOURCE_TRANSLATION</li> <li> SOURCE_NOT_UNIQUE</li> <li> SOURCE_NOT_FOUND</li> <li> SOURCE_TYPE_NOT_SUPPORTED</li> <li> EMPTY_SOURCE</li> <li> DESTINATION_TRANSLATION</li> <li> DESTINATION_NOT_UNIQUE</li> <li> DESTINATION_NOT_FOUND</li> <li> EMPTY_DESTINATION</li> <li> PARSING </li> <li> UNKNOWN</li> <li> FIREBLOCKS_CLIENT</li> <li> TRANSACTION_SUBMISSION</li> </ul> | [optional] | +|**reasonOfFailure** | **String** | - INSUFFICIENT_BALANCE - SOURCE_TRANSLATION - SOURCE_NOT_UNIQUE - SOURCE_NOT_FOUND - SOURCE_TYPE_NOT_SUPPORTED - EMPTY_SOURCE - DESTINATION_TRANSLATION - DESTINATION_NOT_UNIQUE - DESTINATION_NOT_FOUND - EMPTY_DESTINATION - PARSING - UNKNOWN - FIREBLOCKS_CLIENT - TRANSACTION_SUBMISSION | [optional] | |**initMethod** | **PayoutInitMethod** | | [optional] | |**instructionSet** | [**List<PayoutInstructionResponse>**](PayoutInstructionResponse.md) | | | |**reportUrl** | **String** | | [optional] | diff --git a/docs/PolicyEditorBetaApi.md b/docs/PolicyEditorBetaApi.md index 62b3e07c..dfb37a82 100644 --- a/docs/PolicyEditorBetaApi.md +++ b/docs/PolicyEditorBetaApi.md @@ -18,7 +18,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Get the active policy and its validation -Legacy Endpoint – Returns the active policy and its validation. </br> **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated.</br> - The `getActivePolicy` endpoint under policy/paths provides policy type-specific operations and improved functionality.</br> - These endpoints are currently in beta and might be subject to changes.</br> If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Legacy Endpoint – Returns the active policy and its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `getActivePolicy` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example @@ -97,7 +97,7 @@ No authorization required Get the active draft -Legacy Endpoint – Returns the active draft and its validation. </br> **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated.</br> - The `getDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality.</br> - These endpoints are currently in beta and might be subject to changes.</br> If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Legacy Endpoint – Returns the active draft and its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `getDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example @@ -176,7 +176,7 @@ No authorization required Send publish request for a certain draft id -Legacy Endpoint – Send publish request of certain draft id and returns the response. </br> **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated.</br> - The `publishDraft` endpoint under policy/paths provides improved functionality and better performance.</br> - These endpoints are currently in beta and might be subject to changes.</br> If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Legacy Endpoint – Send publish request of certain draft id and returns the response. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `publishDraft` endpoint under policy/paths provides improved functionality and better performance. - These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example @@ -261,7 +261,7 @@ No authorization required Send publish request for a set of policy rules -Send publish request of set of policy rules and returns the response. </br> **Note:** These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Send publish request of set of policy rules and returns the response. **Note:** These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example @@ -346,7 +346,7 @@ No authorization required Update the draft with a new set of rules -Legacy Endpoint – Update the draft and return its validation. </br> **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated.</br> - The `updateDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality.</br> - These endpoints are currently in beta and might be subject to changes.</br> If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Legacy Endpoint – Update the draft and return its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `updateDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example diff --git a/docs/PolicyEditorV2BetaApi.md b/docs/PolicyEditorV2BetaApi.md index 9f208e43..52db0833 100644 --- a/docs/PolicyEditorV2BetaApi.md +++ b/docs/PolicyEditorV2BetaApi.md @@ -100,7 +100,7 @@ No authorization required Get the active draft by policy type -Returns the active draft and its validation for a specific policy type. </br> **Note:** These endpoints are currently in beta and might be subject to changes. +Returns the active draft and its validation for a specific policy type. **Note:** These endpoints are currently in beta and might be subject to changes. ### Example @@ -183,7 +183,7 @@ No authorization required Send publish request for a certain draft id -Send publish request of certain draft id and returns the response. </br> **Note:** These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Policy Editor, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. +Send publish request of certain draft id and returns the response. **Note:** These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Policy Editor, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. ### Example @@ -268,7 +268,7 @@ No authorization required Update the draft with a new set of rules by policy types -Update the draft and return its validation for specific policy types. </br> **Note:** These endpoints are currently in beta and might be subject to changes. +Update the draft and return its validation for specific policy types. **Note:** These endpoints are currently in beta and might be subject to changes. ### Example diff --git a/docs/Quote.md b/docs/Quote.md index 19410085..9db14aa9 100644 --- a/docs/Quote.md +++ b/docs/Quote.md @@ -19,6 +19,7 @@ |**generalFees** | [**List<Fee>**](Fee.md) | | [optional] | |**side** | **Side** | | | |**expiresAt** | **String** | The expiration time of the quote in ISO format. | | +|**orderCreationRequirements** | **String** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order for this quote. The schema mirrors the structure of CreateOrderRequest.participantsIdentification json schema, so clients can validate their order payload before sending. | [optional] | |**type** | **IndicativeQuoteEnum** | | | diff --git a/docs/QuotePropertiesDetails.md b/docs/QuotePropertiesDetails.md index cf9db983..cf8ccc73 100644 --- a/docs/QuotePropertiesDetails.md +++ b/docs/QuotePropertiesDetails.md @@ -19,6 +19,7 @@ |**generalFees** | [**List<Fee>**](Fee.md) | | [optional] | |**side** | **Side** | | | |**expiresAt** | **String** | The expiration time of the quote in ISO format. | | +|**orderCreationRequirements** | **String** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order for this quote. The schema mirrors the structure of CreateOrderRequest.participantsIdentification json schema, so clients can validate their order payload before sending. | [optional] | diff --git a/docs/ResetDeviceApi.md b/docs/ResetDeviceApi.md index 8c2519a0..58c6191a 100644 --- a/docs/ResetDeviceApi.md +++ b/docs/ResetDeviceApi.md @@ -14,7 +14,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Resets device -Resets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Resets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/SmartTransferApi.md b/docs/SmartTransferApi.md index 6ef04cac..37071039 100644 --- a/docs/SmartTransferApi.md +++ b/docs/SmartTransferApi.md @@ -123,7 +123,7 @@ No authorization required Cancel Ticket -Cancel Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Cancel Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -296,7 +296,7 @@ No authorization required Create leg (term) -Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about Fireblocks Smart Transfers in the following [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about Fireblocks Smart Transfers in the following [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -384,7 +384,7 @@ No authorization required Search Ticket by ID -Find Smart Transfer ticket by id. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Find Smart Transfer ticket by id. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -468,7 +468,7 @@ No authorization required Get Smart Transfer ticket term -Find a specific term of a specific Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Find a specific term of a specific Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -554,7 +554,7 @@ No authorization required Fund ticket manually -Manually fulfill ticket, in case when all terms (legs) are funded manually. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Manually fulfill ticket, in case when all terms (legs) are funded manually. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -730,7 +730,7 @@ No authorization required Define funding source -Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer immediately). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer immediately). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -901,7 +901,7 @@ No authorization required Get user group -Get Smart Transfer user groups. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get Smart Transfer user groups. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -981,7 +981,7 @@ No authorization required Manually add term transaction -Manually set ticket term transaction. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Manually set ticket term transaction. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -1262,7 +1262,7 @@ No authorization required Add external ref. ID -Set external id Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Set external id Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -1351,7 +1351,7 @@ No authorization required Set expiration -Set expiration date on Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Set expiration date on Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -1440,7 +1440,7 @@ No authorization required Set user group -Set Smart Transfers user group to receive email notifications for Smart Transfers. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Set Smart Transfers user group to receive email notifications for Smart Transfers. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -1526,7 +1526,7 @@ No authorization required Submit ticket -Submit Smart Transfer ticket - change status into ready for approval if auto approval is not turned on, or OPEN if auto approval is on. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Submit Smart Transfer ticket - change status into ready for approval if auto approval is not turned on, or OPEN if auto approval is on. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/StakingApi.md b/docs/StakingApi.md index 9a922f36..877b9628 100644 --- a/docs/StakingApi.md +++ b/docs/StakingApi.md @@ -118,7 +118,7 @@ No authorization required Claim accrued rewards -Claims available staking rewards for the specified chain and vault. Supported chains: Solana and Polygon (Matic). Behavior depends on protocol reward distribution. +Claims available staking rewards for the specified chain and vault. Supported chains: Solana and Polygon (POL/Matic). Behavior depends on protocol reward distribution. ### Example @@ -144,7 +144,7 @@ public class Example { Fireblocks fireblocks = new Fireblocks(configurationOptions); ClaimRewardsRequest claimRewardsRequest = new ClaimRewardsRequest(); // ClaimRewardsRequest | - String chainDescriptor = "SOL"; // String | Protocol identifier for the claim rewards staking operation (e.g., MATIC/SOL). + String chainDescriptor = "SOL"; // String | Protocol identifier for the claim rewards staking operation (e.g., POL/MATIC/SOL). String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. try { CompletableFuture> response = fireblocks.staking().claimRewards(claimRewardsRequest, chainDescriptor, idempotencyKey); @@ -174,7 +174,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **claimRewardsRequest** | [**ClaimRewardsRequest**](ClaimRewardsRequest.md)| | | -| **chainDescriptor** | **String**| Protocol identifier for the claim rewards staking operation (e.g., MATIC/SOL). | [enum: SOL, SOL_TEST, MATIC] | +| **chainDescriptor** | **String**| Protocol identifier for the claim rewards staking operation (e.g., POL/MATIC/SOL). | [enum: SOL, SOL_TEST, MATIC, POL, POL_TEST] | | **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | ### Return type @@ -209,7 +209,7 @@ No authorization required Consolidate staking positions (ETH validator consolidation) -Consolidates the source staking position into the destination, merging the balance into the destination and closing the source position once complete. Both positions must be from the same funding vaults account (i.e. same withdrawals credentials). On chain, this translates into a consolidation transaction, where the source validator is consolidated into the destination validator. Supported chains: Ethereum (ETH) only. </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. **Note:** This endpoint is currently in beta and might be subject to changes. +Consolidates the source staking position into the destination, merging the balance into the destination and closing the source position once complete. Both positions must be from the same vault account (i.e. same withdrawal credentials). On chain, this translates into a consolidation transaction, where the source validator is consolidated into the destination validator. Supported chains: Ethereum (ETH) only. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. **Note:** This endpoint is currently in beta and might be subject to changes. ### Example @@ -301,7 +301,7 @@ No authorization required List staking positions -Returns all staking positions with core details: amounts, rewards, status, chain, and vault. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns all staking positions with core details: amounts, rewards, status, chain, and vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -326,7 +326,7 @@ public class Example { .secretKey("my-secret-key"); Fireblocks fireblocks = new Fireblocks(configurationOptions); - ChainDescriptor chainDescriptor = ChainDescriptor.fromValue("ATOM_COS"); // ChainDescriptor | Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. + ChainDescriptor chainDescriptor = ChainDescriptor.fromValue("ATOM_COS"); // ChainDescriptor | Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). If omitted, positions across all supported chains are returned. String vaultAccountId = "1"; // String | Filter positions by vault account ID. try { CompletableFuture>> response = fireblocks.staking().getAllDelegations(chainDescriptor, vaultAccountId); @@ -356,7 +356,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. | [optional] [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). If omitted, positions across all supported chains are returned. | [optional] [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | | **vaultAccountId** | **String**| Filter positions by vault account ID. | [optional] | ### Return type @@ -445,7 +445,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the chain info staking operation (e.g., ETH/MATIC/SOL). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the chain info staking operation (e.g., ETH/MATIC/SOL). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | ### Return type @@ -479,7 +479,7 @@ No authorization required List supported staking chains -Returns an alphabetical list of blockchains supported for staking by the current workspace context. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns an alphabetical list of blockchains supported for staking by the current workspace context. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -650,7 +650,7 @@ No authorization required List staking positions (Paginated) -Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -676,7 +676,7 @@ public class Example { Fireblocks fireblocks = new Fireblocks(configurationOptions); Integer pageSize = 10; // Integer | Number of results per page. When provided, the response returns a paginated object with {data, next}. If omitted, all results are returned as an array. - ChainDescriptor chainDescriptor = ChainDescriptor.fromValue("ATOM_COS"); // ChainDescriptor | Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. + ChainDescriptor chainDescriptor = ChainDescriptor.fromValue("ATOM_COS"); // ChainDescriptor | Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). If omitted, positions across all supported chains are returned. String vaultAccountId = "10"; // String | Filter positions by Fireblocks vault account ID. If omitted, positions across all vault accounts are returned. String pageCursor = "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"; // String | Cursor for the next page of results. Use the value from the 'next' field in the previous response. String order = "ASC"; // String | ASC / DESC ordering (default DESC) @@ -709,7 +709,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **pageSize** | **Integer**| Number of results per page. When provided, the response returns a paginated object with {data, next}. If omitted, all results are returned as an array. | [default to 10] | -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. | [optional] [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). If omitted, positions across all supported chains are returned. | [optional] [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | | **vaultAccountId** | **String**| Filter positions by Fireblocks vault account ID. If omitted, positions across all vault accounts are returned. | [optional] | | **pageCursor** | **String**| Cursor for the next page of results. Use the value from the 'next' field in the previous response. | [optional] | | **order** | **String**| ASC / DESC ordering (default DESC) | [optional] [default to DESC] [enum: ASC, DESC] | @@ -746,7 +746,7 @@ No authorization required List staking providers -Returns all available staking providers with metadata such as name, ID, and supported chains. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Returns all available staking providers with metadata such as name, ID, and supported chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -995,7 +995,7 @@ No authorization required Merge staking positions -Merges the source stake account into the destination, consolidating the balance into the destination and closing the source account once complete. Both accounts must be from the same validator provider and of same vault account.. Supported chains: Solana (SOL). </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. +Merges the source stake account into the destination, consolidating the balance into the destination and closing the source account once complete. Both accounts must be from the same validator provider and of same vault account.. Supported chains: Solana (SOL). Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -1179,7 +1179,7 @@ No authorization required Initiate or add to existing stake -Creates a new staking position and returns its unique ID. For Ethereum compounding validator (EIP-7251): when the 'id' of an existing compounding validator position is provided, adds to that position; otherwise creates a new position. For Ethereum legacy validator: creates a new position regardless of existing delegations. For Cosmos chains and Ethereum liquid staking (Lido): automatically add to existing positions for the same validator provider and same vault account if one exists, otherwise create a new position. For Solana and Polygon: always create new positions regardless of existing delegations. +Creates a new staking position and returns its unique ID. For Ethereum compounding validator (EIP-7251): when the 'id' of an existing compounding validator position is provided, adds to that position; otherwise creates a new position. For Ethereum legacy validator: creates a new position regardless of existing delegations. For Cosmos chains and Ethereum liquid staking (Lido): automatically add to existing positions for the same validator provider and same vault account if one exists, otherwise create a new position. For Solana and Polygon (MATIC/POL): always create new positions regardless of existing delegations. ### Example @@ -1236,7 +1236,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **stakeRequest** | [**StakeRequest**](StakeRequest.md)| | | -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the stake staking operation (e.g., ATOM_COS/AXL/CELESTIA). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the stake staking operation (e.g., ATOM_COS/AXL/CELESTIA). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | | **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | ### Return type @@ -1327,7 +1327,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **unstakeRequest** | [**UnstakeRequest**](UnstakeRequest.md)| | | -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the unstake staking operation (e.g., SOL/SOL_TEST/MATIC). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the unstake staking operation (e.g., SOL/SOL_TEST/MATIC). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | | **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | ### Return type @@ -1362,7 +1362,7 @@ No authorization required Withdraw staked funds -Withdraws funds that have completed the unbonding period. Typically requires the position to be deactivated first (unstake → unbond → withdraw). Amount and timing vary by chain protocol. +Withdraws funds that have completed the unbonding period. Typically requires the position to be deactivated first (unstake → unbond → withdraw). Amount and timing vary by chain protocol. Partial withdrawal is supported for ETH compounding validators (EIP-7251/Pectra) and Cosmos chains via the optional 'amount' field. For ETH compounding validators, the remaining balance must be at least 32 ETH after the withdrawal. For all other chains, omitting 'amount' withdraws the entire available balance. ### Example @@ -1418,7 +1418,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **withdrawRequest** | [**WithdrawRequest**](WithdrawRequest.md)| | | -| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the withdraw staking operation (e.g., ATOM_COS/ETH/STETH_ETH). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | +| **chainDescriptor** | [**ChainDescriptor**](.md)| Protocol identifier for the withdraw staking operation (e.g., ATOM_COS/ETH/STETH_ETH). | [enum: ATOM_COS, AXL, AXL_TEST, CELESTIA, DYDX_DYDX, ETH, ETH_TEST6, ETH_TEST_HOODI, INJ_INJ, MANTRA, MATIC, OSMO, POL, POL_TEST, SOL, SOL_TEST, STETH_ETH, STETH_ETH_TEST6_DZFA, STETH_ETH_TEST_HOODI] | | **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | ### Return type diff --git a/docs/TRLinkBeneficiaryPii.md b/docs/TRLinkBeneficiaryPii.md new file mode 100644 index 00000000..01f6928a --- /dev/null +++ b/docs/TRLinkBeneficiaryPii.md @@ -0,0 +1,14 @@ + + +# TRLinkBeneficiaryPii + +Beneficiary PII data in IVMS101 format + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**ivms101** | [**TRLinkIvms**](TRLinkIvms.md) | | | + + + diff --git a/docs/TRLinkGetRequiredActionsResponse.md b/docs/TRLinkGetRequiredActionsResponse.md new file mode 100644 index 00000000..14012f38 --- /dev/null +++ b/docs/TRLinkGetRequiredActionsResponse.md @@ -0,0 +1,14 @@ + + +# TRLinkGetRequiredActionsResponse + +Response containing the list of required actions for a TRM + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**actions** | [**List<TRLinkRequiredAction>**](TRLinkRequiredAction.md) | List of required actions for the TRM | | + + + diff --git a/docs/TRLinkManualDecisionAction.md b/docs/TRLinkManualDecisionAction.md new file mode 100644 index 00000000..1a494063 --- /dev/null +++ b/docs/TRLinkManualDecisionAction.md @@ -0,0 +1,13 @@ + + +# TRLinkManualDecisionAction + +## Enum + + +* `ACCEPT` (value: `"ACCEPT"`) + +* `REJECT` (value: `"REJECT"`) + + + diff --git a/docs/TRLinkManualDecisionDestinationDetail.md b/docs/TRLinkManualDecisionDestinationDetail.md new file mode 100644 index 00000000..0ac392ec --- /dev/null +++ b/docs/TRLinkManualDecisionDestinationDetail.md @@ -0,0 +1,16 @@ + + +# TRLinkManualDecisionDestinationDetail + +Per-destination result of the manual decision + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**destinationScreeningId** | **String** | Destination screening record ID | | +|**applied** | **Boolean** | Whether the decision was applied to this destination | | +|**skipReason** | **String** | Reason if the destination was skipped | [optional] | + + + diff --git a/docs/TRLinkManualDecisionRequest.md b/docs/TRLinkManualDecisionRequest.md new file mode 100644 index 00000000..681270f1 --- /dev/null +++ b/docs/TRLinkManualDecisionRequest.md @@ -0,0 +1,15 @@ + + +# TRLinkManualDecisionRequest + +Request to manually accept or reject destinations stuck in NoTRM status + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**action** | **TRLinkManualDecisionAction** | | | +|**reason** | **String** | Optional reason for the manual decision (e.g. 'Internal KYC approved'). Do not include PII. | [optional] | + + + diff --git a/docs/TRLinkManualDecisionResponse.md b/docs/TRLinkManualDecisionResponse.md new file mode 100644 index 00000000..1c9367a5 --- /dev/null +++ b/docs/TRLinkManualDecisionResponse.md @@ -0,0 +1,19 @@ + + +# TRLinkManualDecisionResponse + +Response containing the result of the manual decision + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**action** | **TRLinkManualDecisionAction** | | | +|**source** | **TRLinkManualDecisionSource** | | | +|**txId** | **String** | Transaction ID | | +|**destinationsAffected** | **Integer** | Number of destinations where the decision was applied | | +|**destinationsSkipped** | **Integer** | Number of destinations that were skipped | | +|**details** | [**List<TRLinkManualDecisionDestinationDetail>**](TRLinkManualDecisionDestinationDetail.md) | Per-destination details | | + + + diff --git a/docs/TRLinkManualDecisionSource.md b/docs/TRLinkManualDecisionSource.md new file mode 100644 index 00000000..b3dfec5e --- /dev/null +++ b/docs/TRLinkManualDecisionSource.md @@ -0,0 +1,13 @@ + + +# TRLinkManualDecisionSource + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `POLICY` (value: `"POLICY"`) + + + diff --git a/docs/TRLinkRequiredAction.md b/docs/TRLinkRequiredAction.md new file mode 100644 index 00000000..c7d9a5a7 --- /dev/null +++ b/docs/TRLinkRequiredAction.md @@ -0,0 +1,16 @@ + + +# TRLinkRequiredAction + +A required action for processing the TRM + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**type** | **String** | The action type identifier as defined by the Travel Rule provider. Values are provider-specific and may vary across different TRP implementations, so this field is intentionally not restricted to a fixed set of values. | | +|**description** | **String** | Human-readable description of the action | [optional] | +|**data** | [**TRLinkRequiredActionData**](TRLinkRequiredActionData.md) | | [optional] | + + + diff --git a/docs/TRLinkRequiredActionData.md b/docs/TRLinkRequiredActionData.md new file mode 100644 index 00000000..b9ed5fc8 --- /dev/null +++ b/docs/TRLinkRequiredActionData.md @@ -0,0 +1,15 @@ + + +# TRLinkRequiredActionData + +Data describing what fields are required to resolve the action. The structure varies by action type and is defined by the TRP provider. For UPLOAD_BENEFICIARY_PII action type: Contains beneficiaryRequiredFields and/or originatorRequiredFields listing the IVMS101 field paths that must be provided. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**beneficiaryRequiredFields** | [**List<TRLinkRequiredField>**](TRLinkRequiredField.md) | List of required beneficiary IVMS101 fields | [optional] | +|**originatorRequiredFields** | [**List<TRLinkRequiredField>**](TRLinkRequiredField.md) | List of required originator IVMS101 fields | [optional] | + + + diff --git a/docs/TRLinkRequiredField.md b/docs/TRLinkRequiredField.md new file mode 100644 index 00000000..3512f9d7 --- /dev/null +++ b/docs/TRLinkRequiredField.md @@ -0,0 +1,15 @@ + + +# TRLinkRequiredField + +An IVMS101 field requirement with its type and path + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**type** | **String** | The person type for this field | | +|**path** | **String** | IVMS101 field path | | + + + diff --git a/docs/TRLinkResolveActionData.md b/docs/TRLinkResolveActionData.md new file mode 100644 index 00000000..bef3b330 --- /dev/null +++ b/docs/TRLinkResolveActionData.md @@ -0,0 +1,14 @@ + + +# TRLinkResolveActionData + +Data to submit when resolving an action. The structure varies by action type and is validated by the TRP provider. For UPLOAD_BENEFICIARY_PII action type: Contains beneficiaryPii with IVMS101-encoded PII data. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**beneficiaryPii** | [**TRLinkBeneficiaryPii**](TRLinkBeneficiaryPii.md) | | [optional] | + + + diff --git a/docs/TRLinkResolveActionRequest.md b/docs/TRLinkResolveActionRequest.md new file mode 100644 index 00000000..ec0bf3b8 --- /dev/null +++ b/docs/TRLinkResolveActionRequest.md @@ -0,0 +1,15 @@ + + +# TRLinkResolveActionRequest + +Request to resolve a pending TRM action + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**type** | **String** | The action type identifier as defined by the Travel Rule provider. Must match one of the types returned by the get required actions endpoint. Values are provider-specific and may vary across different TRP implementations. | | +|**data** | [**TRLinkResolveActionData**](TRLinkResolveActionData.md) | | [optional] | + + + diff --git a/docs/TokenizationApi.md b/docs/TokenizationApi.md index 760f3ee7..e5c8fc50 100644 --- a/docs/TokenizationApi.md +++ b/docs/TokenizationApi.md @@ -124,7 +124,7 @@ No authorization required Create a new collection -Create a new collection and link it as a token. </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. +Create a new collection and link it as a token. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. ### Example @@ -813,7 +813,7 @@ No authorization required Get collections -Get collections (paginated). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get collections (paginated). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1149,7 +1149,7 @@ No authorization required Issue a new token -Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. +Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. ### Example diff --git a/docs/TrLinkApi.md b/docs/TrLinkApi.md index 11699623..a7dcb2f2 100644 --- a/docs/TrLinkApi.md +++ b/docs/TrLinkApi.md @@ -9,6 +9,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | [**connectTRLinkIntegration**](TrLinkApi.md#connectTRLinkIntegration) | **PUT** /screening/trlink/customers/integration/{customerIntegrationId} | Connect customer integration | | [**createTRLinkCustomer**](TrLinkApi.md#createTRLinkCustomer) | **POST** /screening/trlink/customers | Create customer | | [**createTRLinkIntegration**](TrLinkApi.md#createTRLinkIntegration) | **POST** /screening/trlink/customers/integration | Create customer integration | +| [**createTRLinkManualDecision**](TrLinkApi.md#createTRLinkManualDecision) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision | Manual decision for missing TRM | | [**createTRLinkTrm**](TrLinkApi.md#createTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm | Create Travel Rule Message | | [**deleteTRLinkCustomer**](TrLinkApi.md#deleteTRLinkCustomer) | **DELETE** /screening/trlink/customers/{customerId} | Delete customer | | [**disconnectTRLinkIntegration**](TrLinkApi.md#disconnectTRLinkIntegration) | **DELETE** /screening/trlink/customers/integration/{customerIntegrationId} | Disconnect customer integration | @@ -21,10 +22,12 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | [**getTRLinkPolicy**](TrLinkApi.md#getTRLinkPolicy) | **GET** /screening/trlink/policy | Get TRLink policy | | [**getTRLinkSupportedAsset**](TrLinkApi.md#getTRLinkSupportedAsset) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID | | [**getTRLinkTrmById**](TrLinkApi.md#getTRLinkTrmById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId} | Get TRM by ID | +| [**getTRLinkTrmRequiredActions**](TrLinkApi.md#getTRLinkTrmRequiredActions) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions | Get required actions for a TRM | | [**getTRLinkVaspById**](TrLinkApi.md#getTRLinkVaspById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId} | Get VASP by ID | | [**listTRLinkSupportedAssets**](TrLinkApi.md#listTRLinkSupportedAssets) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets | List supported assets | | [**listTRLinkVasps**](TrLinkApi.md#listTRLinkVasps) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps | List VASPs | | [**redirectTRLinkTrm**](TrLinkApi.md#redirectTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect | Redirect Travel Rule Message | +| [**resolveActionTRLinkTrm**](TrLinkApi.md#resolveActionTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_action | Resolve action for a TRM | | [**setTRLinkDestinationTravelRuleMessageId**](TrLinkApi.md#setTRLinkDestinationTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/destination/travel_rule_message_id | Set destination travel rule message ID | | [**setTRLinkTransactionTravelRuleMessageId**](TrLinkApi.md#setTRLinkTransactionTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/travel_rule_message_id | Set transaction travel rule message ID | | [**testTRLinkIntegrationConnection**](TrLinkApi.md#testTRLinkIntegrationConnection) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/test_connection | Test connection | @@ -465,6 +468,95 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## createTRLinkManualDecision + +> CompletableFuture> createTRLinkManualDecision createTRLinkManualDecision(trLinkManualDecisionRequest, customerIntegrationId, txId, idempotencyKey) + +Manual decision for missing TRM + +Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.TrLinkApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + TRLinkManualDecisionRequest trLinkManualDecisionRequest = new TRLinkManualDecisionRequest(); // TRLinkManualDecisionRequest | + UUID customerIntegrationId = UUID.fromString("3fa85f64-5717-4562-b3fc-2c963f66afa6"); // UUID | Customer integration unique identifier + UUID txId = UUID.fromString("b70701f4-d7b1-4795-a8ee-b09cdb5b850e"); // UUID | Fireblocks transaction unique identifier + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.trLink().createTRLinkManualDecision(trLinkManualDecisionRequest, customerIntegrationId, txId, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling TrLinkApi#createTRLinkManualDecision"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling TrLinkApi#createTRLinkManualDecision"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **trLinkManualDecisionRequest** | [**TRLinkManualDecisionRequest**](TRLinkManualDecisionRequest.md)| | | +| **customerIntegrationId** | **UUID**| Customer integration unique identifier | | +| **txId** | **UUID**| Fireblocks transaction unique identifier | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Decision applied successfully | - | +| **0** | Error Response | * X-Request-ID -
| + + ## createTRLinkTrm > CompletableFuture> createTRLinkTrm createTRLinkTrm(trLinkCreateTrmRequest, customerIntegrationId, idempotencyKey) @@ -1457,6 +1549,91 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## getTRLinkTrmRequiredActions + +> CompletableFuture> getTRLinkTrmRequiredActions getTRLinkTrmRequiredActions(customerIntegrationId, trmId) + +Get required actions for a TRM + +Retrieves the list of required actions (e.g., PII fields) needed to process the Travel Rule Message. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.TrLinkApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + UUID customerIntegrationId = UUID.randomUUID(); // UUID | Customer integration unique identifier + String trmId = "trmId_example"; // String | Travel Rule Message unique identifier + try { + CompletableFuture> response = fireblocks.trLink().getTRLinkTrmRequiredActions(customerIntegrationId, trmId); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling TrLinkApi#getTRLinkTrmRequiredActions"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling TrLinkApi#getTRLinkTrmRequiredActions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **customerIntegrationId** | **UUID**| Customer integration unique identifier | | +| **trmId** | **String**| Travel Rule Message unique identifier | | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Required actions retrieved successfully | - | +| **0** | Error Response | * X-Request-ID -
| + + ## getTRLinkVaspById > CompletableFuture> getTRLinkVaspById getTRLinkVaspById(customerIntegrationId, vaspId) @@ -1805,6 +1982,95 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## resolveActionTRLinkTrm + +> CompletableFuture> resolveActionTRLinkTrm resolveActionTRLinkTrm(trLinkResolveActionRequest, customerIntegrationId, trmId, idempotencyKey) + +Resolve action for a TRM + +Submits required data (e.g., beneficiary PII) to resolve a pending Travel Rule Message action. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.TrLinkApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + TRLinkResolveActionRequest trLinkResolveActionRequest = new TRLinkResolveActionRequest(); // TRLinkResolveActionRequest | + UUID customerIntegrationId = UUID.randomUUID(); // UUID | Customer integration unique identifier + String trmId = "trmId_example"; // String | Travel Rule Message unique identifier + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.trLink().resolveActionTRLinkTrm(trLinkResolveActionRequest, customerIntegrationId, trmId, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling TrLinkApi#resolveActionTRLinkTrm"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling TrLinkApi#resolveActionTRLinkTrm"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **trLinkResolveActionRequest** | [**TRLinkResolveActionRequest**](TRLinkResolveActionRequest.md)| | | +| **customerIntegrationId** | **UUID**| Customer integration unique identifier | | +| **trmId** | **String**| Travel Rule Message unique identifier | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Action resolved successfully | - | +| **0** | Error Response | * X-Request-ID -
| + + ## setTRLinkDestinationTravelRuleMessageId > CompletableFuture> setTRLinkDestinationTravelRuleMessageId setTRLinkDestinationTravelRuleMessageId(trLinkSetDestinationTravelRuleMessageIdRequest, txId, idempotencyKey) diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index ed263397..cfa07bef 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -26,7 +26,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Cancel a transaction -Cancels a transaction by Fireblocks Transaction ID. Can be used only for transactions that did not get to the BROADCASTING state. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Cancels a transaction by Fireblocks Transaction ID. Can be used only for transactions that did not get to the BROADCASTING state. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -200,7 +200,7 @@ No authorization required Drop ETH (EVM) transaction by ID -Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -289,7 +289,7 @@ No authorization required Estimate the required fee for an asset -Gets the estimated required fee for an asset. Fireblocks fetches, calculates and caches the result every 30 seconds. Customers should query this API while taking the caching interval into consideration. Notes: - The `networkFee` parameter is the `gasPrice` with a given delta added, multiplied by the gasLimit plus the delta. - The estimation provided depends on the asset type. - For UTXO-based assets, the response contains the `feePerByte` parameter - For ETH-based and all EVM based assets, the response will contain `gasPrice` parameter. This is calculated by adding the `baseFee` to the `actualPriority` based on the latest 12 blocks. The response for ETH-based contains the `baseFee`, `gasPrice`, and `priorityFee` parameters. - For ADA-based assets, the response will contain the parameter `networkFee` and `feePerByte` parameters. - For XRP and XLM, the response will contain the transaction fee. - For other assets, the response will contain the `networkFee` parameter. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Gets the estimated required fee for an asset. Fireblocks fetches, calculates and caches the result every 30 seconds. Customers should query this API while taking the caching interval into consideration. Notes: - The `networkFee` parameter is the `gasPrice` with a given delta added, multiplied by the gasLimit plus the delta. - The estimation provided depends on the asset type. - For UTXO-based assets, the response contains the `feePerByte` parameter - For ETH-based and all EVM based assets, the response will contain `gasPrice` parameter. This is calculated by adding the `baseFee` to the `actualPriority` based on the latest 12 blocks. The response for ETH-based contains the `baseFee`, `gasPrice`, and `priorityFee` parameters. - For ADA-based assets, the response will contain the parameter `networkFee` and `feePerByte` parameters. - For XRP and XLM, the response will contain the transaction fee. - For other assets, the response will contain the `networkFee` parameter. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -372,7 +372,7 @@ No authorization required Estimate transaction fee -Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). </br>Endpoint Permission: Admin, Signer, Approver, Editor. +Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. ### Example @@ -457,7 +457,7 @@ No authorization required Freeze a transaction -Freezes a transaction by ID. Usually used for AML integrations when the incoming funds should be quarantined. For account based assets - the entire amount of the transaction is frozen For UTXO based assets - all UTXOs of the specified transaction are frozen </br>Endpoint Permission: Admin, Non-Signing Admin. +Freezes a transaction by ID. Usually used for AML integrations when the incoming funds should be quarantined. For account based assets - the entire amount of the transaction is frozen For UTXO based assets - all UTXOs of the specified transaction are frozen Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -543,7 +543,7 @@ No authorization required Get a specific transaction by Fireblocks transaction ID -Get a specific transaction data by Fireblocks Transaction ID </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get a specific transaction data by Fireblocks Transaction ID Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -627,7 +627,7 @@ No authorization required Get a specific transaction by external transaction ID -Returns transaction by external transaction ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns transaction by external transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -823,7 +823,7 @@ No authorization required Set confirmation threshold by transaction hash -Overrides the required number of confirmations for transaction completion by transaction hash. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Overrides the required number of confirmations for transaction completion by transaction hash. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -910,7 +910,7 @@ No authorization required Set confirmation threshold by Fireblocks Transaction ID -Overrides the required number of confirmations for transaction completion Fireblocks Transaction ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Overrides the required number of confirmations for transaction completion Fireblocks Transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -997,7 +997,7 @@ No authorization required Unfreeze a transaction -Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available again. </br>Endpoint Permission: Admin, Non-Signing Admin. +Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available again. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -1083,7 +1083,7 @@ No authorization required Validate destination address -Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/UpdateCounterpartyGroupRequest.md b/docs/UpdateCounterpartyGroupRequest.md new file mode 100644 index 00000000..f432b016 --- /dev/null +++ b/docs/UpdateCounterpartyGroupRequest.md @@ -0,0 +1,17 @@ + + +# UpdateCounterpartyGroupRequest + +Request body for updating an existing counterparty group + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Updated human-readable name of the group | [optional] | +|**description** | **String** | Updated description of the group | [optional] | +|**jurisdictionCodes** | **List<String>** | Updated list of jurisdiction codes for the group | [optional] | +|**isActive** | **Boolean** | Whether the counterparty group should be active | [optional] | + + + diff --git a/docs/UserGroupsBetaApi.md b/docs/UserGroupsBetaApi.md index a273d1e9..c5be4e4a 100644 --- a/docs/UserGroupsBetaApi.md +++ b/docs/UserGroupsBetaApi.md @@ -18,7 +18,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Create user group -Create a new user group. Users with the Viewer role cannot be added to groups. </br>Endpoint Permission: Admin, Non-Signing Admin. +Create a new user group. Users with the Viewer role cannot be added to groups. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -103,7 +103,7 @@ No authorization required Delete user group -Delete a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. +Delete a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. ### Example @@ -185,7 +185,7 @@ No authorization required Get user group -Get a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. +Get a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. ### Example @@ -268,7 +268,7 @@ No authorization required List user groups -Get all user groups in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Get all user groups in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -347,7 +347,7 @@ No authorization required Update user group -Update a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. +Update a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin permissions. ### Example diff --git a/docs/UtxoManagementBetaApi.md b/docs/UtxoManagementBetaApi.md index 4a3aeb8b..94df86ed 100644 --- a/docs/UtxoManagementBetaApi.md +++ b/docs/UtxoManagementBetaApi.md @@ -15,7 +15,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ List unspent outputs (UTXOs) -Returns a paginated list of unspent transaction outputs (UTXOs) for a UTXO-based asset in a vault account, with optional filters for labels, statuses, amounts, and more. **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns a paginated list of unspent transaction outputs (UTXOs) for a UTXO-based asset in a vault account, with optional filters for labels, statuses, amounts, and more. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -126,7 +126,7 @@ No authorization required Attach or detach labels to/from UTXOs -Attach or detach labels to/from UTXOs in a vault account. Labels can be used for organizing and filtering UTXOs. Labels are applied additively — `labelsToAttach` adds to the existing label set and `labelsToDetach` removes from it. Neither operation replaces the full set. **Note:** These endpoints are currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Attach or detach labels to/from UTXOs in a vault account. Labels can be used for organizing and filtering UTXOs. Labels are applied additively — `labelsToAttach` adds to the existing label set and `labelsToDetach` removes from it. Neither operation replaces the full set. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/VaultsApi.md b/docs/VaultsApi.md index e650705d..edad53d0 100644 --- a/docs/VaultsApi.md +++ b/docs/VaultsApi.md @@ -5,6 +5,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | Method | HTTP request | Description | |------------- | ------------- | -------------| | [**activateAssetForVaultAccount**](VaultsApi.md#activateAssetForVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/activate | Activate a wallet in a vault account | +| [**activateCircleGatewayWalletBeta**](VaultsApi.md#activateCircleGatewayWalletBeta) | **POST** /vault/accounts/{vaultAccountId}/circle_gateway/activate | Activate a Circle Gateway wallet | | [**attachOrDetachTagsFromVaultAccounts**](VaultsApi.md#attachOrDetachTagsFromVaultAccounts) | **POST** /vault/accounts/attached_tags | Attach or detach tags from vault accounts | | [**createLegacyAddress**](VaultsApi.md#createLegacyAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy | Convert a segwit address to legacy format | | [**createMultipleAccounts**](VaultsApi.md#createMultipleAccounts) | **POST** /vault/accounts/bulk | Bulk creation of new vault accounts | @@ -12,7 +13,9 @@ All URIs are relative to https://developers.fireblocks.com/reference/ | [**createVaultAccount**](VaultsApi.md#createVaultAccount) | **POST** /vault/accounts | Create a new vault account | | [**createVaultAccountAsset**](VaultsApi.md#createVaultAccountAsset) | **POST** /vault/accounts/{vaultAccountId}/{assetId} | Create a new vault wallet | | [**createVaultAccountAssetAddress**](VaultsApi.md#createVaultAccountAssetAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses | Create new asset deposit address | +| [**deactivateCircleGatewayWalletBeta**](VaultsApi.md#deactivateCircleGatewayWalletBeta) | **POST** /vault/accounts/{vaultAccountId}/circle_gateway/deactivate | Deactivate a Circle Gateway wallet | | [**getAssetWallets**](VaultsApi.md#getAssetWallets) | **GET** /vault/asset_wallets | Get vault wallets (Paginated) | +| [**getCircleGatewayWalletInfoBeta**](VaultsApi.md#getCircleGatewayWalletInfoBeta) | **GET** /vault/accounts/{vaultAccountId}/circle_gateway | Get Circle Gateway wallet info | | [**getCreateMultipleDepositAddressesJobStatus**](VaultsApi.md#getCreateMultipleDepositAddressesJobStatus) | **GET** /vault/accounts/addresses/bulk/{jobId} | Get the job status of the bulk deposit address creation | | [**getCreateMultipleVaultAccountsJobStatus**](VaultsApi.md#getCreateMultipleVaultAccountsJobStatus) | **GET** /vault/accounts/bulk/{jobId} | Get job status of bulk creation of new vault accounts | | [**getMaxBipIndexUsed**](VaultsApi.md#getMaxBipIndexUsed) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used | Get maximum BIP44 index used | @@ -43,7 +46,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Activate a wallet in a vault account -Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation (XLM tokens, SOL tokens etc). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation (XLM tokens, SOL tokens etc). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -126,6 +129,91 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## activateCircleGatewayWalletBeta + +> CompletableFuture> activateCircleGatewayWalletBeta activateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey) + +Activate a Circle Gateway wallet + +Activates the Circle Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. **Note:** This endpoint is currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.VaultsApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + String vaultAccountId = "vaultAccountId_example"; // String | The ID of the vault account + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.vaults().activateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling VaultsApi#activateCircleGatewayWalletBeta"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling VaultsApi#activateCircleGatewayWalletBeta"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **vaultAccountId** | **String**| The ID of the vault account | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Circle Gateway wallet activated successfully | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## attachOrDetachTagsFromVaultAccounts > CompletableFuture> attachOrDetachTagsFromVaultAccounts attachOrDetachTagsFromVaultAccounts(vaultAccountsTagAttachmentOperationsRequest, idempotencyKey) @@ -218,7 +306,7 @@ No authorization required Convert a segwit address to legacy format -Converts an existing segwit address to the legacy format. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -477,7 +565,7 @@ No authorization required Create a new vault account -Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -562,7 +650,7 @@ No authorization required Create a new vault wallet -Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -653,7 +741,7 @@ No authorization required Create new asset deposit address -Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. </br>Endpoint Permission: Admin, Non-Signing Admin. +Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -736,13 +824,98 @@ No authorization required | **0** | Error Response | * X-Request-ID -
| +## deactivateCircleGatewayWalletBeta + +> CompletableFuture> deactivateCircleGatewayWalletBeta deactivateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey) + +Deactivate a Circle Gateway wallet + +Deactivates the Circle Gateway wallet associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.VaultsApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + String vaultAccountId = "vaultAccountId_example"; // String | The ID of the vault account + String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. + try { + CompletableFuture> response = fireblocks.vaults().deactivateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling VaultsApi#deactivateCircleGatewayWalletBeta"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling VaultsApi#deactivateCircleGatewayWalletBeta"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **vaultAccountId** | **String**| The ID of the vault account | | +| **idempotencyKey** | **String**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Circle Gateway wallet deactivated successfully | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## getAssetWallets > CompletableFuture> getAssetWallets getAssetWallets(totalAmountLargerThan, assetId, orderBy, before, after, limit) Get vault wallets (Paginated) -Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -828,6 +1001,89 @@ No authorization required | **200** | A PaginatedAssetWalletResponse object | * X-Request-ID -
| +## getCircleGatewayWalletInfoBeta + +> CompletableFuture> getCircleGatewayWalletInfoBeta getCircleGatewayWalletInfoBeta(vaultAccountId) + +Get Circle Gateway wallet info + +Returns the Circle Gateway wallet information associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + +### Example + +```java +// Import classes: +import com.fireblocks.sdk.ApiClient; +import com.fireblocks.sdk.ApiException; +import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.BasePath; +import com.fireblocks.sdk.Fireblocks; +import com.fireblocks.sdk.ConfigurationOptions; +import com.fireblocks.sdk.model.*; +import com.fireblocks.sdk.api.VaultsApi; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +public class Example { + public static void main(String[] args) { + ConfigurationOptions configurationOptions = new ConfigurationOptions() + .basePath(BasePath.Sandbox) + .apiKey("my-api-key") + .secretKey("my-secret-key"); + Fireblocks fireblocks = new Fireblocks(configurationOptions); + + String vaultAccountId = "vaultAccountId_example"; // String | The ID of the vault account + try { + CompletableFuture> response = fireblocks.vaults().getCircleGatewayWalletInfoBeta(vaultAccountId); + System.out.println("Status code: " + response.get().getStatusCode()); + System.out.println("Response headers: " + response.get().getHeaders()); + System.out.println("Response body: " + response.get().getData()); + } catch (InterruptedException | ExecutionException e) { + ApiException apiException = (ApiException)e.getCause(); + System.err.println("Exception when calling VaultsApi#getCircleGatewayWalletInfoBeta"); + System.err.println("Status code: " + apiException.getCode()); + System.err.println("Response headers: " + apiException.getResponseHeaders()); + System.err.println("Reason: " + apiException.getResponseBody()); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling VaultsApi#getCircleGatewayWalletInfoBeta"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **vaultAccountId** | **String**| The ID of the vault account | | + +### Return type + +CompletableFuture> + + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Circle Gateway wallet information | * X-Request-ID -
| +| **0** | Error Response | * X-Request-ID -
| + + ## getCreateMultipleDepositAddressesJobStatus > CompletableFuture> getCreateMultipleDepositAddressesJobStatus getCreateMultipleDepositAddressesJobStatus(jobId) @@ -1172,7 +1428,7 @@ No authorization required Get vault accounts (Paginated) -Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1274,7 +1530,7 @@ No authorization required Get the public key for a derivation path -Gets the public key information based on derivation path and signing algorithm. </br>Endpoint Permission: Admin, Non-Signing Admin. +Gets the public key information based on derivation path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -1361,7 +1617,7 @@ No authorization required Get an asset's public key -Get the public key information for a specific asset in a vault account. </br>Endpoint Permission: Admin, Non-Signing Admin. +Get the public key information for a specific asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -1452,7 +1708,7 @@ No authorization required Get UTXO unspent inputs information -Returns unspent inputs information of an UTXO asset in a vault account. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns unspent inputs information of an UTXO asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1537,7 +1793,7 @@ No authorization required Get a vault account by ID -Get a vault account by its unique ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1620,7 +1876,7 @@ No authorization required Get the asset balance for a vault account -Returns a specific vault wallet balance information for a specific asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns a specific vault wallet balance information for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1705,7 +1961,7 @@ No authorization required Get addresses (Paginated) -Returns a paginated response of the addresses for a given vault account and asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Returns a paginated response of the addresses for a given vault account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1796,7 +2052,7 @@ No authorization required Get asset balance for chosen assets -Gets the assets amount summary for all accounts or filtered accounts. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1881,7 +2137,7 @@ No authorization required Get vault balance by an asset -Get the total balance of an asset across all the vault accounts. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. +Get the total balance of an asset across all the vault accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. ### Example @@ -1964,7 +2220,7 @@ No authorization required Hide a vault account in the console -Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -2049,7 +2305,7 @@ No authorization required Assign AML customer reference ID -Sets an AML/KYT customer reference ID for a specific address. </br>Endpoint Permission: Admin, Non-Signing Admin. +Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -2140,7 +2396,7 @@ No authorization required Set auto fueling to on or off -Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -2227,7 +2483,7 @@ No authorization required Set an AML/KYT ID for a vault account -Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). </br>Endpoint Permission: Admin, Non-Signing Admin. +Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: Admin, Non-Signing Admin. ### Example @@ -2314,7 +2570,7 @@ No authorization required Unhide a vault account in the console -Makes a hidden vault account visible in web console view. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -2399,7 +2655,7 @@ No authorization required Rename a vault account -Renames the requested vault account. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. +Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. ### Example @@ -2486,7 +2742,7 @@ No authorization required Update address description -Updates the description of an existing address of an asset in a vault account. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Updates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example @@ -2577,7 +2833,7 @@ No authorization required Refresh asset balance data -Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index b145020c..b5e355ee 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -102,7 +102,7 @@ No authorization required Resend failed webhooks -Resends all failed webhook notifications. Learn more about Fireblocks Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. +Resends all failed webhook notifications. Learn more about Fireblocks Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/WhitelistIpAddressesApi.md b/docs/WhitelistIpAddressesApi.md index 5fdc98ef..38d269d0 100644 --- a/docs/WhitelistIpAddressesApi.md +++ b/docs/WhitelistIpAddressesApi.md @@ -14,7 +14,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Get whitelisted ip addresses for an API Key -Get a list of the whitelisted IP addresses for a specific API Key - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Get a list of the whitelisted IP addresses for a specific API Key - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/docs/WithdrawRequest.md b/docs/WithdrawRequest.md index 4eb3e1d4..418d8d53 100644 --- a/docs/WithdrawRequest.md +++ b/docs/WithdrawRequest.md @@ -11,7 +11,7 @@ |**fee** | **String** | Represents the fee for a transaction, which can be specified as a percentage value. Only one of fee/feeLevel is required. | [optional] | |**feeLevel** | **FeeLevel** | | [optional] | |**txNote** | **String** | The note to associate with the transactions. | [optional] | -|**amount** | **String** | Amount of tokens to withdraw. Only supported for Cosmos chains to enable partial withdrawals. For other chains, this field is ignored and the entire available amount will be withdrawn. If not provided, the entire available amount will be withdrawn. | [optional] | +|**amount** | **String** | Amount of tokens to withdraw. Only supported for ETH compounding validators (EIP-7251/Pectra) and Cosmos chains to enable partial withdrawals. For ETH compounding validators, the remaining balance must be at least 32 ETH after withdrawal. For other chains, this field is ignored and the entire available amount will be withdrawn. If not provided, the entire available amount will be withdrawn. | [optional] | diff --git a/docs/WorkspaceStatusBetaApi.md b/docs/WorkspaceStatusBetaApi.md index 76f39803..fac98d29 100644 --- a/docs/WorkspaceStatusBetaApi.md +++ b/docs/WorkspaceStatusBetaApi.md @@ -14,7 +14,7 @@ All URIs are relative to https://developers.fireblocks.com/reference/ Returns current workspace status -Returns current workspace status (Beta). **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. +Returns current workspace status (Beta). **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Example diff --git a/pom.xml b/pom.xml index 18fe94fd..89176ce6 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ fireblocks-sdk jar fireblocks-sdk - 17.0.0 + 0.0.0 https://github.com/fireblocks/java-sdk The Fireblocks Official SDK is a comprehensive software development kit that enables seamless integration and interaction with the Fireblocks platform. Fireblocks is a cutting-edge blockchain infrastructure platform that provides secure and scalable solutions for managing digital assets and transactions. This SDK empowers developers to build robust applications that can interact with the Fireblocks platform's features, including creating and managing vault accounts, initiating secure transactions, managing assets, and more. It abstracts complex interactions with the Fireblocks API, making it easier for developers to leverage the platform's capabilities while adhering to best practices in security and efficiency. diff --git a/src/main/java/com/fireblocks/sdk/Configuration.java b/src/main/java/com/fireblocks/sdk/Configuration.java index 1061db9a..aa53bae8 100644 --- a/src/main/java/com/fireblocks/sdk/Configuration.java +++ b/src/main/java/com/fireblocks/sdk/Configuration.java @@ -21,7 +21,7 @@ value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.14.0") public class Configuration { - public static final String VERSION = "17.0.0"; + public static final String VERSION = "0.0.0"; private static final AtomicReference defaultApiClient = new AtomicReference<>(); private static volatile Supplier apiClientFactory = ApiClient::new; diff --git a/src/main/java/com/fireblocks/sdk/api/ApiUserApi.java b/src/main/java/com/fireblocks/sdk/api/ApiUserApi.java index f12c8568..99fba0aa 100644 --- a/src/main/java/com/fireblocks/sdk/api/ApiUserApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ApiUserApi.java @@ -73,7 +73,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Create API Key Create a new API key in your workspace. Learn more about Fireblocks API Keys * management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @param createAPIUser (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -141,8 +141,8 @@ private HttpRequest.Builder createApiUserRequestBuilder( } /** * Get API Keys List all API keys in your workspace. - Please note that this endpoint is - * available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: + * Admin, Non-Signing Admin. * * @return CompletableFuture<ApiResponse<GetAPIUsersResponse>> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/fireblocks/sdk/api/AuditLogsApi.java b/src/main/java/com/fireblocks/sdk/api/AuditLogsApi.java index c9e5c359..89711043 100644 --- a/src/main/java/com/fireblocks/sdk/api/AuditLogsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/AuditLogsApi.java @@ -75,8 +75,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Get audit logs Get Audit logs for the last Day/Week. - Please note that this endpoint is - * available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: + * Admin, Non-Signing Admin. * * @param timePeriod The last time period to fetch audit logs (optional) * @param cursor The next id to start fetch audit logs from (optional) diff --git a/src/main/java/com/fireblocks/sdk/api/BlockchainsAssetsApi.java b/src/main/java/com/fireblocks/sdk/api/BlockchainsAssetsApi.java index 8facc8ac..347d4e75 100644 --- a/src/main/java/com/fireblocks/sdk/api/BlockchainsAssetsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/BlockchainsAssetsApi.java @@ -87,9 +87,9 @@ private String formatExceptionMessage(String operationId, int statusCode, String } /** - * Get an asset Returns an asset by ID or legacyID.</br> **Note**: - We will continue - * displaying and supporting the legacy ID (API ID). Since not all Fireblocks services fully - * support the new Assets UUID, please use only the legacy ID until further notice. + * Get an asset Returns an asset by ID or legacyID. **Note**: - We will continue displaying and + * supporting the legacy ID (API ID). Since not all Fireblocks services fully support the new + * Assets UUID, please use only the legacy ID until further notice. * * @param id The ID or legacyId of the asset (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -428,7 +428,7 @@ private HttpRequest.Builder listAssetsRequestBuilder( return localVarRequestBuilder; } /** - * List blockchains Returns all blockchains supported by Fireblocks.</br> + * List blockchains Returns all blockchains supported by Fireblocks. * * @param protocol Blockchain protocol (optional) * @param deprecated Is blockchain deprecated (optional) diff --git a/src/main/java/com/fireblocks/sdk/api/ComplianceApi.java b/src/main/java/com/fireblocks/sdk/api/ComplianceApi.java index f69a6d85..bc525fcb 100644 --- a/src/main/java/com/fireblocks/sdk/api/ComplianceApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ComplianceApi.java @@ -38,6 +38,9 @@ import com.fireblocks.sdk.model.ByorkVerdictRequest; import com.fireblocks.sdk.model.ByorkVerdictResponse; import com.fireblocks.sdk.model.ComplianceResultFullPayload; +import com.fireblocks.sdk.model.CounterpartyGroup; +import com.fireblocks.sdk.model.CounterpartyGroupsPaginatedResponse; +import com.fireblocks.sdk.model.CreateCounterpartyGroupRequest; import com.fireblocks.sdk.model.CreateTransactionResponse; import com.fireblocks.sdk.model.GetByorkVerdictResponse; import com.fireblocks.sdk.model.LegalEntityRegistration; @@ -48,6 +51,7 @@ import com.fireblocks.sdk.model.ScreeningPolicyResponse; import com.fireblocks.sdk.model.ScreeningProviderRulesConfigurationResponse; import com.fireblocks.sdk.model.ScreeningUpdateConfigurations; +import com.fireblocks.sdk.model.UpdateCounterpartyGroupRequest; import com.fireblocks.sdk.model.UpdateLegalEntityRequest; import java.io.IOException; import java.io.InputStream; @@ -269,7 +273,7 @@ private HttpRequest.Builder addAddressRegistryVaultOptOutsRequestBuilder( /** * Assign vault accounts to a legal entity Assigns one or more vault accounts to a specific * legal entity registration. Explicitly mapped vault accounts take precedence over the - * workspace default legal entity. </br>Endpoint Permission: Admin, Non-Signing Admin. + * workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. * * @param assignVaultsToLegalEntityRequest (required) * @param legalEntityId The unique ID of the legal entity registration (required) @@ -364,6 +368,93 @@ private HttpRequest.Builder assignVaultsToLegalEntityRequestBuilder( } return localVarRequestBuilder; } + /** + * Create a counterparty group Creates a new counterparty group. **Endpoint Permissions:** + * Admin, Non-Signing Admin. + * + * @param createCounterpartyGroupRequest (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<CounterpartyGroup>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> createCounterpartyGroup( + CreateCounterpartyGroupRequest createCounterpartyGroupRequest, String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + createCounterpartyGroupRequestBuilder( + createCounterpartyGroupRequest, idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "createCounterpartyGroup", localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CounterpartyGroup>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder createCounterpartyGroupRequestBuilder( + CreateCounterpartyGroupRequest createCounterpartyGroupRequest, String idempotencyKey) + throws ApiException { + ValidationUtils.assertParamExists( + "createCounterpartyGroup", + "createCounterpartyGroupRequest", + createCounterpartyGroupRequest); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = "/counterparty_groups"; + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Content-Type", "application/json"); + localVarRequestBuilder.header("Accept", "application/json"); + + try { + byte[] localVarPostBody = + memberVarObjectMapper.writeValueAsBytes(createCounterpartyGroupRequest); + localVarRequestBuilder.method( + "POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); + } catch (IOException e) { + throw new ApiException(e); + } + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Deactivate BYORK Light Deactivates BYORK Light for the authenticated tenant (sets * config.active to false). Once deactivated, BYORK screening no longer applies until activated @@ -436,6 +527,66 @@ private HttpRequest.Builder deactivateByorkConfigRequestBuilder(String idempoten } return localVarRequestBuilder; } + /** + * Delete a counterparty group Permanently deletes a counterparty group. **Endpoint + * Permissions:** Admin, Non-Signing Admin. + * + * @param groupId The unique identifier of the counterparty group (required) + * @return CompletableFuture<ApiResponse<Void>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> deleteCounterpartyGroup(UUID groupId) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + deleteCounterpartyGroupRequestBuilder(groupId); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "deleteCounterpartyGroup", localVarResponse)); + } + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + null)); + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder deleteCounterpartyGroupRequestBuilder(UUID groupId) + throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "deleteCounterpartyGroup", "groupId", groupId.toString()); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/counterparty_groups/{groupId}" + .replace("{groupId}", ApiClient.urlEncode(groupId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("DELETE", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Get address registry participation status for the authenticated workspace Returns whether the * workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. @@ -847,10 +998,80 @@ private HttpRequest.Builder getByorkVerdictRequestBuilder(String txId) throws Ap } return localVarRequestBuilder; } + /** + * Get a counterparty group Returns the details of a specific counterparty group. **Endpoint + * Permissions:** Admin, Non-Signing Admin, Viewer. + * + * @param groupId The unique identifier of the counterparty group (required) + * @return CompletableFuture<ApiResponse<CounterpartyGroup>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> getCounterpartyGroup(UUID groupId) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + getCounterpartyGroupRequestBuilder(groupId); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "getCounterpartyGroup", localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CounterpartyGroup>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder getCounterpartyGroupRequestBuilder(UUID groupId) + throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "getCounterpartyGroup", "groupId", groupId.toString()); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/counterparty_groups/{groupId}" + .replace("{groupId}", ApiClient.urlEncode(groupId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Get a legal entity Returns details of a specific legal entity registration, including GLEIF - * data when available. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param legalEntityId The unique ID of the legal entity registration (required) * @return CompletableFuture<ApiResponse<LegalEntityRegistration>> @@ -1281,13 +1502,98 @@ private HttpRequest.Builder listAddressRegistryVaultOptOutsRequestBuilder( } return localVarRequestBuilder; } + /** + * List counterparty groups Returns a paginated list of counterparty groups. **Endpoint + * Permissions:** Admin, Non-Signing Admin, Viewer. + * + * @param pageCursor Cursor of the required page (optional) + * @param pageSize Maximum number of items in the page (optional, default to 50) + * @return CompletableFuture<ApiResponse<CounterpartyGroupsPaginatedResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> + listCounterpartyGroups(String pageCursor, Integer pageSize) throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + listCounterpartyGroupsRequestBuilder(pageCursor, pageSize); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "listCounterpartyGroups", localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CounterpartyGroupsPaginatedResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder listCounterpartyGroupsRequestBuilder( + String pageCursor, Integer pageSize) throws ApiException { + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = "/counterparty_groups"; + + List localVarQueryParams = new ArrayList<>(); + StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); + String localVarQueryParameterBaseName; + localVarQueryParameterBaseName = "pageCursor"; + localVarQueryParams.addAll(ApiClient.parameterToPairs("pageCursor", pageCursor)); + localVarQueryParameterBaseName = "pageSize"; + localVarQueryParams.addAll(ApiClient.parameterToPairs("pageSize", pageSize)); + + if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) { + StringJoiner queryJoiner = new StringJoiner("&"); + localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue())); + if (localVarQueryStringJoiner.length() != 0) { + queryJoiner.add(localVarQueryStringJoiner.toString()); + } + localVarRequestBuilder.uri( + URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString())); + } else { + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + } + + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * List legal entities (Paginated) Returns legal entity registrations for the workspace with * cursor-based pagination. If query parameter vaultAccountId is used it returns the legal * entity registration associated with a specific vault account. If no explicit mapping exists * for the vault, the workspace default legal entity is returned. Returns an empty response if - * neither a vault mapping nor a default legal entity is configured. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param vaultAccountId The ID of the vault account. When provided, returns the legal entity * associated with that vault account and pagination parameters are ignored. (optional) @@ -1377,8 +1683,8 @@ private HttpRequest.Builder listLegalEntitiesRequestBuilder( } /** * List vault accounts for a legal entity (Paginated) Returns vault account IDs explicitly - * assigned to a specific legal entity registration, with cursor-based pagination. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * assigned to a specific legal entity registration, with cursor-based pagination. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param legalEntityId The unique ID of the legal entity registration (required) * @param pageCursor Cursor string returned in `next` or `prev` of a @@ -1608,8 +1914,8 @@ private HttpRequest.Builder optOutAddressRegistryTenantRequestBuilder() throws A /** * Register a new legal entity Registers a new legal entity for the workspace using its LEI * (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each - * workspace can register multiple legal entities. </br>Endpoint Permission: Admin, - * Non-Signing Admin. + * workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing + * Admin. * * @param registerLegalEntityRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -2240,11 +2546,106 @@ private HttpRequest.Builder updateAmlScreeningConfigurationRequestBuilder(String } return localVarRequestBuilder; } + /** + * Update a counterparty group Updates an existing counterparty group. **Endpoint Permissions:** + * Admin, Non-Signing Admin. + * + * @param updateCounterpartyGroupRequest (required) + * @param groupId The unique identifier of the counterparty group (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<CounterpartyGroup>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> updateCounterpartyGroup( + UpdateCounterpartyGroupRequest updateCounterpartyGroupRequest, + UUID groupId, + String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + updateCounterpartyGroupRequestBuilder( + updateCounterpartyGroupRequest, groupId, idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "updateCounterpartyGroup", localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CounterpartyGroup>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder updateCounterpartyGroupRequestBuilder( + UpdateCounterpartyGroupRequest updateCounterpartyGroupRequest, + UUID groupId, + String idempotencyKey) + throws ApiException { + ValidationUtils.assertParamExists( + "updateCounterpartyGroup", + "updateCounterpartyGroupRequest", + updateCounterpartyGroupRequest); + ValidationUtils.assertParamExistsAndNotEmpty( + "updateCounterpartyGroup", "groupId", groupId.toString()); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/counterparty_groups/{groupId}" + .replace("{groupId}", ApiClient.urlEncode(groupId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Content-Type", "application/json"); + localVarRequestBuilder.header("Accept", "application/json"); + + try { + byte[] localVarPostBody = + memberVarObjectMapper.writeValueAsBytes(updateCounterpartyGroupRequest); + localVarRequestBuilder.method( + "PATCH", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); + } catch (IOException e) { + throw new ApiException(e); + } + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Update legal entity Updates the status of a legal entity registration. Setting isDefault to * true marks the registration as the workspace default, which is applied to vault accounts that - * have no explicit legal entity mapping. </br>Endpoint Permission: Admin, Non-Signing - * Admin. + * have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * * @param updateLegalEntityRequest (required) * @param legalEntityId The unique ID of the legal entity registration (required) diff --git a/src/main/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApi.java b/src/main/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApi.java index 55885a39..36ffe5f6 100644 --- a/src/main/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApi.java @@ -81,8 +81,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String } /** - * Disconnect connected account Disconnect a connected account by ID. </br> **Note**: - - * This endpoint is currently in beta and might be subject to changes. + * Disconnect connected account Disconnect a connected account by ID. **Note**: - This endpoint + * is currently in beta and might be subject to changes. * * @param accountId The ID of the account to disconnect. (required) * @return CompletableFuture<ApiResponse<Void>> diff --git a/src/main/java/com/fireblocks/sdk/api/ConsoleUserApi.java b/src/main/java/com/fireblocks/sdk/api/ConsoleUserApi.java index 9e839942..28e5bb3f 100644 --- a/src/main/java/com/fireblocks/sdk/api/ConsoleUserApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ConsoleUserApi.java @@ -74,8 +74,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String * Create console user Create console users in your workspace - Please note that this endpoint * is available only for API keys with Admin/Non Signing Admin permissions. Learn more about * Fireblocks Users management in the following - * [guide](https://developers.fireblocks.com/docs/manage-users). </br>Endpoint Permission: - * Admin, Non-Signing Admin. + * [guide](https://developers.fireblocks.com/docs/manage-users). Endpoint Permission: Admin, + * Non-Signing Admin. * * @param createConsoleUser (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -143,8 +143,8 @@ private HttpRequest.Builder createConsoleUserRequestBuilder( } /** * Get console users Get console users for your workspace. - Please note that this endpoint is - * available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: + * Admin, Non-Signing Admin. * * @return CompletableFuture<ApiResponse<GetConsoleUsersResponse>> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/fireblocks/sdk/api/ContractInteractionsApi.java b/src/main/java/com/fireblocks/sdk/api/ContractInteractionsApi.java index 32ff70ad..53c4d4c1 100644 --- a/src/main/java/com/fireblocks/sdk/api/ContractInteractionsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ContractInteractionsApi.java @@ -265,8 +265,8 @@ private HttpRequest.Builder getContractAddressRequestBuilder( } /** * Return deployed contract's ABI Return deployed contract's ABI by blockchain native - * asset id and contract address. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, and Viewer. + * asset id and contract address. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, and Viewer. * * @param contractAddress The contract's onchain address (required) * @param baseAssetId The blockchain base assetId (required) @@ -350,8 +350,8 @@ private HttpRequest.Builder getDeployedContractAbiRequestBuilder( /** * Get transaction receipt Retrieve the transaction receipt by blockchain native asset ID and * transaction hash > **Note** > This functionality is exclusively available for EVM - * (Ethereum Virtual Machine) compatible chains. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor, and Viewer. + * (Ethereum Virtual Machine) compatible chains. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, and Viewer. * * @param baseAssetId The blockchain base assetId (required) * @param txHash The transaction hash (required) diff --git a/src/main/java/com/fireblocks/sdk/api/ContractTemplatesApi.java b/src/main/java/com/fireblocks/sdk/api/ContractTemplatesApi.java index 5dbd376c..dd6dc0a6 100644 --- a/src/main/java/com/fireblocks/sdk/api/ContractTemplatesApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ContractTemplatesApi.java @@ -401,8 +401,8 @@ private HttpRequest.Builder getContractTemplateByIdRequestBuilder(String contrac } /** * List all contract templates Return minimal representation of all the contract templates - * available for the workspace. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + * available for the workspace. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor, Viewer. * * @param limit Items per page (max 100) (optional, default to 100) * @param offset Paging offset (optional, default to 0) diff --git a/src/main/java/com/fireblocks/sdk/api/ContractsApi.java b/src/main/java/com/fireblocks/sdk/api/ContractsApi.java index 5478290f..46932fa5 100644 --- a/src/main/java/com/fireblocks/sdk/api/ContractsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ContractsApi.java @@ -75,8 +75,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String } /** - * Add an asset to a whitelisted contract Adds an asset to a whitelisted contract. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Add an asset to a whitelisted contract Adds an asset to a whitelisted contract. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param contractId The ID of the contract (required) * @param assetId The ID of the asset to add (required) @@ -170,8 +170,8 @@ private HttpRequest.Builder addContractAssetRequestBuilder( return localVarRequestBuilder; } /** - * Add a contract Adds a contract to the workspace whitelist. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * Add a contract Adds a contract to the workspace whitelist. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param createContractRequest (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -251,8 +251,8 @@ private HttpRequest.Builder createContractRequestBuilder( return localVarRequestBuilder; } /** - * Delete a contract Deletes a contract by ID. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * Delete a contract Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @param contractId The ID of the contract to delete (required) * @return CompletableFuture<ApiResponse<Void>> @@ -309,7 +309,7 @@ private HttpRequest.Builder deleteContractRequestBuilder(String contractId) } /** * Delete an asset from a whitelisted contract Deletes a whitelisted contract asset by ID. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param contractId The ID of the contract (required) * @param assetId The ID of the asset to delete (required) @@ -372,7 +372,7 @@ private HttpRequest.Builder deleteContractAssetRequestBuilder(String contractId, } /** * Find a Specific Whitelisted Contract Returns a whitelisted contract by Fireblocks Contract - * ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param contractId The ID of the contract to return (required) * @return CompletableFuture<ApiResponse<UnmanagedWallet>> @@ -438,7 +438,7 @@ private HttpRequest.Builder getContractRequestBuilder(String contractId) throws } /** * Find a whitelisted contract's asset Returns a whitelisted contract's asset by ID. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param contractId The ID of the contract (required) * @param assetId The ID of the asset to return (required) @@ -508,8 +508,8 @@ private HttpRequest.Builder getContractAssetRequestBuilder(String contractId, St return localVarRequestBuilder; } /** - * List Whitelisted Contracts Gets a list of whitelisted contracts. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * List Whitelisted Contracts Gets a list of whitelisted contracts. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @return CompletableFuture<ApiResponse<List<UnmanagedWallet>>> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/fireblocks/sdk/api/CosignersBetaApi.java b/src/main/java/com/fireblocks/sdk/api/CosignersBetaApi.java index c77972ff..37e0ec31 100644 --- a/src/main/java/com/fireblocks/sdk/api/CosignersBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/CosignersBetaApi.java @@ -89,7 +89,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Add cosigner Add a new cosigner. The cosigner will be pending pairing until the API key is - * manually paired </br>Endpoint Permission: Admin and Non-Signing Admin. + * manually paired Endpoint Permission: Admin and Non-Signing Admin. * * @param addCosignerRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -168,7 +168,7 @@ private HttpRequest.Builder addCosignerRequestBuilder( } /** * Get API key Get an API key by ID. **Note:** These endpoints are currently in beta and might - * be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @param cosignerId The unique identifier of the cosigner (required) * @param apiKeyId The unique identifier of the API key (required) @@ -240,8 +240,8 @@ private HttpRequest.Builder getApiKeyRequestBuilder(UUID cosignerId, String apiK } /** * Get all API keys Get all cosigner paired API keys (paginated). **Note:** These endpoints are - * currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and - * Non-Signing Admin. + * currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing + * Admin. * * @param cosignerId The unique identifier of the cosigner (required) * @param order ASC / DESC ordering (default DESC) (optional, default to DESC) @@ -335,7 +335,7 @@ private HttpRequest.Builder getApiKeysRequestBuilder( } /** * Get cosigner Get a cosigner by ID. **Note:** These endpoints are currently in beta and might - * be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @param cosignerId The unique identifier of the cosigner (required) * @return CompletableFuture<ApiResponse<Cosigner>> @@ -402,8 +402,8 @@ private HttpRequest.Builder getCosignerRequestBuilder(UUID cosignerId) throws Ap } /** * Get all cosigners Get all workspace cosigners (paginated). **Note:** These endpoints are - * currently in beta and might be subject to changes. </br>Endpoint Permission: Admin and - * Non-Signing Admin. + * currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing + * Admin. * * @param order ASC / DESC ordering (default DESC) (optional, default to DESC) * @param pageCursor Cursor of the required page (optional) @@ -489,8 +489,8 @@ private HttpRequest.Builder getCosignersRequestBuilder( return localVarRequestBuilder; } /** - * Get request status Get the status of an asynchronous request </br>Endpoint Permission: - * Admin and Non-Signing Admin. + * Get request status Get the status of an asynchronous request Endpoint Permission: Admin and + * Non-Signing Admin. * * @param cosignerId The unique identifier of the cosigner (required) * @param apiKeyId The unique identifier of the API key (required) @@ -564,8 +564,7 @@ private HttpRequest.Builder getRequestStatusRequestBuilder( return localVarRequestBuilder; } /** - * Pair API key Pair an API key to a cosigner </br>Endpoint Permission: Admin and - * Non-Signing Admin. + * Pair API key Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. * * @param pairApiKeyRequest (required) * @param cosignerId The unique identifier of the cosigner (required) @@ -661,7 +660,7 @@ private HttpRequest.Builder pairApiKeyRequestBuilder( } /** * Rename cosigner Rename a cosigner by ID. **Note:** These endpoints are currently in beta and - * might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @param renameCosigner (required) * @param cosignerId The unique identifier of the cosigner (required) @@ -738,8 +737,8 @@ private HttpRequest.Builder renameCosignerRequestBuilder( return localVarRequestBuilder; } /** - * Unpair API key Unpair an API key from a cosigner </br>Endpoint Permission: Admin and - * Non-Signing Admin. + * Unpair API key Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing + * Admin. * * @param cosignerId The unique identifier of the cosigner (required) * @param apiKeyId The unique identifier of the API key (required) @@ -810,7 +809,7 @@ private HttpRequest.Builder unpairApiKeyRequestBuilder(UUID cosignerId, String a return localVarRequestBuilder; } /** - * Update API key callback handler Update the callback handler of an API key </br>Endpoint + * Update API key callback handler Update the callback handler of an API key Endpoint * Permission: Admin and Non-Signing Admin. * * @param updateCallbackHandlerRequest (required) diff --git a/src/main/java/com/fireblocks/sdk/api/ExchangeAccountsApi.java b/src/main/java/com/fireblocks/sdk/api/ExchangeAccountsApi.java index ec0d8ce9..9284a047 100644 --- a/src/main/java/com/fireblocks/sdk/api/ExchangeAccountsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ExchangeAccountsApi.java @@ -178,7 +178,7 @@ private HttpRequest.Builder addExchangeAccountRequestBuilder( * destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported * conversions. Learn more about Fireblocks Exchange Connectivity in the following * [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @param exchangeAccountId The ID of the exchange account. Please make sure the exchange * supports conversions. To find the ID of your exchange account, use GET/exchange_accounts. @@ -271,8 +271,8 @@ private HttpRequest.Builder convertAssetsRequestBuilder( return localVarRequestBuilder; } /** - * Get a specific exchange account Returns an exchange account by ID. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * Get a specific exchange account Returns an exchange account by ID. Endpoint Permission: + * Admin, Non-Signing Admin. * * @param exchangeAccountId The ID of the exchange account to return (required) * @return CompletableFuture<ApiResponse<ExchangeAccount>> @@ -343,8 +343,8 @@ private HttpRequest.Builder getExchangeAccountRequestBuilder(String exchangeAcco return localVarRequestBuilder; } /** - * Get an asset for an exchange account Returns an asset for an exchange account. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Get an asset for an exchange account Returns an asset for an exchange account. Endpoint + * Permission: Admin, Non-Signing Admin. * * @param exchangeAccountId The ID of the exchange account to return (required) * @param assetId The ID of the asset to return (required) @@ -486,7 +486,7 @@ private HttpRequest.Builder getExchangeAccountsCredentialsPublicKeyRequestBuilde } /** * List connected exchange accounts Returns a list of the connected exchange accounts in your - * workspace. </br>Endpoint Permission: Admin, Non-Signing Admin. + * workspace. Endpoint Permission: Admin, Non-Signing Admin. * * @param limit number of exchanges per page (required) * @param before (optional) @@ -578,7 +578,7 @@ private HttpRequest.Builder getPagedExchangeAccountsRequestBuilder( * Internal transfer for exchange accounts Transfers funds between trading accounts under the * same exchange account. Learn more about Fireblocks Exchange Connectivity in the following * [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @param exchangeAccountId The ID of the exchange account to return (required) * @param createInternalTransferRequest (optional) diff --git a/src/main/java/com/fireblocks/sdk/api/ExternalWalletsApi.java b/src/main/java/com/fireblocks/sdk/api/ExternalWalletsApi.java index 1d1746cf..7ab6ead4 100644 --- a/src/main/java/com/fireblocks/sdk/api/ExternalWalletsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ExternalWalletsApi.java @@ -76,8 +76,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String } /** - * Add an asset to an external wallet. Adds an asset to an existing external wallet. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Add an asset to an external wallet. Adds an asset to an existing external wallet. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param walletId The ID of the wallet (required) * @param assetId The ID of the asset to add (required) @@ -177,8 +177,8 @@ private HttpRequest.Builder addAssetToExternalWalletRequestBuilder( * Create an external wallet Creates a new external wallet with the requested name. External * Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. - You * cannot see the balance of the external wallet. - You cannot initiate transactions from an - * external wallet as the source via Fireblocks. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * external wallet as the source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @param createWalletRequest (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -257,8 +257,8 @@ private HttpRequest.Builder createExternalWalletRequestBuilder( } /** * Delete an external wallet Deletes an external wallet by ID. External Wallet is a whitelisted - * address of a wallet that belongs to your users/counterparties. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param walletId The ID of the wallet to delete (required) * @return CompletableFuture<ApiResponse<Void>> @@ -317,8 +317,8 @@ private HttpRequest.Builder deleteExternalWalletRequestBuilder(String walletId) } /** * Find an external wallet Returns an external wallet by ID. External Wallet is a whitelisted - * address of a wallet that belongs to your users/counterparties. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param walletId The ID of the wallet to return (required) * @return CompletableFuture<ApiResponse<UnmanagedWallet>> @@ -386,8 +386,8 @@ private HttpRequest.Builder getExternalWalletRequestBuilder(String walletId) /** * Get an asset from an external wallet Returns an external wallet by wallet ID and asset ID. * External Wallet is a whitelisted address of a wallet that belongs to your - * users/counterparties. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor, Viewer. * * @param walletId The ID of the wallet (required) * @param assetId The ID of the asset to return (required) @@ -462,8 +462,8 @@ private HttpRequest.Builder getExternalWalletAssetRequestBuilder( * List external wallets Gets a list of external wallets under the workspace. External Wallet is * a whitelisted address of a wallet that belongs to your users/counterparties. - You cannot see * the balance of the external wallet. - You cannot initiate transactions from an external - * wallet as the source via Fireblocks. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor, Viewer. + * wallet as the source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @return CompletableFuture<ApiResponse<List<UnmanagedWallet>>> * @throws ApiException if fails to make API call @@ -526,8 +526,8 @@ private HttpRequest.Builder getExternalWalletsRequestBuilder() throws ApiExcepti return localVarRequestBuilder; } /** - * Delete an asset from an external wallet Deletes an external wallet asset by ID. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Delete an asset from an external wallet Deletes an external wallet asset by ID. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param walletId The ID of the wallet (required) * @param assetId The ID of the asset to delete (required) @@ -593,8 +593,8 @@ private HttpRequest.Builder removeAssetFromExternalWalletRequestBuilder( /** * Set an AML customer reference ID for an external wallet Sets an AML/KYT customer reference ID * for the specific external wallet. External Wallet is a whitelisted address of a wallet that - * belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + * belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @param setCustomerRefIdRequest (required) * @param walletId The wallet ID (required) diff --git a/src/main/java/com/fireblocks/sdk/api/FiatAccountsApi.java b/src/main/java/com/fireblocks/sdk/api/FiatAccountsApi.java index bc2c37f7..64021b27 100644 --- a/src/main/java/com/fireblocks/sdk/api/FiatAccountsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/FiatAccountsApi.java @@ -159,8 +159,8 @@ private HttpRequest.Builder depositFundsFromLinkedDDARequestBuilder( return localVarRequestBuilder; } /** - * Find a specific fiat account Returns a fiat account by ID. </br>Endpoint Permission: - * Admin, Non-Signing Admin. + * Find a specific fiat account Returns a fiat account by ID. Endpoint Permission: Admin, + * Non-Signing Admin. * * @param accountId The ID of the fiat account to return (required) * @return CompletableFuture<ApiResponse<FiatAccount>> @@ -225,8 +225,7 @@ private HttpRequest.Builder getFiatAccountRequestBuilder(String accountId) throw return localVarRequestBuilder; } /** - * List fiat accounts Returns all fiat accounts. </br>Endpoint Permission: Admin, - * Non-Signing Admin. + * List fiat accounts Returns all fiat accounts. Endpoint Permission: Admin, Non-Signing Admin. * * @return CompletableFuture<ApiResponse<List<FiatAccount>>> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/fireblocks/sdk/api/GasStationsApi.java b/src/main/java/com/fireblocks/sdk/api/GasStationsApi.java index 5fbc3506..7572b829 100644 --- a/src/main/java/com/fireblocks/sdk/api/GasStationsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/GasStationsApi.java @@ -74,7 +74,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Get gas station settings by asset Returns gas station settings and balances for a requested - * asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param assetId The ID of the asset (required) * @return CompletableFuture<ApiResponse<GasStationPropertiesResponse>> @@ -142,8 +142,8 @@ private HttpRequest.Builder getGasStationByAssetIdRequestBuilder(String assetId) return localVarRequestBuilder; } /** - * Get gas station settings Returns gas station settings and ETH balance. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Get gas station settings Returns gas station settings and ETH balance. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @return CompletableFuture<ApiResponse<GasStationPropertiesResponse>> * @throws ApiException if fails to make API call @@ -206,8 +206,8 @@ private HttpRequest.Builder getGasStationInfoRequestBuilder() throws ApiExceptio /** * Edit gas station settings Configures gas station settings for ETH. Learn more about the * Fireblocks Gas Station in the following - * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param gasStationConfiguration (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -297,8 +297,8 @@ private HttpRequest.Builder updateGasStationConfigurationRequestBuilder( /** * Edit gas station settings for an asset Configures gas station settings for a requested asset. * Learn more about the Fireblocks Gas Station in the following - * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param gasStationConfiguration (required) * @param assetId The ID of the asset (required) diff --git a/src/main/java/com/fireblocks/sdk/api/NftsApi.java b/src/main/java/com/fireblocks/sdk/api/NftsApi.java index 4fb1835f..06d9989b 100644 --- a/src/main/java/com/fireblocks/sdk/api/NftsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/NftsApi.java @@ -747,8 +747,8 @@ private HttpRequest.Builder refreshNFTMetadataRequestBuilder( /** * Refresh vault account tokens Updates all tokens and balances per blockchain and vault * account. Learn more about Fireblocks NFT management in the following - * [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param blockchainDescriptor Blockchain descriptor filter (required) * @param vaultAccountId Vault account filter (required) diff --git a/src/main/java/com/fireblocks/sdk/api/OffExchangesApi.java b/src/main/java/com/fireblocks/sdk/api/OffExchangesApi.java index c0878845..cd2c5925 100644 --- a/src/main/java/com/fireblocks/sdk/api/OffExchangesApi.java +++ b/src/main/java/com/fireblocks/sdk/api/OffExchangesApi.java @@ -83,7 +83,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Add Collateral Add collateral and create deposit request. Learn more about Fireblocks Off * Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param addCollateralRequestBody (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -165,8 +165,8 @@ private HttpRequest.Builder addOffExchangeRequestBuilder( /** * Find a specific collateral exchange account Returns a collateral account by * mainExchangeAccountId. Learn more about Fireblocks Off Exchange in the following - * [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param mainExchangeAccountId The id of the main exchange account for which the requested * collateral account is associated with (required) @@ -241,8 +241,8 @@ private HttpRequest.Builder getOffExchangeCollateralAccountsRequestBuilder( /** * Get Settlements Transactions Get settlements transactions from exchange. Learn more about * Fireblocks Off Exchange in the following - * [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param mainExchangeAccountId (required) * @return CompletableFuture<ApiResponse<ExchangeSettlementTransactionsResponse>> @@ -331,7 +331,7 @@ private HttpRequest.Builder getOffExchangeSettlementTransactionsRequestBuilder( /** * Remove Collateral Remove collateral, create withdraw request. Learn more about Fireblocks Off * Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param removeCollateralRequestBody (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -413,7 +413,7 @@ private HttpRequest.Builder removeOffExchangeRequestBuilder( /** * Create Settlement for a Trader Create settlement for a trader. Learn more about Fireblocks * Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param settlementRequestBody (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple diff --git a/src/main/java/com/fireblocks/sdk/api/PaymentsPayoutApi.java b/src/main/java/com/fireblocks/sdk/api/PaymentsPayoutApi.java index 1531a152..1263f713 100644 --- a/src/main/java/com/fireblocks/sdk/api/PaymentsPayoutApi.java +++ b/src/main/java/com/fireblocks/sdk/api/PaymentsPayoutApi.java @@ -75,19 +75,17 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Create a payout instruction set **Note:** The reference content in this section documents the * Payments Engine endpoint. The Payments Engine endpoints include APIs available only for - * customers with Payments Engine enabled on their accounts. </br> </br>These - * endpoints are currently in beta and might be subject to changes.</br> </br>If you - * want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer - * Success Manager or email CSM@fireblocks.com. </br> </br> <b u>Create a - * payout instruction set.</b> </u></br> A payout instruction set is a set of - * instructions for distributing payments from a single payment account to a list of payee - * accounts. </br> The instruction set defines: </br> <ul> <li>the - * payment account and its account type (vault, exchange, or fiat). </li> <li>the - * account type (vault account, exchange account, whitelisted address, network connection, fiat - * account, or merchant account), the amount, and the asset of payment for each payee - * account.</li> </ul> Learn more about Fireblocks Payments - Payouts in the - * following [guide](https://developers.fireblocks.com/docs/create-payouts). </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * customers with Payments Engine enabled on their accounts. These endpoints are currently in + * beta and might be subject to changes. If you want to learn more about Fireblocks Payments + * Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. + * **Create a payout instruction set.** A payout instruction set is a set of instructions for + * distributing payments from a single payment account to a list of payee accounts. The + * instruction set defines: - the payment account and its account type (vault, exchange, or + * fiat). - the account type (vault account, exchange account, whitelisted address, network + * connection, fiat account, or merchant account), the amount, and the asset of payment for each + * payee account. Learn more about Fireblocks Payments - Payouts in the following + * [guide](https://developers.fireblocks.com/docs/create-payouts). Endpoint Permission: Admin, + * Non-Signing Admin. * * @param createPayoutRequest (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -166,16 +164,13 @@ private HttpRequest.Builder createPayoutRequestBuilder( /** * Execute a payout instruction set **Note:** The reference content in this section documents * the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for - * customers with Payments Engine enabled on their accounts. </br> </br>These - * endpoints are currently in beta and might be subject to changes.</br> </br>If you - * want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer - * Success Manager or email CSM@fireblocks.com. </br> </br><b u>Execute a - * payout instruction set.</b> </u> </br> </br>The instruction set will - * be verified and executed.</br> <b><u>Source locking</br></b> - * </u> If you are executing a payout instruction set from a payment account with an - * already active payout the active payout will complete before the new payout instruction set - * can be executed. </br> You cannot execute the same payout instruction set more than - * once. + * customers with Payments Engine enabled on their accounts. These endpoints are currently in + * beta and might be subject to changes. If you want to learn more about Fireblocks Payments + * Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. + * **Execute a payout instruction set.** The instruction set will be verified and executed. + * **Source locking** If you are executing a payout instruction set from a payment account with + * an already active payout the active payout will complete before the new payout instruction + * set can be executed. You cannot execute the same payout instruction set more than once. * * @param payoutId the payout id received from the creation of the payout instruction set * (required) @@ -252,11 +247,10 @@ private HttpRequest.Builder executePayoutActionRequestBuilder( /** * Get the status of a payout instruction set **Note:** The reference content in this section * documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available - * only for customers with Payments Engine enabled on their accounts. </br> - * </br>These endpoints are currently in beta and might be subject to changes.</br> - * </br>If you want to learn more about Fireblocks Payments Engine, please contact your - * Fireblocks Customer Success Manager or email CSM@fireblocks.com. </br> - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * only for customers with Payments Engine enabled on their accounts. These endpoints are + * currently in beta and might be subject to changes. If you want to learn more about Fireblocks + * Payments Engine, please contact your Fireblocks Customer Success Manager or email + * CSM@fireblocks.com. Endpoint Permission: Admin, Non-Signing Admin. * * @param payoutId the payout id received from the creation of the payout instruction set * (required) diff --git a/src/main/java/com/fireblocks/sdk/api/PolicyEditorBetaApi.java b/src/main/java/com/fireblocks/sdk/api/PolicyEditorBetaApi.java index 7599e817..4c061e87 100644 --- a/src/main/java/com/fireblocks/sdk/api/PolicyEditorBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/PolicyEditorBetaApi.java @@ -76,12 +76,12 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Get the active policy and its validation Legacy Endpoint – Returns the active policy and its - * validation. </br> **Note:** - This endpoint will remain available for the foreseeable - * future and is not deprecated.</br> - The `getActivePolicy` endpoint under - * policy/paths provides policy type-specific operations and improved functionality.</br> - * - These endpoints are currently in beta and might be subject to changes.</br> If you - * want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks - * Customer Success Manager or send an email to CSM@fireblocks.com. + * validation. **Note:** - This endpoint will remain available for the foreseeable future and is + * not deprecated. - The `getActivePolicy` endpoint under policy/paths provides policy + * type-specific operations and improved functionality. - These endpoints are currently in beta + * and might be subject to changes. If you want to participate and learn more about the + * Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to + * CSM@fireblocks.com. * * @return CompletableFuture<ApiResponse<LegacyPolicyAndValidationResponse>> * @throws ApiException if fails to make API call @@ -143,13 +143,12 @@ private HttpRequest.Builder getActivePolicyLegacyRequestBuilder() throws ApiExce return localVarRequestBuilder; } /** - * Get the active draft Legacy Endpoint – Returns the active draft and its validation. - * </br> **Note:** - This endpoint will remain available for the foreseeable future and is - * not deprecated.</br> - The `getDraft` endpoint under policy/paths provides - * policy type-specific operations and improved functionality.</br> - These endpoints are - * currently in beta and might be subject to changes.</br> If you want to participate and - * learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager - * or send an email to CSM@fireblocks.com. + * Get the active draft Legacy Endpoint – Returns the active draft and its validation. **Note:** + * - This endpoint will remain available for the foreseeable future and is not deprecated. - The + * `getDraft` endpoint under policy/paths provides policy type-specific operations and + * improved functionality. - These endpoints are currently in beta and might be subject to + * changes. If you want to participate and learn more about the Fireblocks TAP, please contact + * your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. * * @return CompletableFuture<ApiResponse<LegacyDraftReviewAndValidationResponse>> * @throws ApiException if fails to make API call @@ -211,13 +210,12 @@ private HttpRequest.Builder getDraftLegacyRequestBuilder() throws ApiException { } /** * Send publish request for a certain draft id Legacy Endpoint – Send publish request of certain - * draft id and returns the response. </br> **Note:** - This endpoint will remain - * available for the foreseeable future and is not deprecated.</br> - The - * `publishDraft` endpoint under policy/paths provides improved functionality and - * better performance.</br> - These endpoints are currently in beta and might be subject - * to changes.</br> If you want to participate and learn more about the Fireblocks TAP, - * please contact your Fireblocks Customer Success Manager or send an email to - * CSM@fireblocks.com. + * draft id and returns the response. **Note:** - This endpoint will remain available for the + * foreseeable future and is not deprecated. - The `publishDraft` endpoint under + * policy/paths provides improved functionality and better performance. - These endpoints are + * currently in beta and might be subject to changes. If you want to participate and learn more + * about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an + * email to CSM@fireblocks.com. * * @param legacyPublishDraftRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -301,9 +299,9 @@ private HttpRequest.Builder publishDraftLegacyRequestBuilder( } /** * Send publish request for a set of policy rules Send publish request of set of policy rules - * and returns the response. </br> **Note:** These endpoints are currently in beta and - * might be subject to changes. If you want to participate and learn more about the Fireblocks - * TAP, please contact your Fireblocks Customer Success Manager or send an email to + * and returns the response. **Note:** These endpoints are currently in beta and might be + * subject to changes. If you want to participate and learn more about the Fireblocks TAP, + * please contact your Fireblocks Customer Success Manager or send an email to * CSM@fireblocks.com. * * @param legacyPolicyRules (required) @@ -385,12 +383,12 @@ private HttpRequest.Builder publishPolicyRulesRequestBuilder( } /** * Update the draft with a new set of rules Legacy Endpoint – Update the draft and return its - * validation. </br> **Note:** - This endpoint will remain available for the foreseeable - * future and is not deprecated.</br> - The `updateDraft` endpoint under - * policy/paths provides policy type-specific operations and improved functionality.</br> - * - These endpoints are currently in beta and might be subject to changes.</br> If you - * want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks - * Customer Success Manager or send an email to CSM@fireblocks.com. + * validation. **Note:** - This endpoint will remain available for the foreseeable future and is + * not deprecated. - The `updateDraft` endpoint under policy/paths provides policy + * type-specific operations and improved functionality. - These endpoints are currently in beta + * and might be subject to changes. If you want to participate and learn more about the + * Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to + * CSM@fireblocks.com. * * @param legacyPolicyRules (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple diff --git a/src/main/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApi.java b/src/main/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApi.java index 6b403879..09cc50c7 100644 --- a/src/main/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApi.java @@ -167,8 +167,8 @@ private HttpRequest.Builder getActivePolicyRequestBuilder(PolicyType policyType) } /** * Get the active draft by policy type Returns the active draft and its validation for a - * specific policy type. </br> **Note:** These endpoints are currently in beta and might - * be subject to changes. + * specific policy type. **Note:** These endpoints are currently in beta and might be subject to + * changes. * * @param policyType The policy type(s) to retrieve. Can be a single type or multiple types by * repeating the parameter (e.g., ?policyType=TRANSFER&policyType=MINT). @@ -250,10 +250,9 @@ private HttpRequest.Builder getDraftRequestBuilder(PolicyType policyType) throws } /** * Send publish request for a certain draft id Send publish request of certain draft id and - * returns the response. </br> **Note:** These endpoints are currently in beta and might - * be subject to changes. If you want to participate and learn more about the Fireblocks Policy - * Editor, please contact your Fireblocks Customer Success Manager or send an email to - * CSM@fireblocks.com. + * returns the response. **Note:** These endpoints are currently in beta and might be subject to + * changes. If you want to participate and learn more about the Fireblocks Policy Editor, please + * contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. * * @param publishDraftRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -333,8 +332,8 @@ private HttpRequest.Builder publishDraftRequestBuilder( } /** * Update the draft with a new set of rules by policy types Update the draft and return its - * validation for specific policy types. </br> **Note:** These endpoints are currently in - * beta and might be subject to changes. + * validation for specific policy types. **Note:** These endpoints are currently in beta and + * might be subject to changes. * * @param updateDraftRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple diff --git a/src/main/java/com/fireblocks/sdk/api/ResetDeviceApi.java b/src/main/java/com/fireblocks/sdk/api/ResetDeviceApi.java index 28332aa5..9cace92a 100644 --- a/src/main/java/com/fireblocks/sdk/api/ResetDeviceApi.java +++ b/src/main/java/com/fireblocks/sdk/api/ResetDeviceApi.java @@ -70,8 +70,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Resets device Resets mobile device for given console user, that user will need to do mobile * onboarding again. - Please note that this endpoint is available only for API keys with - * Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing - * Admin. + * Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * * @param id The ID of the console user (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple diff --git a/src/main/java/com/fireblocks/sdk/api/SmartTransferApi.java b/src/main/java/com/fireblocks/sdk/api/SmartTransferApi.java index 909ac365..f60e46c3 100644 --- a/src/main/java/com/fireblocks/sdk/api/SmartTransferApi.java +++ b/src/main/java/com/fireblocks/sdk/api/SmartTransferApi.java @@ -190,8 +190,8 @@ private HttpRequest.Builder approveDvPTicketTermRequestBuilder( return localVarRequestBuilder; } /** - * Cancel Ticket Cancel Smart Transfer ticket. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * Cancel Ticket Cancel Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @param ticketId (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -352,8 +352,8 @@ private HttpRequest.Builder createTicketRequestBuilder( /** * Create leg (term) Creates new smart transfer ticket term (when the ticket status is DRAFT). * Learn more about Fireblocks Smart Transfers in the following - * [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferCreateTicketTerm (required) * @param ticketId (required) @@ -444,8 +444,8 @@ private HttpRequest.Builder createTicketTermRequestBuilder( return localVarRequestBuilder; } /** - * Search Ticket by ID Find Smart Transfer ticket by id. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Search Ticket by ID Find Smart Transfer ticket by id. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor, Viewer. * * @param ticketId (required) * @return CompletableFuture<ApiResponse<SmartTransferTicketResponse>> @@ -511,7 +511,7 @@ private HttpRequest.Builder findTicketByIdRequestBuilder(String ticketId) throws } /** * Get Smart Transfer ticket term Find a specific term of a specific Smart Transfer ticket. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param ticketId (required) * @param termId (required) @@ -583,7 +583,7 @@ private HttpRequest.Builder findTicketTermByIdRequestBuilder(String ticketId, St } /** * Fund ticket manually Manually fulfill ticket, in case when all terms (legs) are funded - * manually. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * manually. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param ticketId (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -748,8 +748,8 @@ private HttpRequest.Builder fundDvpTicketRequestBuilder( } /** * Define funding source Set funding source for ticket term (in case of ASYNC tickets, this will - * execute transfer immediately). </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor. + * execute transfer immediately). Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @param smartTransferFundTerm (required) * @param ticketId (required) @@ -907,8 +907,8 @@ private HttpRequest.Builder getSmartTransferStatisticRequestBuilder() throws Api return localVarRequestBuilder; } /** - * Get user group Get Smart Transfer user groups. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Get user group Get Smart Transfer user groups. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, Viewer. * * @return CompletableFuture<ApiResponse<SmartTransferUserGroupsResponse>> * @throws ApiException if fails to make API call @@ -971,8 +971,8 @@ private HttpRequest.Builder getSmartTransferUserGroupsRequestBuilder() throws Ap return localVarRequestBuilder; } /** - * Manually add term transaction Manually set ticket term transaction. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Manually add term transaction Manually set ticket term transaction. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferManuallyFundTerm (required) * @param ticketId (required) @@ -1286,8 +1286,8 @@ private HttpRequest.Builder searchTicketsRequestBuilder( return localVarRequestBuilder; } /** - * Add external ref. ID Set external id Smart Transfer ticket. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * Add external ref. ID Set external id Smart Transfer ticket. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferSetTicketExternalId (required) * @param ticketId (required) @@ -1380,8 +1380,8 @@ private HttpRequest.Builder setExternalRefIdRequestBuilder( return localVarRequestBuilder; } /** - * Set expiration Set expiration date on Smart Transfer ticket. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * Set expiration Set expiration date on Smart Transfer ticket. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferSetTicketExpiration (required) * @param ticketId (required) @@ -1476,8 +1476,7 @@ private HttpRequest.Builder setTicketExpirationRequestBuilder( } /** * Set user group Set Smart Transfers user group to receive email notifications for Smart - * Transfers. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * Transfers. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferSetUserGroups (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -1560,8 +1559,8 @@ private HttpRequest.Builder setUserGroupsRequestBuilder( } /** * Submit ticket Submit Smart Transfer ticket - change status into ready for approval if auto - * approval is not turned on, or OPEN if auto approval is on. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * approval is not turned on, or OPEN if auto approval is on. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param smartTransferSubmitTicket (required) * @param ticketId (required) diff --git a/src/main/java/com/fireblocks/sdk/api/StakingApi.java b/src/main/java/com/fireblocks/sdk/api/StakingApi.java index 16f59ae5..d41912fc 100644 --- a/src/main/java/com/fireblocks/sdk/api/StakingApi.java +++ b/src/main/java/com/fireblocks/sdk/api/StakingApi.java @@ -159,12 +159,12 @@ private HttpRequest.Builder approveTermsOfServiceByProviderIdRequestBuilder( } /** * Claim accrued rewards Claims available staking rewards for the specified chain and vault. - * Supported chains: Solana and Polygon (Matic). Behavior depends on protocol reward + * Supported chains: Solana and Polygon (POL/Matic). Behavior depends on protocol reward * distribution. * * @param claimRewardsRequest (required) * @param chainDescriptor Protocol identifier for the claim rewards staking operation (e.g., - * MATIC/SOL). (required) + * POL/MATIC/SOL). (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple * times with the same idempotency key, the server will return the same response as the * first request. The idempotency key is valid for 24 hours. (optional) @@ -242,12 +242,11 @@ private HttpRequest.Builder claimRewardsRequestBuilder( /** * Consolidate staking positions (ETH validator consolidation) Consolidates the source staking * position into the destination, merging the balance into the destination and closing the - * source position once complete. Both positions must be from the same funding vaults account - * (i.e. same withdrawals credentials). On chain, this translates into a consolidation - * transaction, where the source validator is consolidated into the destination validator. - * Supported chains: Ethereum (ETH) only. </br>Endpoint Permission: Owner, Admin, - * Non-Signing Admin, Signer, Approver, Editor. **Note:** This endpoint is currently in beta and - * might be subject to changes. + * source position once complete. Both positions must be from the same vault account (i.e. same + * withdrawal credentials). On chain, this translates into a consolidation transaction, where + * the source validator is consolidated into the destination validator. Supported chains: + * Ethereum (ETH) only. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, + * Editor. **Note:** This endpoint is currently in beta and might be subject to changes. * * @param mergeStakeAccountsRequest (required) * @param chainDescriptor Protocol identifier for the staking operation (e.g., ETH). (required) @@ -342,12 +341,11 @@ private HttpRequest.Builder consolidateRequestBuilder( } /** * List staking positions Returns all staking positions with core details: amounts, rewards, - * status, chain, and vault. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor. + * status, chain, and vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor. * - * @param chainDescriptor Protocol identifier to filter positions (e.g., - * ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. - * (optional) + * @param chainDescriptor Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). + * If omitted, positions across all supported chains are returned. (optional) * @param vaultAccountId Filter positions by vault account ID. (optional) * @return CompletableFuture<ApiResponse<List<Delegation>>> * @throws ApiException if fails to make API call @@ -502,8 +500,8 @@ private HttpRequest.Builder getChainInfoRequestBuilder(ChainDescriptor chainDesc } /** * List supported staking chains Returns an alphabetical list of blockchains supported for - * staking by the current workspace context. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + * staking by the current workspace context. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @return CompletableFuture<ApiResponse<List<ChainDescriptor>>> * @throws ApiException if fails to make API call @@ -632,13 +630,12 @@ private HttpRequest.Builder getDelegationByIdRequestBuilder(String id) throws Ap * List staking positions (Paginated) Returns staking positions with core details: amounts, * rewards, status, chain, and vault. It supports cursor-based pagination for efficient data * retrieval. This endpoint always returns a paginated response with {data, next} structure. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param pageSize Number of results per page. When provided, the response returns a paginated * object with {data, next}. If omitted, all results are returned as an array. (required) - * @param chainDescriptor Protocol identifier to filter positions (e.g., - * ATOM_COS/AXL/CELESTIA}). If omitted, positions across all supported chains are returned. - * (optional) + * @param chainDescriptor Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA). + * If omitted, positions across all supported chains are returned. (optional) * @param vaultAccountId Filter positions by Fireblocks vault account ID. If omitted, positions * across all vault accounts are returned. (optional) * @param pageCursor Cursor for the next page of results. Use the value from the 'next' @@ -742,8 +739,8 @@ private HttpRequest.Builder getPositionsRequestBuilder( } /** * List staking providers Returns all available staking providers with metadata such as name, - * ID, and supported chains. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor. + * ID, and supported chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor. * * @return CompletableFuture<ApiResponse<List<Provider>>> * @throws ApiException if fails to make API call @@ -931,8 +928,7 @@ private HttpRequest.Builder getSummaryByVaultRequestBuilder() throws ApiExceptio * Merge staking positions Merges the source stake account into the destination, consolidating * the balance into the destination and closing the source account once complete. Both accounts * must be from the same validator provider and of same vault account.. Supported chains: Solana - * (SOL). </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * (SOL). Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param mergeStakeAccountsRequest (required) * @param chainDescriptor Protocol identifier for the merge staking operation (e.g., SOL). @@ -1122,8 +1118,8 @@ private HttpRequest.Builder splitRequestBuilder( * position. For Ethereum legacy validator: creates a new position regardless of existing * delegations. For Cosmos chains and Ethereum liquid staking (Lido): automatically add to * existing positions for the same validator provider and same vault account if one exists, - * otherwise create a new position. For Solana and Polygon: always create new positions - * regardless of existing delegations. + * otherwise create a new position. For Solana and Polygon (MATIC/POL): always create new + * positions regardless of existing delegations. * * @param stakeRequest (required) * @param chainDescriptor Protocol identifier for the stake staking operation (e.g., @@ -1289,7 +1285,10 @@ private HttpRequest.Builder unstakeRequestBuilder( /** * Withdraw staked funds Withdraws funds that have completed the unbonding period. Typically * requires the position to be deactivated first (unstake → unbond → withdraw). Amount and - * timing vary by chain protocol. + * timing vary by chain protocol. Partial withdrawal is supported for ETH compounding validators + * (EIP-7251/Pectra) and Cosmos chains via the optional 'amount' field. For ETH + * compounding validators, the remaining balance must be at least 32 ETH after the withdrawal. + * For all other chains, omitting 'amount' withdraws the entire available balance. * * @param withdrawRequest (required) * @param chainDescriptor Protocol identifier for the withdraw staking operation (e.g., diff --git a/src/main/java/com/fireblocks/sdk/api/TokenizationApi.java b/src/main/java/com/fireblocks/sdk/api/TokenizationApi.java index 7d3b0bb6..8c4132c4 100644 --- a/src/main/java/com/fireblocks/sdk/api/TokenizationApi.java +++ b/src/main/java/com/fireblocks/sdk/api/TokenizationApi.java @@ -192,8 +192,8 @@ private HttpRequest.Builder burnCollectionTokenRequestBuilder( return localVarRequestBuilder; } /** - * Create a new collection Create a new collection and link it as a token. </br>Endpoint - * Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. + * Create a new collection Create a new collection and link it as a token. Endpoint Permission: + * Owner, Admin, Non-Signing Admin, Signer, and Editor. * * @param collectionDeployRequestDto (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -841,8 +841,8 @@ private HttpRequest.Builder getLayerZeroPeersRequestBuilder(UUID adapterTokenLin return localVarRequestBuilder; } /** - * Get collections Get collections (paginated). </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Get collections Get collections (paginated). Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, Viewer. * * @param pageCursor Page cursor to get the next page, for example - * \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\" (optional) @@ -1152,8 +1152,8 @@ private HttpRequest.Builder getLinkedTokensCountRequestBuilder() throws ApiExcep * blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created * token directly to the workspace without deploying a contract. Returns the token link with * status \"PENDING\" until the token is deployed or \"SUCCESS\" if no - * deployment is needed. </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, - * Signer, and Editor. + * deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and + * Editor. * * @param createTokenRequestDto (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple diff --git a/src/main/java/com/fireblocks/sdk/api/TrLinkApi.java b/src/main/java/com/fireblocks/sdk/api/TrLinkApi.java index 56a04c32..0381a056 100644 --- a/src/main/java/com/fireblocks/sdk/api/TrLinkApi.java +++ b/src/main/java/com/fireblocks/sdk/api/TrLinkApi.java @@ -31,11 +31,15 @@ import com.fireblocks.sdk.model.TRLinkCreateTrmRequest; import com.fireblocks.sdk.model.TRLinkCustomerIntegrationResponse; import com.fireblocks.sdk.model.TRLinkCustomerResponse; +import com.fireblocks.sdk.model.TRLinkGetRequiredActionsResponse; import com.fireblocks.sdk.model.TRLinkGetSupportedAssetResponse; +import com.fireblocks.sdk.model.TRLinkManualDecisionRequest; +import com.fireblocks.sdk.model.TRLinkManualDecisionResponse; import com.fireblocks.sdk.model.TRLinkPartnerResponse; import com.fireblocks.sdk.model.TRLinkPolicyResponse; import com.fireblocks.sdk.model.TRLinkPublicKeyResponse; import com.fireblocks.sdk.model.TRLinkRedirectTrmRequest; +import com.fireblocks.sdk.model.TRLinkResolveActionRequest; import com.fireblocks.sdk.model.TRLinkSetDestinationTravelRuleMessageIdRequest; import com.fireblocks.sdk.model.TRLinkSetDestinationTravelRuleMessageIdResponse; import com.fireblocks.sdk.model.TRLinkSetTransactionTravelRuleMessageIdRequest; @@ -579,6 +583,116 @@ private HttpRequest.Builder createTRLinkIntegrationRequestBuilder( } return localVarRequestBuilder; } + /** + * Manual decision for missing TRM Accept or reject destinations stuck in NoTRM step without + * waiting for TRP webhook or policy timeout. + * + * @param trLinkManualDecisionRequest (required) + * @param customerIntegrationId Customer integration unique identifier (required) + * @param txId Fireblocks transaction unique identifier (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<TRLinkManualDecisionResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> createTRLinkManualDecision( + TRLinkManualDecisionRequest trLinkManualDecisionRequest, + UUID customerIntegrationId, + UUID txId, + String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + createTRLinkManualDecisionRequestBuilder( + trLinkManualDecisionRequest, + customerIntegrationId, + txId, + idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "createTRLinkManualDecision", + localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + TRLinkManualDecisionResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder createTRLinkManualDecisionRequestBuilder( + TRLinkManualDecisionRequest trLinkManualDecisionRequest, + UUID customerIntegrationId, + UUID txId, + String idempotencyKey) + throws ApiException { + ValidationUtils.assertParamExists( + "createTRLinkManualDecision", + "trLinkManualDecisionRequest", + trLinkManualDecisionRequest); + ValidationUtils.assertParamExistsAndNotEmpty( + "createTRLinkManualDecision", + "customerIntegrationId", + customerIntegrationId.toString()); + ValidationUtils.assertParamExistsAndNotEmpty( + "createTRLinkManualDecision", "txId", txId.toString()); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision" + .replace( + "{customerIntegrationId}", + ApiClient.urlEncode(customerIntegrationId.toString())) + .replace("{txId}", ApiClient.urlEncode(txId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Content-Type", "application/json"); + localVarRequestBuilder.header("Accept", "application/json"); + + try { + byte[] localVarPostBody = + memberVarObjectMapper.writeValueAsBytes(trLinkManualDecisionRequest); + localVarRequestBuilder.method( + "POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); + } catch (IOException e) { + throw new ApiException(e); + } + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Create Travel Rule Message Creates a new travel rule message with IVMS101-compliant PII data. * Encrypts sensitive originator and beneficiary information before sending to partner. @@ -1449,6 +1563,85 @@ private HttpRequest.Builder getTRLinkTrmByIdRequestBuilder( } return localVarRequestBuilder; } + /** + * Get required actions for a TRM Retrieves the list of required actions (e.g., PII fields) + * needed to process the Travel Rule Message. + * + * @param customerIntegrationId Customer integration unique identifier (required) + * @param trmId Travel Rule Message unique identifier (required) + * @return CompletableFuture<ApiResponse<TRLinkGetRequiredActionsResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> + getTRLinkTrmRequiredActions(UUID customerIntegrationId, String trmId) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + getTRLinkTrmRequiredActionsRequestBuilder(customerIntegrationId, trmId); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "getTRLinkTrmRequiredActions", + localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + TRLinkGetRequiredActionsResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder getTRLinkTrmRequiredActionsRequestBuilder( + UUID customerIntegrationId, String trmId) throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "getTRLinkTrmRequiredActions", + "customerIntegrationId", + customerIntegrationId.toString()); + ValidationUtils.assertParamExistsAndNotEmpty("getTRLinkTrmRequiredActions", "trmId", trmId); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions" + .replace( + "{customerIntegrationId}", + ApiClient.urlEncode(customerIntegrationId.toString())) + .replace("{trmId}", ApiClient.urlEncode(trmId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Get VASP by ID Retrieves detailed information about a specific VASP by its unique identifier. * Returns VASP details including public key if available. @@ -1810,6 +2003,112 @@ private HttpRequest.Builder redirectTRLinkTrmRequestBuilder( } return localVarRequestBuilder; } + /** + * Resolve action for a TRM Submits required data (e.g., beneficiary PII) to resolve a pending + * Travel Rule Message action. + * + * @param trLinkResolveActionRequest (required) + * @param customerIntegrationId Customer integration unique identifier (required) + * @param trmId Travel Rule Message unique identifier (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<TRLinkTrmInfoResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> resolveActionTRLinkTrm( + TRLinkResolveActionRequest trLinkResolveActionRequest, + UUID customerIntegrationId, + String trmId, + String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + resolveActionTRLinkTrmRequestBuilder( + trLinkResolveActionRequest, + customerIntegrationId, + trmId, + idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "resolveActionTRLinkTrm", localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + TRLinkTrmInfoResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder resolveActionTRLinkTrmRequestBuilder( + TRLinkResolveActionRequest trLinkResolveActionRequest, + UUID customerIntegrationId, + String trmId, + String idempotencyKey) + throws ApiException { + ValidationUtils.assertParamExists( + "resolveActionTRLinkTrm", "trLinkResolveActionRequest", trLinkResolveActionRequest); + ValidationUtils.assertParamExistsAndNotEmpty( + "resolveActionTRLinkTrm", + "customerIntegrationId", + customerIntegrationId.toString()); + ValidationUtils.assertParamExistsAndNotEmpty("resolveActionTRLinkTrm", "trmId", trmId); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_action" + .replace( + "{customerIntegrationId}", + ApiClient.urlEncode(customerIntegrationId.toString())) + .replace("{trmId}", ApiClient.urlEncode(trmId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Content-Type", "application/json"); + localVarRequestBuilder.header("Accept", "application/json"); + + try { + byte[] localVarPostBody = + memberVarObjectMapper.writeValueAsBytes(trLinkResolveActionRequest); + localVarRequestBuilder.method( + "POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); + } catch (IOException e) { + throw new ApiException(e); + } + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Set destination travel rule message ID Associates a Travel Rule Message ID with a specific * destination in a multi-destination Fireblocks transaction. Matches destinations by amount and diff --git a/src/main/java/com/fireblocks/sdk/api/TransactionsApi.java b/src/main/java/com/fireblocks/sdk/api/TransactionsApi.java index 0c50404e..491f931e 100644 --- a/src/main/java/com/fireblocks/sdk/api/TransactionsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/TransactionsApi.java @@ -89,8 +89,8 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Cancel a transaction Cancels a transaction by Fireblocks Transaction ID. Can be used only for - * transactions that did not get to the BROADCASTING state. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * transactions that did not get to the BROADCASTING state. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @param txId The ID of the transaction to cancel (required) * @param xEndUserWalletId Unique ID of the End-User wallet to the API request. Required for @@ -258,8 +258,8 @@ private HttpRequest.Builder createTransactionRequestBuilder( } /** * Drop ETH (EVM) transaction by ID Drops a stuck ETH (EVM) transaction and creates a - * replacement transaction with 0 amount. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + * replacement transaction with 0 amount. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @param txId The ID of the transaction (required) * @param dropTransactionRequest (optional) @@ -368,8 +368,8 @@ private HttpRequest.Builder dropTransactionRequestBuilder( * `feePerByte` parameters. - For XRP and XLM, the response will contain the * transaction fee. - For other assets, the response will contain the `networkFee` * parameter. Learn more about Fireblocks Fee Management in the following - * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param assetId The asset for which to estimate the fee (required) * @return CompletableFuture<ApiResponse<EstimatedNetworkFeeResponse>> @@ -453,9 +453,11 @@ private HttpRequest.Builder estimateNetworkFeeRequestBuilder(String assetId) * Estimate transaction fee Estimates the transaction fee for a specific transaction request. * This endpoint simulates a transaction which means that the system will expect to have the * requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets - * except ZCash (ZEC). Learn more about Fireblocks Fee Management in the following - * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). - * </br>Endpoint Permission: Admin, Signer, Approver, Editor. + * except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee + * estimation for Solana program calls is not available. Learn more about Fireblocks Fee + * Management in the following + * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint + * Permission: Admin, Signer, Approver, Editor. * * @param transactionRequest (optional) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -536,7 +538,7 @@ private HttpRequest.Builder estimateTransactionFeeRequestBuilder( * Freeze a transaction Freezes a transaction by ID. Usually used for AML integrations when the * incoming funds should be quarantined. For account based assets - the entire amount of the * transaction is frozen For UTXO based assets - all UTXOs of the specified transaction are - * frozen </br>Endpoint Permission: Admin, Non-Signing Admin. + * frozen Endpoint Permission: Admin, Non-Signing Admin. * * @param txId The ID of the transaction to freeze (required) * @param xEndUserWalletId Unique ID of the End-User wallet to the API request. Required for @@ -615,8 +617,8 @@ private HttpRequest.Builder freezeTransactionRequestBuilder( } /** * Get a specific transaction by Fireblocks transaction ID Get a specific transaction data by - * Fireblocks Transaction ID </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * Fireblocks Transaction ID Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor, Viewer. * * @param txId The ID of the transaction to return (required) * @return CompletableFuture<ApiResponse<TransactionResponse>> @@ -681,8 +683,8 @@ private HttpRequest.Builder getTransactionRequestBuilder(String txId) throws Api } /** * Get a specific transaction by external transaction ID Returns transaction by external - * transaction ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor, Viewer. + * transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param externalTxId The external ID of the transaction to return (required) * @return CompletableFuture<ApiResponse<TransactionResponse>> @@ -941,8 +943,8 @@ private HttpRequest.Builder getTransactionsRequestBuilder( } /** * Set confirmation threshold by transaction hash Overrides the required number of confirmations - * for transaction completion by transaction hash. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * for transaction completion by transaction hash. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @param txHash The TxHash (required) * @param setConfirmationsThresholdRequest (optional) @@ -1036,8 +1038,8 @@ private HttpRequest.Builder setConfirmationThresholdByTransactionHashRequestBuil } /** * Set confirmation threshold by Fireblocks Transaction ID Overrides the required number of - * confirmations for transaction completion Fireblocks Transaction ID. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * confirmations for transaction completion Fireblocks Transaction ID. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param txId The ID of the transaction (required) * @param setConfirmationsThresholdRequest (optional) @@ -1131,7 +1133,7 @@ private HttpRequest.Builder setTransactionConfirmationThresholdRequestBuilder( } /** * Unfreeze a transaction Unfreezes a transaction by Fireblocks Transaction ID and makes the - * transaction available again. </br>Endpoint Permission: Admin, Non-Signing Admin. + * transaction available again. Endpoint Permission: Admin, Non-Signing Admin. * * @param txId The ID of the transaction to unfreeze (required) * @param xEndUserWalletId Unique ID of the End-User wallet to the API request. Required for @@ -1211,7 +1213,7 @@ private HttpRequest.Builder unfreezeTransactionRequestBuilder( } /** * Validate destination address Checks if an address is valid and active (for XRP, DOT, XLM, and - * EOS). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * EOS). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param assetId The asset of the address (required) * @param address The address to validate (required) diff --git a/src/main/java/com/fireblocks/sdk/api/UserGroupsBetaApi.java b/src/main/java/com/fireblocks/sdk/api/UserGroupsBetaApi.java index 827f4a33..1160e463 100644 --- a/src/main/java/com/fireblocks/sdk/api/UserGroupsBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/UserGroupsBetaApi.java @@ -77,7 +77,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Create user group Create a new user group. Users with the Viewer role cannot be added to - * groups. </br>Endpoint Permission: Admin, Non-Signing Admin. + * groups. Endpoint Permission: Admin, Non-Signing Admin. * * @param userGroupCreateRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -159,9 +159,9 @@ private HttpRequest.Builder createUserGroupRequestBuilder( return localVarRequestBuilder; } /** - * Delete user group Delete a user group by ID.</br> **Note**: - This endpoint is now in - * Beta, disabled for general availability at this time. - Please note that this endpoint is - * available only for API keys with Admin permissions. + * Delete user group Delete a user group by ID. **Note**: - This endpoint is now in Beta, + * disabled for general availability at this time. - Please note that this endpoint is available + * only for API keys with Admin permissions. * * @param groupId The ID of the user group (required) * @return CompletableFuture<ApiResponse<Void>> @@ -216,9 +216,9 @@ private HttpRequest.Builder deleteUserGroupRequestBuilder(String groupId) throws return localVarRequestBuilder; } /** - * Get user group Get a user group by ID.</br> **Note**: - This endpoint is now in Beta, - * disabled for general availability at this time. - Please note that this endpoint is available - * only for API keys with Admin permissions. + * Get user group Get a user group by ID. **Note**: - This endpoint is now in Beta, disabled for + * general availability at this time. - Please note that this endpoint is available only for API + * keys with Admin permissions. * * @param groupId The ID of the user group (required) * @return CompletableFuture<ApiResponse<UserGroupResponse>> @@ -284,8 +284,8 @@ private HttpRequest.Builder getUserGroupRequestBuilder(String groupId) throws Ap } /** * List user groups Get all user groups in your workspace - Please note that this endpoint is - * available only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: + * Admin, Non-Signing Admin. * * @return CompletableFuture<ApiResponse<List<UserGroupResponse>>> * @throws ApiException if fails to make API call @@ -347,9 +347,9 @@ private HttpRequest.Builder getUserGroupsRequestBuilder() throws ApiException { return localVarRequestBuilder; } /** - * Update user group Update a user group by ID.</br> **Note**: - This endpoint is now in - * Beta, disabled for general availability at this time. - Please note that this endpoint is - * available only for API keys with Admin permissions. + * Update user group Update a user group by ID. **Note**: - This endpoint is now in Beta, + * disabled for general availability at this time. - Please note that this endpoint is available + * only for API keys with Admin permissions. * * @param userGroupUpdateRequest (required) * @param groupId The ID of the user group (required) diff --git a/src/main/java/com/fireblocks/sdk/api/UtxoManagementBetaApi.java b/src/main/java/com/fireblocks/sdk/api/UtxoManagementBetaApi.java index b899524a..0f43aa85 100644 --- a/src/main/java/com/fireblocks/sdk/api/UtxoManagementBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/UtxoManagementBetaApi.java @@ -80,8 +80,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String * List unspent outputs (UTXOs) Returns a paginated list of unspent transaction outputs (UTXOs) * for a UTXO-based asset in a vault account, with optional filters for labels, statuses, * amounts, and more. **Note:** These endpoints are currently in beta and might be subject to - * changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, - * Viewer. + * changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param vaultAccountId The ID of the vault account (required) * @param assetId The ID of the asset (required) @@ -258,8 +257,8 @@ private HttpRequest.Builder getUtxosRequestBuilder( * account. Labels can be used for organizing and filtering UTXOs. Labels are applied additively * — `labelsToAttach` adds to the existing label set and `labelsToDetach` * removes from it. Neither operation replaces the full set. **Note:** These endpoints are - * currently in beta and might be subject to changes. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @param attachDetachUtxoLabelsRequest (required) * @param vaultAccountId The ID of the vault account (required) diff --git a/src/main/java/com/fireblocks/sdk/api/VaultsApi.java b/src/main/java/com/fireblocks/sdk/api/VaultsApi.java index 1bd5413f..705f66d1 100644 --- a/src/main/java/com/fireblocks/sdk/api/VaultsApi.java +++ b/src/main/java/com/fireblocks/sdk/api/VaultsApi.java @@ -20,6 +20,8 @@ import com.fireblocks.sdk.ApiResponse; import com.fireblocks.sdk.Pair; import com.fireblocks.sdk.ValidationUtils; +import com.fireblocks.sdk.model.CircleGatewayWalletInfoResponse; +import com.fireblocks.sdk.model.CircleGatewayWalletStatusResponse; import com.fireblocks.sdk.model.CreateAddressRequest; import com.fireblocks.sdk.model.CreateAddressResponse; import com.fireblocks.sdk.model.CreateAssetsRequest; @@ -106,8 +108,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Activate a wallet in a vault account Initiates activation for a wallet in a vault account. * Activation is required for tokens that need an on-chain transaction for creation (XLM tokens, - * SOL tokens etc). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * SOL tokens etc). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The ID of the vault account to return, or 'default' for the * default vault account (required) @@ -215,6 +216,87 @@ private HttpRequest.Builder activateAssetForVaultAccountRequestBuilder( } return localVarRequestBuilder; } + /** + * Activate a Circle Gateway wallet Activates the Circle Gateway wallet associated with the + * given vault account. If the wallet does not yet exist it is created in an activated state. + * **Note:** This endpoint is currently in beta and might be subject to changes. + * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + * + * @param vaultAccountId The ID of the vault account (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<CircleGatewayWalletStatusResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> + activateCircleGatewayWalletBeta(String vaultAccountId, String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + activateCircleGatewayWalletBetaRequestBuilder(vaultAccountId, idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "activateCircleGatewayWalletBeta", + localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CircleGatewayWalletStatusResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder activateCircleGatewayWalletBetaRequestBuilder( + String vaultAccountId, String idempotencyKey) throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "activateCircleGatewayWalletBeta", "vaultAccountId", vaultAccountId); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/vault/accounts/{vaultAccountId}/circle_gateway/activate" + .replace( + "{vaultAccountId}", ApiClient.urlEncode(vaultAccountId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Attach or detach tags from vault accounts Attach or detach one or more tags from the * requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing @@ -313,7 +395,7 @@ private HttpRequest.Builder attachOrDetachTagsFromVaultAccountsRequestBuilder( } /** * Convert a segwit address to legacy format Converts an existing segwit address to the legacy - * format. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The ID of the vault account (required) * @param assetId The ID of the asset (required) @@ -582,8 +664,8 @@ private HttpRequest.Builder createMultipleDepositAddressesRequestBuilder( * Create a new vault account Creates a new vault account with the requested name. **Note: ** * Vault account names should consist of ASCII characters only. Learn more about Fireblocks * Vault Accounts in the following - * [guide](https://developers.fireblocks.com/reference/create-vault-account). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param createVaultAccountRequest (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -668,7 +750,7 @@ private HttpRequest.Builder createVaultAccountRequestBuilder( /** * Create a new vault wallet Creates a wallet for a specific asset in a vault account. Learn * more about Fireblocks Vault Wallets in the following - * [guide](https://developers.fireblocks.com/reference/create-vault-wallet). </br>Endpoint + * [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The ID of the vault account to return, or 'default' for the @@ -792,7 +874,7 @@ private HttpRequest.Builder createVaultAccountAssetRequestBuilder( /** * Create new asset deposit address Creates a new deposit address for an asset of a vault * account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based - * assets will fail. </br>Endpoint Permission: Admin, Non-Signing Admin. + * assets will fail. Endpoint Permission: Admin, Non-Signing Admin. * * @param vaultAccountId The ID of the vault account to return (required) * @param assetId The ID of the asset (required) @@ -888,11 +970,91 @@ private HttpRequest.Builder createVaultAccountAssetAddressRequestBuilder( } return localVarRequestBuilder; } + /** + * Deactivate a Circle Gateway wallet Deactivates the Circle Gateway wallet associated with the + * given vault account. **Note:** This endpoint is currently in beta and might be subject to + * changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. + * + * @param vaultAccountId The ID of the vault account (required) + * @param idempotencyKey A unique identifier for the request. If the request is sent multiple + * times with the same idempotency key, the server will return the same response as the + * first request. The idempotency key is valid for 24 hours. (optional) + * @return CompletableFuture<ApiResponse<CircleGatewayWalletStatusResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> + deactivateCircleGatewayWalletBeta(String vaultAccountId, String idempotencyKey) + throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + deactivateCircleGatewayWalletBetaRequestBuilder(vaultAccountId, idempotencyKey); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "deactivateCircleGatewayWalletBeta", + localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CircleGatewayWalletStatusResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder deactivateCircleGatewayWalletBetaRequestBuilder( + String vaultAccountId, String idempotencyKey) throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "deactivateCircleGatewayWalletBeta", "vaultAccountId", vaultAccountId); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/vault/accounts/{vaultAccountId}/circle_gateway/deactivate" + .replace( + "{vaultAccountId}", ApiClient.urlEncode(vaultAccountId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + if (idempotencyKey != null) { + localVarRequestBuilder.header("Idempotency-Key", idempotencyKey.toString()); + } + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Get vault wallets (Paginated) Get all vault wallets of the vault accounts in your workspace. * A vault wallet is an asset in a vault account. This method allows fast traversal of all - * account balances. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor, Viewer. + * account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param totalAmountLargerThan When specified, only vault wallets with total balance greater * than this amount are returned. (optional) @@ -1005,6 +1167,80 @@ private HttpRequest.Builder getAssetWalletsRequestBuilder( } return localVarRequestBuilder; } + /** + * Get Circle Gateway wallet info Returns the Circle Gateway wallet information associated with + * the given vault account. **Note:** This endpoint is currently in beta and might be subject to + * changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. + * + * @param vaultAccountId The ID of the vault account (required) + * @return CompletableFuture<ApiResponse<CircleGatewayWalletInfoResponse>> + * @throws ApiException if fails to make API call + */ + public CompletableFuture> + getCircleGatewayWalletInfoBeta(String vaultAccountId) throws ApiException { + try { + HttpRequest.Builder localVarRequestBuilder = + getCircleGatewayWalletInfoBetaRequestBuilder(vaultAccountId); + return memberVarHttpClient + .sendAsync(localVarRequestBuilder.build(), HttpResponse.BodyHandlers.ofString()) + .thenComposeAsync( + localVarResponse -> { + if (memberVarAsyncResponseInterceptor != null) { + memberVarAsyncResponseInterceptor.accept(localVarResponse); + } + if (localVarResponse.statusCode() / 100 != 2) { + return CompletableFuture.failedFuture( + getApiException( + "getCircleGatewayWalletInfoBeta", + localVarResponse)); + } + try { + String responseBody = localVarResponse.body(); + return CompletableFuture.completedFuture( + new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody == null || responseBody.isBlank() + ? null + : memberVarObjectMapper.readValue( + responseBody, + new TypeReference< + CircleGatewayWalletInfoResponse>() {}))); + } catch (IOException e) { + return CompletableFuture.failedFuture(new ApiException(e)); + } + }); + } catch (ApiException e) { + return CompletableFuture.failedFuture(e); + } + } + + private HttpRequest.Builder getCircleGatewayWalletInfoBetaRequestBuilder(String vaultAccountId) + throws ApiException { + ValidationUtils.assertParamExistsAndNotEmpty( + "getCircleGatewayWalletInfoBeta", "vaultAccountId", vaultAccountId); + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = + "/vault/accounts/{vaultAccountId}/circle_gateway" + .replace( + "{vaultAccountId}", ApiClient.urlEncode(vaultAccountId.toString())); + + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + + localVarRequestBuilder.header("Accept", "application/json"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Get the job status of the bulk deposit address creation Returns the current status of (or an * error for) the specified deposit addresss bulk creation job. **Endpoint Permissions:** Admin, @@ -1320,8 +1556,8 @@ private HttpRequest.Builder getMaxSpendableAmountRequestBuilder( } /** * Get vault accounts (Paginated) Gets all vault accounts in your workspace. This endpoint - * returns a limited amount of results with a quick response time. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * returns a limited amount of results with a quick response time. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param namePrefix (optional) * @param nameSuffix (optional) @@ -1473,7 +1709,7 @@ private HttpRequest.Builder getPagedVaultAccountsRequestBuilder( } /** * Get the public key for a derivation path Gets the public key information based on derivation - * path and signing algorithm. </br>Endpoint Permission: Admin, Non-Signing Admin. + * path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. * * @param derivationPath (required) * @param algorithm (required) @@ -1563,7 +1799,7 @@ private HttpRequest.Builder getPublicKeyInfoRequestBuilder( } /** * Get an asset's public key Get the public key information for a specific asset in a vault - * account. </br>Endpoint Permission: Admin, Non-Signing Admin. + * account. Endpoint Permission: Admin, Non-Signing Admin. * * @param vaultAccountId (required) * @param assetId (required) @@ -1673,8 +1909,8 @@ private HttpRequest.Builder getPublicKeyInfoForAddressRequestBuilder( } /** * Get UTXO unspent inputs information Returns unspent inputs information of an UTXO asset in a - * vault account. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor, Viewer. + * vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param vaultAccountId The ID of the vault account (required) * @param assetId The ID of the asset (required) @@ -1746,8 +1982,8 @@ private HttpRequest.Builder getUnspentInputsRequestBuilder( return localVarRequestBuilder; } /** - * Get a vault account by ID Get a vault account by its unique ID. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Get a vault account by ID Get a vault account by its unique ID. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param vaultAccountId The ID of the vault account (required) * @return CompletableFuture<ApiResponse<VaultAccount>> @@ -1817,8 +2053,8 @@ private HttpRequest.Builder getVaultAccountRequestBuilder(String vaultAccountId) } /** * Get the asset balance for a vault account Returns a specific vault wallet balance information - * for a specific asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor, Viewer. * * @param vaultAccountId The ID of the vault account to return (required) * @param assetId The ID of the asset (required) @@ -1891,8 +2127,8 @@ private HttpRequest.Builder getVaultAccountAssetRequestBuilder( } /** * Get addresses (Paginated) Returns a paginated response of the addresses for a given vault - * account and asset. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param vaultAccountId The ID of the vault account to return (required) * @param assetId The ID of the asset (required) @@ -1998,8 +2234,8 @@ private HttpRequest.Builder getVaultAccountAssetAddressesPaginatedRequestBuilder } /** * Get asset balance for chosen assets Gets the assets amount summary for all accounts or - * filtered accounts. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * Viewer. * * @param accountNamePrefix (optional) * @param accountNameSuffix (optional) @@ -2086,8 +2322,7 @@ private HttpRequest.Builder getVaultAssetsRequestBuilder( } /** * Get vault balance by an asset Get the total balance of an asset across all the vault - * accounts. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, - * Viewer. + * accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @param assetId (required) * @return CompletableFuture<ApiResponse<VaultAsset>> @@ -2161,8 +2396,8 @@ private HttpRequest.Builder getVaultBalanceByAssetRequestBuilder(String assetId) * Learn more in the following * [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). * NOTE: Hiding the vault account from the web console will also hide all the related - * transactions to/from this vault. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor. + * transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @param vaultAccountId The vault account to hide (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -2238,7 +2473,7 @@ private HttpRequest.Builder hideVaultAccountRequestBuilder( } /** * Assign AML customer reference ID Sets an AML/KYT customer reference ID for a specific - * address. </br>Endpoint Permission: Admin, Non-Signing Admin. + * address. Endpoint Permission: Admin, Non-Signing Admin. * * @param setCustomerRefIdForAddressRequest (required) * @param vaultAccountId The ID of the vault account (required) @@ -2354,8 +2589,8 @@ private HttpRequest.Builder setCustomerRefIdForAddressRequestBuilder( * Set auto fueling to on or off Toggles the auto fueling property of the vault account to * enabled or disabled. Vault Accounts with 'autoFuel=true' are monitored and auto * fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the - * following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param setAutoFuelRequest (required) * @param vaultAccountId The vault account ID (required) @@ -2446,8 +2681,8 @@ private HttpRequest.Builder setVaultAccountAutoFuelRequestBuilder( /** * Set an AML/KYT ID for a vault account Assigns an AML/KYT customer reference ID for the vault * account. Learn more about Fireblocks AML management in the following - * [guide](https://developers.fireblocks.com/docs/define-aml-policies). </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: + * Admin, Non-Signing Admin. * * @param setCustomerRefIdRequest (required) * @param vaultAccountId The vault account ID (required) @@ -2543,7 +2778,7 @@ private HttpRequest.Builder setVaultAccountCustomerRefIdRequestBuilder( } /** * Unhide a vault account in the console Makes a hidden vault account visible in web console - * view. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The vault account to unhide (required) * @param idempotencyKey A unique identifier for the request. If the request is sent multiple @@ -2619,8 +2854,8 @@ private HttpRequest.Builder unhideVaultAccountRequestBuilder( return localVarRequestBuilder; } /** - * Rename a vault account Renames the requested vault account. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver. + * Rename a vault account Renames the requested vault account. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver. * * @param updateVaultAccountRequest (required) * @param vaultAccountId The ID of the vault account to edit (required) @@ -2715,8 +2950,7 @@ private HttpRequest.Builder updateVaultAccountRequestBuilder( } /** * Update address description Updates the description of an existing address of an asset in a - * vault account. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The ID of the vault account (required) * @param assetId The ID of the asset (required) @@ -2827,8 +3061,7 @@ private HttpRequest.Builder updateVaultAccountAssetAddressRequestBuilder( /** * Refresh asset balance data Updates the balance of a specific asset in a vault account. This * API endpoint is subject to a strict rate limit. Should be used by clients in very specific - * scenarios. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param vaultAccountId The ID of the vault account to return (required) * @param assetId The ID of the asset (required) diff --git a/src/main/java/com/fireblocks/sdk/api/WebhooksApi.java b/src/main/java/com/fireblocks/sdk/api/WebhooksApi.java index 8d1a304f..bc492808 100644 --- a/src/main/java/com/fireblocks/sdk/api/WebhooksApi.java +++ b/src/main/java/com/fireblocks/sdk/api/WebhooksApi.java @@ -172,7 +172,7 @@ private HttpRequest.Builder resendTransactionWebhooksRequestBuilder( /** * Resend failed webhooks Resends all failed webhook notifications. Learn more about Fireblocks * Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @param idempotencyKey A unique identifier for the request. If the request is sent multiple * times with the same idempotency key, the server will return the same response as the diff --git a/src/main/java/com/fireblocks/sdk/api/WhitelistIpAddressesApi.java b/src/main/java/com/fireblocks/sdk/api/WhitelistIpAddressesApi.java index a82c5e05..cf47fe17 100644 --- a/src/main/java/com/fireblocks/sdk/api/WhitelistIpAddressesApi.java +++ b/src/main/java/com/fireblocks/sdk/api/WhitelistIpAddressesApi.java @@ -73,8 +73,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String /** * Get whitelisted ip addresses for an API Key Get a list of the whitelisted IP addresses for a * specific API Key - Please note that this endpoint is available only for API keys with - * Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, Non-Signing - * Admin. + * Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * * @param userId The ID of the api user (required) * @return CompletableFuture<ApiResponse<GetWhitelistIpAddressesResponse>> diff --git a/src/main/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApi.java b/src/main/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApi.java index 9f212c4b..c8bd7687 100644 --- a/src/main/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApi.java +++ b/src/main/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApi.java @@ -73,7 +73,7 @@ private String formatExceptionMessage(String operationId, int statusCode, String * Returns current workspace status Returns current workspace status (Beta). **Note**: - This * endpoint is now in Beta, disabled for general availability at this time. - Please note that * this endpoint is available only for API keys with Admin/Non Signing Admin permissions. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @return CompletableFuture<ApiResponse<GetWorkspaceStatusResponse>> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/fireblocks/sdk/model/ChainDescriptor.java b/src/main/java/com/fireblocks/sdk/model/ChainDescriptor.java index 01783797..d97beade 100644 --- a/src/main/java/com/fireblocks/sdk/model/ChainDescriptor.java +++ b/src/main/java/com/fireblocks/sdk/model/ChainDescriptor.java @@ -42,6 +42,10 @@ public enum ChainDescriptor { OSMO("OSMO"), + POL("POL"), + + POL_TEST("POL_TEST"), + SOL("SOL"), SOL_TEST("SOL_TEST"), diff --git a/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponse.java b/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponse.java new file mode 100644 index 00000000..dbd34dc8 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponse.java @@ -0,0 +1,365 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** CircleGatewayWalletInfoResponse */ +@JsonPropertyOrder({ + CircleGatewayWalletInfoResponse.JSON_PROPERTY_WALLET_ID, + CircleGatewayWalletInfoResponse.JSON_PROPERTY_TYPE, + CircleGatewayWalletInfoResponse.JSON_PROPERTY_STATUS, + CircleGatewayWalletInfoResponse.JSON_PROPERTY_SYMBOL, + CircleGatewayWalletInfoResponse.JSON_PROPERTY_ASSET_IDS +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class CircleGatewayWalletInfoResponse { + public static final String JSON_PROPERTY_WALLET_ID = "walletId"; + @jakarta.annotation.Nonnull private String walletId; + + public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; + + /** Current activation status of the Circle Gateway wallet */ + public enum StatusEnum { + ACTIVATED(String.valueOf("ACTIVATED")), + + DEACTIVATED(String.valueOf("DEACTIVATED")); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusEnum fromValue(String value) { + for (StatusEnum b : StatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS = "status"; + @jakarta.annotation.Nonnull private StatusEnum status; + + public static final String JSON_PROPERTY_SYMBOL = "symbol"; + @jakarta.annotation.Nonnull private String symbol; + + public static final String JSON_PROPERTY_ASSET_IDS = "assetIds"; + @jakarta.annotation.Nonnull private List assetIds; + + public CircleGatewayWalletInfoResponse() {} + + @JsonCreator + public CircleGatewayWalletInfoResponse( + @JsonProperty(value = JSON_PROPERTY_WALLET_ID, required = true) String walletId, + @JsonProperty(value = JSON_PROPERTY_TYPE, required = true) String type, + @JsonProperty(value = JSON_PROPERTY_STATUS, required = true) StatusEnum status, + @JsonProperty(value = JSON_PROPERTY_SYMBOL, required = true) String symbol, + @JsonProperty(value = JSON_PROPERTY_ASSET_IDS, required = true) List assetIds) { + this.walletId = walletId; + this.type = type; + this.status = status; + this.symbol = symbol; + this.assetIds = assetIds; + } + + public CircleGatewayWalletInfoResponse walletId(@jakarta.annotation.Nonnull String walletId) { + this.walletId = walletId; + return this; + } + + /** + * The Circle Gateway wallet identifier + * + * @return walletId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WALLET_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getWalletId() { + return walletId; + } + + @JsonProperty(JSON_PROPERTY_WALLET_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setWalletId(@jakarta.annotation.Nonnull String walletId) { + this.walletId = walletId; + } + + public CircleGatewayWalletInfoResponse type(@jakarta.annotation.Nonnull String type) { + this.type = type; + return this; + } + + /** + * The Circle Gateway provider identifier + * + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(@jakarta.annotation.Nonnull String type) { + this.type = type; + } + + public CircleGatewayWalletInfoResponse status(@jakarta.annotation.Nonnull StatusEnum status) { + this.status = status; + return this; + } + + /** + * Current activation status of the Circle Gateway wallet + * + * @return status + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public StatusEnum getStatus() { + return status; + } + + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStatus(@jakarta.annotation.Nonnull StatusEnum status) { + this.status = status; + } + + public CircleGatewayWalletInfoResponse symbol(@jakarta.annotation.Nonnull String symbol) { + this.symbol = symbol; + return this; + } + + /** + * The token symbol supported by this wallet (e.g. USDC) + * + * @return symbol + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SYMBOL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getSymbol() { + return symbol; + } + + @JsonProperty(JSON_PROPERTY_SYMBOL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSymbol(@jakarta.annotation.Nonnull String symbol) { + this.symbol = symbol; + } + + public CircleGatewayWalletInfoResponse assetIds( + @jakarta.annotation.Nonnull List assetIds) { + this.assetIds = assetIds; + return this; + } + + public CircleGatewayWalletInfoResponse addAssetIdsItem(String assetIdsItem) { + if (this.assetIds == null) { + this.assetIds = new ArrayList<>(); + } + this.assetIds.add(assetIdsItem); + return this; + } + + /** + * Fireblocks asset IDs available for this wallet + * + * @return assetIds + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ASSET_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getAssetIds() { + return assetIds; + } + + @JsonProperty(JSON_PROPERTY_ASSET_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAssetIds(@jakarta.annotation.Nonnull List assetIds) { + this.assetIds = assetIds; + } + + /** Return true if this CircleGatewayWalletInfoResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CircleGatewayWalletInfoResponse circleGatewayWalletInfoResponse = + (CircleGatewayWalletInfoResponse) o; + return Objects.equals(this.walletId, circleGatewayWalletInfoResponse.walletId) + && Objects.equals(this.type, circleGatewayWalletInfoResponse.type) + && Objects.equals(this.status, circleGatewayWalletInfoResponse.status) + && Objects.equals(this.symbol, circleGatewayWalletInfoResponse.symbol) + && Objects.equals(this.assetIds, circleGatewayWalletInfoResponse.assetIds); + } + + @Override + public int hashCode() { + return Objects.hash(walletId, type, status, symbol, assetIds); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CircleGatewayWalletInfoResponse {\n"); + sb.append(" walletId: ").append(toIndentedString(walletId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" symbol: ").append(toIndentedString(symbol)).append("\n"); + sb.append(" assetIds: ").append(toIndentedString(assetIds)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `walletId` to the URL query string + if (getWalletId() != null) { + joiner.add( + String.format( + "%swalletId%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getWalletId())))); + } + + // add `type` to the URL query string + if (getType() != null) { + joiner.add( + String.format( + "%stype%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getType())))); + } + + // add `status` to the URL query string + if (getStatus() != null) { + joiner.add( + String.format( + "%sstatus%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getStatus())))); + } + + // add `symbol` to the URL query string + if (getSymbol() != null) { + joiner.add( + String.format( + "%ssymbol%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getSymbol())))); + } + + // add `assetIds` to the URL query string + if (getAssetIds() != null) { + for (int i = 0; i < getAssetIds().size(); i++) { + joiner.add( + String.format( + "%sassetIds%s%s=%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", containerPrefix, i, containerSuffix), + ApiClient.urlEncode( + ApiClient.valueToString(getAssetIds().get(i))))); + } + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponse.java b/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponse.java new file mode 100644 index 00000000..ac31c3bc --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponse.java @@ -0,0 +1,224 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** CircleGatewayWalletStatusResponse */ +@JsonPropertyOrder({ + CircleGatewayWalletStatusResponse.JSON_PROPERTY_WALLET_ID, + CircleGatewayWalletStatusResponse.JSON_PROPERTY_STATUS +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class CircleGatewayWalletStatusResponse { + public static final String JSON_PROPERTY_WALLET_ID = "walletId"; + @jakarta.annotation.Nonnull private String walletId; + + /** Current activation status of the Circle Gateway wallet */ + public enum StatusEnum { + ACTIVATED(String.valueOf("ACTIVATED")), + + DEACTIVATED(String.valueOf("DEACTIVATED")); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusEnum fromValue(String value) { + for (StatusEnum b : StatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS = "status"; + @jakarta.annotation.Nonnull private StatusEnum status; + + public CircleGatewayWalletStatusResponse() {} + + @JsonCreator + public CircleGatewayWalletStatusResponse( + @JsonProperty(value = JSON_PROPERTY_WALLET_ID, required = true) String walletId, + @JsonProperty(value = JSON_PROPERTY_STATUS, required = true) StatusEnum status) { + this.walletId = walletId; + this.status = status; + } + + public CircleGatewayWalletStatusResponse walletId(@jakarta.annotation.Nonnull String walletId) { + this.walletId = walletId; + return this; + } + + /** + * The Circle Gateway wallet identifier + * + * @return walletId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WALLET_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getWalletId() { + return walletId; + } + + @JsonProperty(JSON_PROPERTY_WALLET_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setWalletId(@jakarta.annotation.Nonnull String walletId) { + this.walletId = walletId; + } + + public CircleGatewayWalletStatusResponse status(@jakarta.annotation.Nonnull StatusEnum status) { + this.status = status; + return this; + } + + /** + * Current activation status of the Circle Gateway wallet + * + * @return status + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public StatusEnum getStatus() { + return status; + } + + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStatus(@jakarta.annotation.Nonnull StatusEnum status) { + this.status = status; + } + + /** Return true if this CircleGatewayWalletStatusResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CircleGatewayWalletStatusResponse circleGatewayWalletStatusResponse = + (CircleGatewayWalletStatusResponse) o; + return Objects.equals(this.walletId, circleGatewayWalletStatusResponse.walletId) + && Objects.equals(this.status, circleGatewayWalletStatusResponse.status); + } + + @Override + public int hashCode() { + return Objects.hash(walletId, status); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CircleGatewayWalletStatusResponse {\n"); + sb.append(" walletId: ").append(toIndentedString(walletId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `walletId` to the URL query string + if (getWalletId() != null) { + joiner.add( + String.format( + "%swalletId%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getWalletId())))); + } + + // add `status` to the URL query string + if (getStatus() != null) { + joiner.add( + String.format( + "%sstatus%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getStatus())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/CounterpartyGroup.java b/src/main/java/com/fireblocks/sdk/model/CounterpartyGroup.java new file mode 100644 index 00000000..9981df13 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/CounterpartyGroup.java @@ -0,0 +1,415 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; +import java.util.UUID; + +/** A counterparty group used to classify counterparties for compliance and routing purposes */ +@JsonPropertyOrder({ + CounterpartyGroup.JSON_PROPERTY_GROUP_ID, + CounterpartyGroup.JSON_PROPERTY_NAME, + CounterpartyGroup.JSON_PROPERTY_DESCRIPTION, + CounterpartyGroup.JSON_PROPERTY_JURISDICTION_CODES, + CounterpartyGroup.JSON_PROPERTY_IS_ACTIVE, + CounterpartyGroup.JSON_PROPERTY_CREATED_AT, + CounterpartyGroup.JSON_PROPERTY_UPDATED_AT +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class CounterpartyGroup { + public static final String JSON_PROPERTY_GROUP_ID = "groupId"; + @jakarta.annotation.Nonnull private UUID groupId; + + public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + @jakarta.annotation.Nullable private String description; + + public static final String JSON_PROPERTY_JURISDICTION_CODES = "jurisdictionCodes"; + @jakarta.annotation.Nullable private List jurisdictionCodes; + + public static final String JSON_PROPERTY_IS_ACTIVE = "isActive"; + @jakarta.annotation.Nonnull private Boolean isActive; + + public static final String JSON_PROPERTY_CREATED_AT = "createdAt"; + @jakarta.annotation.Nonnull private OffsetDateTime createdAt; + + public static final String JSON_PROPERTY_UPDATED_AT = "updatedAt"; + @jakarta.annotation.Nonnull private OffsetDateTime updatedAt; + + public CounterpartyGroup() {} + + @JsonCreator + public CounterpartyGroup( + @JsonProperty(value = JSON_PROPERTY_GROUP_ID, required = true) UUID groupId, + @JsonProperty(value = JSON_PROPERTY_NAME, required = true) String name, + @JsonProperty(value = JSON_PROPERTY_IS_ACTIVE, required = true) Boolean isActive, + @JsonProperty(value = JSON_PROPERTY_CREATED_AT, required = true) + OffsetDateTime createdAt, + @JsonProperty(value = JSON_PROPERTY_UPDATED_AT, required = true) + OffsetDateTime updatedAt) { + this.groupId = groupId; + this.name = name; + this.isActive = isActive; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + } + + public CounterpartyGroup groupId(@jakarta.annotation.Nonnull UUID groupId) { + this.groupId = groupId; + return this; + } + + /** + * Unique identifier of the counterparty group + * + * @return groupId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public UUID getGroupId() { + return groupId; + } + + @JsonProperty(JSON_PROPERTY_GROUP_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setGroupId(@jakarta.annotation.Nonnull UUID groupId) { + this.groupId = groupId; + } + + public CounterpartyGroup name(@jakarta.annotation.Nonnull String name) { + this.name = name; + return this; + } + + /** + * Human-readable name of the group + * + * @return name + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getName() { + return name; + } + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setName(@jakarta.annotation.Nonnull String name) { + this.name = name; + } + + public CounterpartyGroup description(@jakarta.annotation.Nullable String description) { + this.description = description; + return this; + } + + /** + * Optional description of the group + * + * @return description + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getDescription() { + return description; + } + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(@jakarta.annotation.Nullable String description) { + this.description = description; + } + + public CounterpartyGroup jurisdictionCodes( + @jakarta.annotation.Nullable List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + return this; + } + + public CounterpartyGroup addJurisdictionCodesItem(String jurisdictionCodesItem) { + if (this.jurisdictionCodes == null) { + this.jurisdictionCodes = new ArrayList<>(); + } + this.jurisdictionCodes.add(jurisdictionCodesItem); + return this; + } + + /** + * List of jurisdiction codes associated with the group + * + * @return jurisdictionCodes + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getJurisdictionCodes() { + return jurisdictionCodes; + } + + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setJurisdictionCodes(@jakarta.annotation.Nullable List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + } + + public CounterpartyGroup isActive(@jakarta.annotation.Nonnull Boolean isActive) { + this.isActive = isActive; + return this; + } + + /** + * Whether the counterparty group is currently active + * + * @return isActive + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_ACTIVE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Boolean getIsActive() { + return isActive; + } + + @JsonProperty(JSON_PROPERTY_IS_ACTIVE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setIsActive(@jakarta.annotation.Nonnull Boolean isActive) { + this.isActive = isActive; + } + + public CounterpartyGroup createdAt(@jakarta.annotation.Nonnull OffsetDateTime createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + * ISO 8601 timestamp when the group was created + * + * @return createdAt + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public OffsetDateTime getCreatedAt() { + return createdAt; + } + + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCreatedAt(@jakarta.annotation.Nonnull OffsetDateTime createdAt) { + this.createdAt = createdAt; + } + + public CounterpartyGroup updatedAt(@jakarta.annotation.Nonnull OffsetDateTime updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * ISO 8601 timestamp when the group was last updated + * + * @return updatedAt + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public OffsetDateTime getUpdatedAt() { + return updatedAt; + } + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setUpdatedAt(@jakarta.annotation.Nonnull OffsetDateTime updatedAt) { + this.updatedAt = updatedAt; + } + + /** Return true if this CounterpartyGroup object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CounterpartyGroup counterpartyGroup = (CounterpartyGroup) o; + return Objects.equals(this.groupId, counterpartyGroup.groupId) + && Objects.equals(this.name, counterpartyGroup.name) + && Objects.equals(this.description, counterpartyGroup.description) + && Objects.equals(this.jurisdictionCodes, counterpartyGroup.jurisdictionCodes) + && Objects.equals(this.isActive, counterpartyGroup.isActive) + && Objects.equals(this.createdAt, counterpartyGroup.createdAt) + && Objects.equals(this.updatedAt, counterpartyGroup.updatedAt); + } + + @Override + public int hashCode() { + return Objects.hash( + groupId, name, description, jurisdictionCodes, isActive, createdAt, updatedAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CounterpartyGroup {\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" jurisdictionCodes: ") + .append(toIndentedString(jurisdictionCodes)) + .append("\n"); + sb.append(" isActive: ").append(toIndentedString(isActive)).append("\n"); + sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `groupId` to the URL query string + if (getGroupId() != null) { + joiner.add( + String.format( + "%sgroupId%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getGroupId())))); + } + + // add `name` to the URL query string + if (getName() != null) { + joiner.add( + String.format( + "%sname%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getName())))); + } + + // add `description` to the URL query string + if (getDescription() != null) { + joiner.add( + String.format( + "%sdescription%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getDescription())))); + } + + // add `jurisdictionCodes` to the URL query string + if (getJurisdictionCodes() != null) { + for (int i = 0; i < getJurisdictionCodes().size(); i++) { + joiner.add( + String.format( + "%sjurisdictionCodes%s%s=%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", containerPrefix, i, containerSuffix), + ApiClient.urlEncode( + ApiClient.valueToString(getJurisdictionCodes().get(i))))); + } + } + + // add `isActive` to the URL query string + if (getIsActive() != null) { + joiner.add( + String.format( + "%sisActive%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getIsActive())))); + } + + // add `createdAt` to the URL query string + if (getCreatedAt() != null) { + joiner.add( + String.format( + "%screatedAt%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getCreatedAt())))); + } + + // add `updatedAt` to the URL query string + if (getUpdatedAt() != null) { + joiner.add( + String.format( + "%supdatedAt%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getUpdatedAt())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponse.java b/src/main/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponse.java new file mode 100644 index 00000000..420c8426 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponse.java @@ -0,0 +1,252 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** Paginated list of counterparty groups */ +@JsonPropertyOrder({ + CounterpartyGroupsPaginatedResponse.JSON_PROPERTY_DATA, + CounterpartyGroupsPaginatedResponse.JSON_PROPERTY_TOTAL, + CounterpartyGroupsPaginatedResponse.JSON_PROPERTY_NEXT +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class CounterpartyGroupsPaginatedResponse { + public static final String JSON_PROPERTY_DATA = "data"; + @jakarta.annotation.Nonnull private List data; + + public static final String JSON_PROPERTY_TOTAL = "total"; + @jakarta.annotation.Nullable private Integer total; + + public static final String JSON_PROPERTY_NEXT = "next"; + @jakarta.annotation.Nullable private String next; + + public CounterpartyGroupsPaginatedResponse() {} + + @JsonCreator + public CounterpartyGroupsPaginatedResponse( + @JsonProperty(value = JSON_PROPERTY_DATA, required = true) + List data) { + this.data = data; + } + + public CounterpartyGroupsPaginatedResponse data( + @jakarta.annotation.Nonnull List data) { + this.data = data; + return this; + } + + public CounterpartyGroupsPaginatedResponse addDataItem(CounterpartyGroup dataItem) { + if (this.data == null) { + this.data = new ArrayList<>(); + } + this.data.add(dataItem); + return this; + } + + /** + * The counterparty groups in the current page + * + * @return data + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getData() { + return data; + } + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(@jakarta.annotation.Nonnull List data) { + this.data = data; + } + + public CounterpartyGroupsPaginatedResponse total(@jakarta.annotation.Nullable Integer total) { + this.total = total; + return this; + } + + /** + * Total number of counterparty groups + * + * @return total + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TOTAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getTotal() { + return total; + } + + @JsonProperty(JSON_PROPERTY_TOTAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTotal(@jakarta.annotation.Nullable Integer total) { + this.total = total; + } + + public CounterpartyGroupsPaginatedResponse next(@jakarta.annotation.Nullable String next) { + this.next = next; + return this; + } + + /** + * Cursor for the next page + * + * @return next + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_NEXT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getNext() { + return next; + } + + @JsonProperty(JSON_PROPERTY_NEXT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setNext(@jakarta.annotation.Nullable String next) { + this.next = next; + } + + /** Return true if this CounterpartyGroupsPaginatedResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CounterpartyGroupsPaginatedResponse counterpartyGroupsPaginatedResponse = + (CounterpartyGroupsPaginatedResponse) o; + return Objects.equals(this.data, counterpartyGroupsPaginatedResponse.data) + && Objects.equals(this.total, counterpartyGroupsPaginatedResponse.total) + && Objects.equals(this.next, counterpartyGroupsPaginatedResponse.next); + } + + @Override + public int hashCode() { + return Objects.hash(data, total, next); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CounterpartyGroupsPaginatedResponse {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" total: ").append(toIndentedString(total)).append("\n"); + sb.append(" next: ").append(toIndentedString(next)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `data` to the URL query string + if (getData() != null) { + for (int i = 0; i < getData().size(); i++) { + if (getData().get(i) != null) { + joiner.add( + getData() + .get(i) + .toUrlQueryString( + String.format( + "%sdata%s%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", + containerPrefix, + i, + containerSuffix)))); + } + } + } + + // add `total` to the URL query string + if (getTotal() != null) { + joiner.add( + String.format( + "%stotal%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getTotal())))); + } + + // add `next` to the URL query string + if (getNext() != null) { + joiner.add( + String.format( + "%snext%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getNext())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequest.java b/src/main/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequest.java new file mode 100644 index 00000000..ef995b02 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequest.java @@ -0,0 +1,252 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** Request body for creating a new counterparty group */ +@JsonPropertyOrder({ + CreateCounterpartyGroupRequest.JSON_PROPERTY_NAME, + CreateCounterpartyGroupRequest.JSON_PROPERTY_JURISDICTION_CODES, + CreateCounterpartyGroupRequest.JSON_PROPERTY_DESCRIPTION +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class CreateCounterpartyGroupRequest { + public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; + + public static final String JSON_PROPERTY_JURISDICTION_CODES = "jurisdictionCodes"; + @jakarta.annotation.Nonnull private List jurisdictionCodes; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + @jakarta.annotation.Nullable private String description; + + public CreateCounterpartyGroupRequest() {} + + @JsonCreator + public CreateCounterpartyGroupRequest( + @JsonProperty(value = JSON_PROPERTY_NAME, required = true) String name, + @JsonProperty(value = JSON_PROPERTY_JURISDICTION_CODES, required = true) + List jurisdictionCodes) { + this.name = name; + this.jurisdictionCodes = jurisdictionCodes; + } + + public CreateCounterpartyGroupRequest name(@jakarta.annotation.Nonnull String name) { + this.name = name; + return this; + } + + /** + * Human-readable name of the group + * + * @return name + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getName() { + return name; + } + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setName(@jakarta.annotation.Nonnull String name) { + this.name = name; + } + + public CreateCounterpartyGroupRequest jurisdictionCodes( + @jakarta.annotation.Nonnull List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + return this; + } + + public CreateCounterpartyGroupRequest addJurisdictionCodesItem(String jurisdictionCodesItem) { + if (this.jurisdictionCodes == null) { + this.jurisdictionCodes = new ArrayList<>(); + } + this.jurisdictionCodes.add(jurisdictionCodesItem); + return this; + } + + /** + * List of jurisdiction codes to associate with the group + * + * @return jurisdictionCodes + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getJurisdictionCodes() { + return jurisdictionCodes; + } + + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setJurisdictionCodes(@jakarta.annotation.Nonnull List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + } + + public CreateCounterpartyGroupRequest description( + @jakarta.annotation.Nullable String description) { + this.description = description; + return this; + } + + /** + * Optional description of the group + * + * @return description + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getDescription() { + return description; + } + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(@jakarta.annotation.Nullable String description) { + this.description = description; + } + + /** Return true if this CreateCounterpartyGroupRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateCounterpartyGroupRequest createCounterpartyGroupRequest = + (CreateCounterpartyGroupRequest) o; + return Objects.equals(this.name, createCounterpartyGroupRequest.name) + && Objects.equals( + this.jurisdictionCodes, createCounterpartyGroupRequest.jurisdictionCodes) + && Objects.equals(this.description, createCounterpartyGroupRequest.description); + } + + @Override + public int hashCode() { + return Objects.hash(name, jurisdictionCodes, description); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateCounterpartyGroupRequest {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" jurisdictionCodes: ") + .append(toIndentedString(jurisdictionCodes)) + .append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `name` to the URL query string + if (getName() != null) { + joiner.add( + String.format( + "%sname%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getName())))); + } + + // add `jurisdictionCodes` to the URL query string + if (getJurisdictionCodes() != null) { + for (int i = 0; i < getJurisdictionCodes().size(); i++) { + joiner.add( + String.format( + "%sjurisdictionCodes%s%s=%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", containerPrefix, i, containerSuffix), + ApiClient.urlEncode( + ApiClient.valueToString(getJurisdictionCodes().get(i))))); + } + } + + // add `description` to the URL query string + if (getDescription() != null) { + joiner.add( + String.format( + "%sdescription%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getDescription())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/CreateMultipleDepositAddressesJobStatus.java b/src/main/java/com/fireblocks/sdk/model/CreateMultipleDepositAddressesJobStatus.java index cf2e7e91..3e6e1c67 100644 --- a/src/main/java/com/fireblocks/sdk/model/CreateMultipleDepositAddressesJobStatus.java +++ b/src/main/java/com/fireblocks/sdk/model/CreateMultipleDepositAddressesJobStatus.java @@ -57,7 +57,7 @@ public CreateMultipleDepositAddressesJobStatus status( } /** - * Get status + * Status of the job. Possible values - Success, In Progress, Failed * * @return status */ diff --git a/src/main/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatus.java b/src/main/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatus.java index 1c16e7b6..fd0204ed 100644 --- a/src/main/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatus.java +++ b/src/main/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatus.java @@ -18,16 +18,21 @@ import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.Objects; import java.util.StringJoiner; +import java.util.UUID; /** CreateMultipleVaultAccountsJobStatus */ @JsonPropertyOrder({ CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_STATUS, CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_VAULT_ACCOUNTS, - CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_ERROR_MESSAGE + CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_TAG_IDS, + CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_ERROR_MESSAGE, + CreateMultipleVaultAccountsJobStatus.JSON_PROPERTY_APPROVAL_REQUEST_ID }) @jakarta.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -39,9 +44,15 @@ public class CreateMultipleVaultAccountsJobStatus { public static final String JSON_PROPERTY_VAULT_ACCOUNTS = "vaultAccounts"; @jakarta.annotation.Nullable private Map> vaultAccounts; + public static final String JSON_PROPERTY_TAG_IDS = "tagIds"; + @jakarta.annotation.Nullable private List tagIds; + public static final String JSON_PROPERTY_ERROR_MESSAGE = "errorMessage"; @jakarta.annotation.Nullable private String errorMessage; + public static final String JSON_PROPERTY_APPROVAL_REQUEST_ID = "approvalRequestId"; + @jakarta.annotation.Nullable private String approvalRequestId; + public CreateMultipleVaultAccountsJobStatus() {} @JsonCreator @@ -56,7 +67,8 @@ public CreateMultipleVaultAccountsJobStatus status(@jakarta.annotation.Nonnull S } /** - * Get status + * Status of the job. Possible values - Success, In Progress, Failed, Pending Approval, + * Cancelled * * @return status */ @@ -107,6 +119,38 @@ public void setVaultAccounts( this.vaultAccounts = vaultAccounts; } + public CreateMultipleVaultAccountsJobStatus tagIds( + @jakarta.annotation.Nullable List tagIds) { + this.tagIds = tagIds; + return this; + } + + public CreateMultipleVaultAccountsJobStatus addTagIdsItem(UUID tagIdsItem) { + if (this.tagIds == null) { + this.tagIds = new ArrayList<>(); + } + this.tagIds.add(tagIdsItem); + return this; + } + + /** + * List of tag IDs successfully attached to each of the created vault accounts + * + * @return tagIds + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TAG_IDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getTagIds() { + return tagIds; + } + + @JsonProperty(JSON_PROPERTY_TAG_IDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTagIds(@jakarta.annotation.Nullable List tagIds) { + this.tagIds = tagIds; + } + public CreateMultipleVaultAccountsJobStatus errorMessage( @jakarta.annotation.Nullable String errorMessage) { this.errorMessage = errorMessage; @@ -131,6 +175,30 @@ public void setErrorMessage(@jakarta.annotation.Nullable String errorMessage) { this.errorMessage = errorMessage; } + public CreateMultipleVaultAccountsJobStatus approvalRequestId( + @jakarta.annotation.Nullable String approvalRequestId) { + this.approvalRequestId = approvalRequestId; + return this; + } + + /** + * Approval request ID if the job has protected tags to attach to the vault accounts + * + * @return approvalRequestId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_APPROVAL_REQUEST_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getApprovalRequestId() { + return approvalRequestId; + } + + @JsonProperty(JSON_PROPERTY_APPROVAL_REQUEST_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setApprovalRequestId(@jakarta.annotation.Nullable String approvalRequestId) { + this.approvalRequestId = approvalRequestId; + } + /** Return true if this CreateMultipleVaultAccountsJobStatus object is equal to o. */ @Override public boolean equals(Object o) { @@ -145,13 +213,17 @@ public boolean equals(Object o) { return Objects.equals(this.status, createMultipleVaultAccountsJobStatus.status) && Objects.equals( this.vaultAccounts, createMultipleVaultAccountsJobStatus.vaultAccounts) + && Objects.equals(this.tagIds, createMultipleVaultAccountsJobStatus.tagIds) && Objects.equals( - this.errorMessage, createMultipleVaultAccountsJobStatus.errorMessage); + this.errorMessage, createMultipleVaultAccountsJobStatus.errorMessage) + && Objects.equals( + this.approvalRequestId, + createMultipleVaultAccountsJobStatus.approvalRequestId); } @Override public int hashCode() { - return Objects.hash(status, vaultAccounts, errorMessage); + return Objects.hash(status, vaultAccounts, tagIds, errorMessage, approvalRequestId); } @Override @@ -160,7 +232,11 @@ public String toString() { sb.append("class CreateMultipleVaultAccountsJobStatus {\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" vaultAccounts: ").append(toIndentedString(vaultAccounts)).append("\n"); + sb.append(" tagIds: ").append(toIndentedString(tagIds)).append("\n"); sb.append(" errorMessage: ").append(toIndentedString(errorMessage)).append("\n"); + sb.append(" approvalRequestId: ") + .append(toIndentedString(approvalRequestId)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -236,6 +312,25 @@ public String toUrlQueryString(String prefix) { } } + // add `tagIds` to the URL query string + if (getTagIds() != null) { + for (int i = 0; i < getTagIds().size(); i++) { + if (getTagIds().get(i) != null) { + joiner.add( + String.format( + "%stagIds%s%s=%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", containerPrefix, i, containerSuffix), + ApiClient.urlEncode( + ApiClient.valueToString(getTagIds().get(i))))); + } + } + } + // add `errorMessage` to the URL query string if (getErrorMessage() != null) { joiner.add( @@ -246,6 +341,16 @@ public String toUrlQueryString(String prefix) { ApiClient.urlEncode(ApiClient.valueToString(getErrorMessage())))); } + // add `approvalRequestId` to the URL query string + if (getApprovalRequestId() != null) { + joiner.add( + String.format( + "%sapprovalRequestId%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getApprovalRequestId())))); + } + return joiner.toString(); } } diff --git a/src/main/java/com/fireblocks/sdk/model/CreateQuote.java b/src/main/java/com/fireblocks/sdk/model/CreateQuote.java index 73146fa3..c0dd071b 100644 --- a/src/main/java/com/fireblocks/sdk/model/CreateQuote.java +++ b/src/main/java/com/fireblocks/sdk/model/CreateQuote.java @@ -34,7 +34,8 @@ CreateQuote.JSON_PROPERTY_BASE_AMOUNT, CreateQuote.JSON_PROPERTY_SLIPPAGE_BPS, CreateQuote.JSON_PROPERTY_SETTLEMENT, - CreateQuote.JSON_PROPERTY_SIDE + CreateQuote.JSON_PROPERTY_SIDE, + CreateQuote.JSON_PROPERTY_PARTICIPANTS_IDENTIFICATION }) @jakarta.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -67,6 +68,10 @@ public class CreateQuote { public static final String JSON_PROPERTY_SIDE = "side"; @jakarta.annotation.Nonnull private Side side; + public static final String JSON_PROPERTY_PARTICIPANTS_IDENTIFICATION = + "participantsIdentification"; + @jakarta.annotation.Nullable private ParticipantsIdentification participantsIdentification; + public CreateQuote() {} @JsonCreator @@ -301,6 +306,31 @@ public void setSide(@jakarta.annotation.Nonnull Side side) { this.side = side; } + public CreateQuote participantsIdentification( + @jakarta.annotation.Nullable ParticipantsIdentification participantsIdentification) { + this.participantsIdentification = participantsIdentification; + return this; + } + + /** + * Get participantsIdentification + * + * @return participantsIdentification + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_PARTICIPANTS_IDENTIFICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public ParticipantsIdentification getParticipantsIdentification() { + return participantsIdentification; + } + + @JsonProperty(JSON_PROPERTY_PARTICIPANTS_IDENTIFICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParticipantsIdentification( + @jakarta.annotation.Nullable ParticipantsIdentification participantsIdentification) { + this.participantsIdentification = participantsIdentification; + } + /** Return true if this CreateQuote object is equal to o. */ @Override public boolean equals(Object o) { @@ -319,7 +349,9 @@ public boolean equals(Object o) { && Objects.equals(this.baseAmount, createQuote.baseAmount) && Objects.equals(this.slippageBps, createQuote.slippageBps) && Objects.equals(this.settlement, createQuote.settlement) - && Objects.equals(this.side, createQuote.side); + && Objects.equals(this.side, createQuote.side) + && Objects.equals( + this.participantsIdentification, createQuote.participantsIdentification); } @Override @@ -333,7 +365,8 @@ public int hashCode() { baseAmount, slippageBps, settlement, - side); + side, + participantsIdentification); } @Override @@ -349,6 +382,9 @@ public String toString() { sb.append(" slippageBps: ").append(toIndentedString(slippageBps)).append("\n"); sb.append(" settlement: ").append(toIndentedString(settlement)).append("\n"); sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" participantsIdentification: ") + .append(toIndentedString(participantsIdentification)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -494,6 +530,13 @@ public String toUrlQueryString(String prefix) { ApiClient.urlEncode(ApiClient.valueToString(getSide())))); } + // add `participantsIdentification` to the URL query string + if (getParticipantsIdentification() != null) { + joiner.add( + getParticipantsIdentification() + .toUrlQueryString(prefix + "participantsIdentification" + suffix)); + } + return joiner.toString(); } } diff --git a/src/main/java/com/fireblocks/sdk/model/CreateVaultAccountRequest.java b/src/main/java/com/fireblocks/sdk/model/CreateVaultAccountRequest.java index 9556c55c..35e1ccc1 100644 --- a/src/main/java/com/fireblocks/sdk/model/CreateVaultAccountRequest.java +++ b/src/main/java/com/fireblocks/sdk/model/CreateVaultAccountRequest.java @@ -48,8 +48,8 @@ public class CreateVaultAccountRequest { @jakarta.annotation.Nullable private Boolean autoFuel; /** - * Type of vault account. The default type will be set to MPC.<br/> If the workspace does - * not support the selected type, it will return an error. + * Type of vault account. The default type will be set to MPC. If the workspace does not support + * the selected type, it will return an error. */ public enum VaultTypeEnum { MPC(String.valueOf("MPC")), @@ -192,8 +192,8 @@ public CreateVaultAccountRequest vaultType( } /** - * Type of vault account. The default type will be set to MPC.<br/> If the workspace does - * not support the selected type, it will return an error. + * Type of vault account. The default type will be set to MPC. If the workspace does not support + * the selected type, it will return an error. * * @return vaultType */ @@ -217,10 +217,9 @@ public CreateVaultAccountRequest autoAssign(@jakarta.annotation.Nullable Boolean /** * Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be - * ignored.<br/> If set to true and there are available keys, random keys will be assigned - * to the newly created vault account.<br/> If set to true and there are no available keys - * to be assigned, it will return an error.<br/> If set to false, the vault account will - * be created without any keys. + * ignored. If set to true and there are available keys, random keys will be assigned to the + * newly created vault account. If set to true and there are no available keys to be assigned, + * it will return an error. If set to false, the vault account will be created without any keys. * * @return autoAssign */ diff --git a/src/main/java/com/fireblocks/sdk/model/MomoPaymentInfo.java b/src/main/java/com/fireblocks/sdk/model/MomoPaymentInfo.java index fb265cf5..de99553e 100644 --- a/src/main/java/com/fireblocks/sdk/model/MomoPaymentInfo.java +++ b/src/main/java/com/fireblocks/sdk/model/MomoPaymentInfo.java @@ -31,6 +31,7 @@ MomoPaymentInfo.JSON_PROPERTY_COUNTRY, MomoPaymentInfo.JSON_PROPERTY_MOBILE_PHONE_NUMBER, MomoPaymentInfo.JSON_PROPERTY_PROVIDER, + MomoPaymentInfo.JSON_PROPERTY_EMAIL, MomoPaymentInfo.JSON_PROPERTY_BENEFICIARY_DOCUMENT_ID, MomoPaymentInfo.JSON_PROPERTY_BENEFICIARY_RELATIONSHIP }) @@ -126,7 +127,9 @@ public enum ProviderEnum { MTN(String.valueOf("MTN")), - TIGO(String.valueOf("TIGO")); + TIGO(String.valueOf("TIGO")), + + WAVE(String.valueOf("WAVE")); private String value; @@ -158,6 +161,9 @@ public static ProviderEnum fromValue(String value) { public static final String JSON_PROPERTY_PROVIDER = "provider"; @jakarta.annotation.Nonnull private ProviderEnum provider; + public static final String JSON_PROPERTY_EMAIL = "email"; + @jakarta.annotation.Nonnull private String email; + public static final String JSON_PROPERTY_BENEFICIARY_DOCUMENT_ID = "beneficiaryDocumentId"; @jakarta.annotation.Nullable private String beneficiaryDocumentId; @@ -178,7 +184,8 @@ public MomoPaymentInfo( @JsonProperty(value = JSON_PROPERTY_COUNTRY, required = true) String country, @JsonProperty(value = JSON_PROPERTY_MOBILE_PHONE_NUMBER, required = true) String mobilePhoneNumber, - @JsonProperty(value = JSON_PROPERTY_PROVIDER, required = true) ProviderEnum provider) { + @JsonProperty(value = JSON_PROPERTY_PROVIDER, required = true) ProviderEnum provider, + @JsonProperty(value = JSON_PROPERTY_EMAIL, required = true) String email) { this.rail = rail; this.addressingSystem = addressingSystem; this.accountHolderGivenName = accountHolderGivenName; @@ -186,6 +193,7 @@ public MomoPaymentInfo( this.country = country; this.mobilePhoneNumber = mobilePhoneNumber; this.provider = provider; + this.email = email; } public MomoPaymentInfo rail(@jakarta.annotation.Nonnull RailEnum rail) { @@ -354,6 +362,29 @@ public void setProvider(@jakarta.annotation.Nonnull ProviderEnum provider) { this.provider = provider; } + public MomoPaymentInfo email(@jakarta.annotation.Nonnull String email) { + this.email = email; + return this; + } + + /** + * The email address of the account holder + * + * @return email + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EMAIL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getEmail() { + return email; + } + + @JsonProperty(JSON_PROPERTY_EMAIL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setEmail(@jakarta.annotation.Nonnull String email) { + this.email = email; + } + public MomoPaymentInfo beneficiaryDocumentId( @jakarta.annotation.Nullable String beneficiaryDocumentId) { this.beneficiaryDocumentId = beneficiaryDocumentId; @@ -422,6 +453,7 @@ public boolean equals(Object o) { && Objects.equals(this.country, momoPaymentInfo.country) && Objects.equals(this.mobilePhoneNumber, momoPaymentInfo.mobilePhoneNumber) && Objects.equals(this.provider, momoPaymentInfo.provider) + && Objects.equals(this.email, momoPaymentInfo.email) && Objects.equals(this.beneficiaryDocumentId, momoPaymentInfo.beneficiaryDocumentId) && Objects.equals( this.beneficiaryRelationship, momoPaymentInfo.beneficiaryRelationship); @@ -437,6 +469,7 @@ public int hashCode() { country, mobilePhoneNumber, provider, + email, beneficiaryDocumentId, beneficiaryRelationship); } @@ -458,6 +491,7 @@ public String toString() { .append(toIndentedString(mobilePhoneNumber)) .append("\n"); sb.append(" provider: ").append(toIndentedString(provider)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" beneficiaryDocumentId: ") .append(toIndentedString(beneficiaryDocumentId)) .append("\n"); @@ -583,6 +617,16 @@ public String toUrlQueryString(String prefix) { ApiClient.urlEncode(ApiClient.valueToString(getProvider())))); } + // add `email` to the URL query string + if (getEmail() != null) { + joiner.add( + String.format( + "%semail%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getEmail())))); + } + // add `beneficiaryDocumentId` to the URL query string if (getBeneficiaryDocumentId() != null) { joiner.add( diff --git a/src/main/java/com/fireblocks/sdk/model/PayoutResponse.java b/src/main/java/com/fireblocks/sdk/model/PayoutResponse.java index e9112b84..3a8b01ca 100644 --- a/src/main/java/com/fireblocks/sdk/model/PayoutResponse.java +++ b/src/main/java/com/fireblocks/sdk/model/PayoutResponse.java @@ -210,14 +210,10 @@ public PayoutResponse reasonOfFailure(@jakarta.annotation.Nullable String reason } /** - * <ul> <li> INSUFFICIENT_BALANCE</li> <li> - * SOURCE_TRANSLATION</li> <li> SOURCE_NOT_UNIQUE</li> <li> - * SOURCE_NOT_FOUND</li> <li> SOURCE_TYPE_NOT_SUPPORTED</li> <li> - * EMPTY_SOURCE</li> <li> DESTINATION_TRANSLATION</li> <li> - * DESTINATION_NOT_UNIQUE</li> <li> DESTINATION_NOT_FOUND</li> <li> - * EMPTY_DESTINATION</li> <li> PARSING </li> <li> UNKNOWN</li> - * <li> FIREBLOCKS_CLIENT</li> <li> TRANSACTION_SUBMISSION</li> - * </ul> + * - INSUFFICIENT_BALANCE - SOURCE_TRANSLATION - SOURCE_NOT_UNIQUE - SOURCE_NOT_FOUND - + * SOURCE_TYPE_NOT_SUPPORTED - EMPTY_SOURCE - DESTINATION_TRANSLATION - DESTINATION_NOT_UNIQUE - + * DESTINATION_NOT_FOUND - EMPTY_DESTINATION - PARSING - UNKNOWN - FIREBLOCKS_CLIENT - + * TRANSACTION_SUBMISSION * * @return reasonOfFailure */ diff --git a/src/main/java/com/fireblocks/sdk/model/Quote.java b/src/main/java/com/fireblocks/sdk/model/Quote.java index 14fed717..e8087516 100644 --- a/src/main/java/com/fireblocks/sdk/model/Quote.java +++ b/src/main/java/com/fireblocks/sdk/model/Quote.java @@ -43,6 +43,7 @@ Quote.JSON_PROPERTY_GENERAL_FEES, Quote.JSON_PROPERTY_SIDE, Quote.JSON_PROPERTY_EXPIRES_AT, + Quote.JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS, Quote.JSON_PROPERTY_TYPE }) @jakarta.annotation.Generated( @@ -95,6 +96,10 @@ public class Quote { public static final String JSON_PROPERTY_EXPIRES_AT = "expiresAt"; @jakarta.annotation.Nonnull private String expiresAt; + public static final String JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS = + "orderCreationRequirements"; + @jakarta.annotation.Nullable private String orderCreationRequirements; + public static final String JSON_PROPERTY_TYPE = "type"; @jakarta.annotation.Nonnull private IndicativeQuoteEnum type; @@ -417,6 +422,34 @@ public void setExpiresAt(@jakarta.annotation.Nonnull String expiresAt) { this.expiresAt = expiresAt; } + public Quote orderCreationRequirements( + @jakarta.annotation.Nullable String orderCreationRequirements) { + this.orderCreationRequirements = orderCreationRequirements; + return this; + } + + /** + * A JSON Schema Draft-7 document in string format describing the fields required when creating + * an order for this quote. The schema mirrors the structure of + * CreateOrderRequest.participantsIdentification json schema, so clients can validate their + * order payload before sending. + * + * @return orderCreationRequirements + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getOrderCreationRequirements() { + return orderCreationRequirements; + } + + @JsonProperty(JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOrderCreationRequirements( + @jakarta.annotation.Nullable String orderCreationRequirements) { + this.orderCreationRequirements = orderCreationRequirements; + } + public Quote type(@jakarta.annotation.Nonnull IndicativeQuoteEnum type) { this.type = type; return this; @@ -462,6 +495,7 @@ public boolean equals(Object o) { && Objects.equals(this.generalFees, quote.generalFees) && Objects.equals(this.side, quote.side) && Objects.equals(this.expiresAt, quote.expiresAt) + && Objects.equals(this.orderCreationRequirements, quote.orderCreationRequirements) && Objects.equals(this.type, quote.type); } @@ -480,6 +514,7 @@ public int hashCode() { generalFees, side, expiresAt, + orderCreationRequirements, type); } @@ -499,6 +534,9 @@ public String toString() { sb.append(" generalFees: ").append(toIndentedString(generalFees)).append("\n"); sb.append(" side: ").append(toIndentedString(side)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" orderCreationRequirements: ") + .append(toIndentedString(orderCreationRequirements)) + .append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append("}"); return sb.toString(); @@ -686,6 +724,17 @@ public String toUrlQueryString(String prefix) { ApiClient.urlEncode(ApiClient.valueToString(getExpiresAt())))); } + // add `orderCreationRequirements` to the URL query string + if (getOrderCreationRequirements() != null) { + joiner.add( + String.format( + "%sorderCreationRequirements%s=%s", + prefix, + suffix, + ApiClient.urlEncode( + ApiClient.valueToString(getOrderCreationRequirements())))); + } + // add `type` to the URL query string if (getType() != null) { joiner.add( diff --git a/src/main/java/com/fireblocks/sdk/model/QuotePropertiesDetails.java b/src/main/java/com/fireblocks/sdk/model/QuotePropertiesDetails.java index 055a8915..d4b36825 100644 --- a/src/main/java/com/fireblocks/sdk/model/QuotePropertiesDetails.java +++ b/src/main/java/com/fireblocks/sdk/model/QuotePropertiesDetails.java @@ -37,7 +37,8 @@ QuotePropertiesDetails.JSON_PROPERTY_EXECUTION_STEPS, QuotePropertiesDetails.JSON_PROPERTY_GENERAL_FEES, QuotePropertiesDetails.JSON_PROPERTY_SIDE, - QuotePropertiesDetails.JSON_PROPERTY_EXPIRES_AT + QuotePropertiesDetails.JSON_PROPERTY_EXPIRES_AT, + QuotePropertiesDetails.JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS }) @jakarta.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -79,6 +80,10 @@ public class QuotePropertiesDetails { public static final String JSON_PROPERTY_EXPIRES_AT = "expiresAt"; @jakarta.annotation.Nonnull private String expiresAt; + public static final String JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS = + "orderCreationRequirements"; + @jakarta.annotation.Nullable private String orderCreationRequirements; + public QuotePropertiesDetails() {} @JsonCreator @@ -397,6 +402,34 @@ public void setExpiresAt(@jakarta.annotation.Nonnull String expiresAt) { this.expiresAt = expiresAt; } + public QuotePropertiesDetails orderCreationRequirements( + @jakarta.annotation.Nullable String orderCreationRequirements) { + this.orderCreationRequirements = orderCreationRequirements; + return this; + } + + /** + * A JSON Schema Draft-7 document in string format describing the fields required when creating + * an order for this quote. The schema mirrors the structure of + * CreateOrderRequest.participantsIdentification json schema, so clients can validate their + * order payload before sending. + * + * @return orderCreationRequirements + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getOrderCreationRequirements() { + return orderCreationRequirements; + } + + @JsonProperty(JSON_PROPERTY_ORDER_CREATION_REQUIREMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOrderCreationRequirements( + @jakarta.annotation.Nullable String orderCreationRequirements) { + this.orderCreationRequirements = orderCreationRequirements; + } + /** Return true if this QuotePropertiesDetails object is equal to o. */ @Override public boolean equals(Object o) { @@ -418,7 +451,10 @@ public boolean equals(Object o) { && Objects.equals(this.executionSteps, quotePropertiesDetails.executionSteps) && Objects.equals(this.generalFees, quotePropertiesDetails.generalFees) && Objects.equals(this.side, quotePropertiesDetails.side) - && Objects.equals(this.expiresAt, quotePropertiesDetails.expiresAt); + && Objects.equals(this.expiresAt, quotePropertiesDetails.expiresAt) + && Objects.equals( + this.orderCreationRequirements, + quotePropertiesDetails.orderCreationRequirements); } @Override @@ -435,7 +471,8 @@ public int hashCode() { executionSteps, generalFees, side, - expiresAt); + expiresAt, + orderCreationRequirements); } @Override @@ -454,6 +491,9 @@ public String toString() { sb.append(" generalFees: ").append(toIndentedString(generalFees)).append("\n"); sb.append(" side: ").append(toIndentedString(side)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" orderCreationRequirements: ") + .append(toIndentedString(orderCreationRequirements)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -640,6 +680,17 @@ public String toUrlQueryString(String prefix) { ApiClient.urlEncode(ApiClient.valueToString(getExpiresAt())))); } + // add `orderCreationRequirements` to the URL query string + if (getOrderCreationRequirements() != null) { + joiner.add( + String.format( + "%sorderCreationRequirements%s=%s", + prefix, + suffix, + ApiClient.urlEncode( + ApiClient.valueToString(getOrderCreationRequirements())))); + } + return joiner.toString(); } } diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPii.java b/src/main/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPii.java new file mode 100644 index 00000000..5693b28a --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPii.java @@ -0,0 +1,140 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import java.util.Objects; +import java.util.StringJoiner; + +/** Beneficiary PII data in IVMS101 format */ +@JsonPropertyOrder({TRLinkBeneficiaryPii.JSON_PROPERTY_IVMS101}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkBeneficiaryPii { + public static final String JSON_PROPERTY_IVMS101 = "ivms101"; + @jakarta.annotation.Nonnull private TRLinkIvms ivms101; + + public TRLinkBeneficiaryPii() {} + + @JsonCreator + public TRLinkBeneficiaryPii( + @JsonProperty(value = JSON_PROPERTY_IVMS101, required = true) TRLinkIvms ivms101) { + this.ivms101 = ivms101; + } + + public TRLinkBeneficiaryPii ivms101(@jakarta.annotation.Nonnull TRLinkIvms ivms101) { + this.ivms101 = ivms101; + return this; + } + + /** + * Get ivms101 + * + * @return ivms101 + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IVMS101) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public TRLinkIvms getIvms101() { + return ivms101; + } + + @JsonProperty(JSON_PROPERTY_IVMS101) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setIvms101(@jakarta.annotation.Nonnull TRLinkIvms ivms101) { + this.ivms101 = ivms101; + } + + /** Return true if this TRLinkBeneficiaryPii object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkBeneficiaryPii trLinkBeneficiaryPii = (TRLinkBeneficiaryPii) o; + return Objects.equals(this.ivms101, trLinkBeneficiaryPii.ivms101); + } + + @Override + public int hashCode() { + return Objects.hash(ivms101); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkBeneficiaryPii {\n"); + sb.append(" ivms101: ").append(toIndentedString(ivms101)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `ivms101` to the URL query string + if (getIvms101() != null) { + joiner.add(getIvms101().toUrlQueryString(prefix + "ivms101" + suffix)); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponse.java b/src/main/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponse.java new file mode 100644 index 00000000..9233cf33 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponse.java @@ -0,0 +1,171 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** Response containing the list of required actions for a TRM */ +@JsonPropertyOrder({TRLinkGetRequiredActionsResponse.JSON_PROPERTY_ACTIONS}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkGetRequiredActionsResponse { + public static final String JSON_PROPERTY_ACTIONS = "actions"; + @jakarta.annotation.Nonnull private List actions; + + public TRLinkGetRequiredActionsResponse() {} + + @JsonCreator + public TRLinkGetRequiredActionsResponse( + @JsonProperty(value = JSON_PROPERTY_ACTIONS, required = true) + List actions) { + this.actions = actions; + } + + public TRLinkGetRequiredActionsResponse actions( + @jakarta.annotation.Nonnull List actions) { + this.actions = actions; + return this; + } + + public TRLinkGetRequiredActionsResponse addActionsItem(TRLinkRequiredAction actionsItem) { + if (this.actions == null) { + this.actions = new ArrayList<>(); + } + this.actions.add(actionsItem); + return this; + } + + /** + * List of required actions for the TRM + * + * @return actions + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACTIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getActions() { + return actions; + } + + @JsonProperty(JSON_PROPERTY_ACTIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setActions(@jakarta.annotation.Nonnull List actions) { + this.actions = actions; + } + + /** Return true if this TRLinkGetRequiredActionsResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkGetRequiredActionsResponse trLinkGetRequiredActionsResponse = + (TRLinkGetRequiredActionsResponse) o; + return Objects.equals(this.actions, trLinkGetRequiredActionsResponse.actions); + } + + @Override + public int hashCode() { + return Objects.hash(actions); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkGetRequiredActionsResponse {\n"); + sb.append(" actions: ").append(toIndentedString(actions)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `actions` to the URL query string + if (getActions() != null) { + for (int i = 0; i < getActions().size(); i++) { + if (getActions().get(i) != null) { + joiner.add( + getActions() + .get(i) + .toUrlQueryString( + String.format( + "%sactions%s%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", + containerPrefix, + i, + containerSuffix)))); + } + } + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionAction.java b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionAction.java new file mode 100644 index 00000000..b3fad85c --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionAction.java @@ -0,0 +1,64 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** Decision action for destinations in NoTRM status */ +public enum TRLinkManualDecisionAction { + ACCEPT("ACCEPT"), + + REJECT("REJECT"); + + private String value; + + TRLinkManualDecisionAction(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TRLinkManualDecisionAction fromValue(String value) { + for (TRLinkManualDecisionAction b : TRLinkManualDecisionAction.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format("%s=%s", prefix, this.toString()); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetail.java b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetail.java new file mode 100644 index 00000000..92063e47 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetail.java @@ -0,0 +1,240 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** Per-destination result of the manual decision */ +@JsonPropertyOrder({ + TRLinkManualDecisionDestinationDetail.JSON_PROPERTY_DESTINATION_SCREENING_ID, + TRLinkManualDecisionDestinationDetail.JSON_PROPERTY_APPLIED, + TRLinkManualDecisionDestinationDetail.JSON_PROPERTY_SKIP_REASON +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkManualDecisionDestinationDetail { + public static final String JSON_PROPERTY_DESTINATION_SCREENING_ID = "destinationScreeningId"; + @jakarta.annotation.Nonnull private String destinationScreeningId; + + public static final String JSON_PROPERTY_APPLIED = "applied"; + @jakarta.annotation.Nonnull private Boolean applied; + + public static final String JSON_PROPERTY_SKIP_REASON = "skipReason"; + @jakarta.annotation.Nullable private String skipReason; + + public TRLinkManualDecisionDestinationDetail() {} + + @JsonCreator + public TRLinkManualDecisionDestinationDetail( + @JsonProperty(value = JSON_PROPERTY_DESTINATION_SCREENING_ID, required = true) + String destinationScreeningId, + @JsonProperty(value = JSON_PROPERTY_APPLIED, required = true) Boolean applied) { + this.destinationScreeningId = destinationScreeningId; + this.applied = applied; + } + + public TRLinkManualDecisionDestinationDetail destinationScreeningId( + @jakarta.annotation.Nonnull String destinationScreeningId) { + this.destinationScreeningId = destinationScreeningId; + return this; + } + + /** + * Destination screening record ID + * + * @return destinationScreeningId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DESTINATION_SCREENING_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getDestinationScreeningId() { + return destinationScreeningId; + } + + @JsonProperty(JSON_PROPERTY_DESTINATION_SCREENING_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDestinationScreeningId( + @jakarta.annotation.Nonnull String destinationScreeningId) { + this.destinationScreeningId = destinationScreeningId; + } + + public TRLinkManualDecisionDestinationDetail applied( + @jakarta.annotation.Nonnull Boolean applied) { + this.applied = applied; + return this; + } + + /** + * Whether the decision was applied to this destination + * + * @return applied + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_APPLIED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Boolean getApplied() { + return applied; + } + + @JsonProperty(JSON_PROPERTY_APPLIED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setApplied(@jakarta.annotation.Nonnull Boolean applied) { + this.applied = applied; + } + + public TRLinkManualDecisionDestinationDetail skipReason( + @jakarta.annotation.Nullable String skipReason) { + this.skipReason = skipReason; + return this; + } + + /** + * Reason if the destination was skipped + * + * @return skipReason + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SKIP_REASON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSkipReason() { + return skipReason; + } + + @JsonProperty(JSON_PROPERTY_SKIP_REASON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSkipReason(@jakarta.annotation.Nullable String skipReason) { + this.skipReason = skipReason; + } + + /** Return true if this TRLinkManualDecisionDestinationDetail object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkManualDecisionDestinationDetail trLinkManualDecisionDestinationDetail = + (TRLinkManualDecisionDestinationDetail) o; + return Objects.equals( + this.destinationScreeningId, + trLinkManualDecisionDestinationDetail.destinationScreeningId) + && Objects.equals(this.applied, trLinkManualDecisionDestinationDetail.applied) + && Objects.equals( + this.skipReason, trLinkManualDecisionDestinationDetail.skipReason); + } + + @Override + public int hashCode() { + return Objects.hash(destinationScreeningId, applied, skipReason); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkManualDecisionDestinationDetail {\n"); + sb.append(" destinationScreeningId: ") + .append(toIndentedString(destinationScreeningId)) + .append("\n"); + sb.append(" applied: ").append(toIndentedString(applied)).append("\n"); + sb.append(" skipReason: ").append(toIndentedString(skipReason)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `destinationScreeningId` to the URL query string + if (getDestinationScreeningId() != null) { + joiner.add( + String.format( + "%sdestinationScreeningId%s=%s", + prefix, + suffix, + ApiClient.urlEncode( + ApiClient.valueToString(getDestinationScreeningId())))); + } + + // add `applied` to the URL query string + if (getApplied() != null) { + joiner.add( + String.format( + "%sapplied%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getApplied())))); + } + + // add `skipReason` to the URL query string + if (getSkipReason() != null) { + joiner.add( + String.format( + "%sskipReason%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getSkipReason())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequest.java b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequest.java new file mode 100644 index 00000000..967ba45a --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequest.java @@ -0,0 +1,190 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** Request to manually accept or reject destinations stuck in NoTRM status */ +@JsonPropertyOrder({ + TRLinkManualDecisionRequest.JSON_PROPERTY_ACTION, + TRLinkManualDecisionRequest.JSON_PROPERTY_REASON +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkManualDecisionRequest { + public static final String JSON_PROPERTY_ACTION = "action"; + @jakarta.annotation.Nonnull private TRLinkManualDecisionAction action; + + public static final String JSON_PROPERTY_REASON = "reason"; + @jakarta.annotation.Nullable private String reason; + + public TRLinkManualDecisionRequest() {} + + @JsonCreator + public TRLinkManualDecisionRequest( + @JsonProperty(value = JSON_PROPERTY_ACTION, required = true) + TRLinkManualDecisionAction action) { + this.action = action; + } + + public TRLinkManualDecisionRequest action( + @jakarta.annotation.Nonnull TRLinkManualDecisionAction action) { + this.action = action; + return this; + } + + /** + * Get action + * + * @return action + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACTION) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public TRLinkManualDecisionAction getAction() { + return action; + } + + @JsonProperty(JSON_PROPERTY_ACTION) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAction(@jakarta.annotation.Nonnull TRLinkManualDecisionAction action) { + this.action = action; + } + + public TRLinkManualDecisionRequest reason(@jakarta.annotation.Nullable String reason) { + this.reason = reason; + return this; + } + + /** + * Optional reason for the manual decision (e.g. 'Internal KYC approved'). Do not + * include PII. + * + * @return reason + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_REASON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getReason() { + return reason; + } + + @JsonProperty(JSON_PROPERTY_REASON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setReason(@jakarta.annotation.Nullable String reason) { + this.reason = reason; + } + + /** Return true if this TRLinkManualDecisionRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkManualDecisionRequest trLinkManualDecisionRequest = (TRLinkManualDecisionRequest) o; + return Objects.equals(this.action, trLinkManualDecisionRequest.action) + && Objects.equals(this.reason, trLinkManualDecisionRequest.reason); + } + + @Override + public int hashCode() { + return Objects.hash(action, reason); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkManualDecisionRequest {\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `action` to the URL query string + if (getAction() != null) { + joiner.add( + String.format( + "%saction%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getAction())))); + } + + // add `reason` to the URL query string + if (getReason() != null) { + joiner.add( + String.format( + "%sreason%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getReason())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponse.java b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponse.java new file mode 100644 index 00000000..2a300c27 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponse.java @@ -0,0 +1,399 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** Response containing the result of the manual decision */ +@JsonPropertyOrder({ + TRLinkManualDecisionResponse.JSON_PROPERTY_ACTION, + TRLinkManualDecisionResponse.JSON_PROPERTY_SOURCE, + TRLinkManualDecisionResponse.JSON_PROPERTY_TX_ID, + TRLinkManualDecisionResponse.JSON_PROPERTY_DESTINATIONS_AFFECTED, + TRLinkManualDecisionResponse.JSON_PROPERTY_DESTINATIONS_SKIPPED, + TRLinkManualDecisionResponse.JSON_PROPERTY_DETAILS +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkManualDecisionResponse { + public static final String JSON_PROPERTY_ACTION = "action"; + @jakarta.annotation.Nonnull private TRLinkManualDecisionAction action; + + public static final String JSON_PROPERTY_SOURCE = "source"; + @jakarta.annotation.Nonnull private TRLinkManualDecisionSource source; + + public static final String JSON_PROPERTY_TX_ID = "txId"; + @jakarta.annotation.Nonnull private String txId; + + public static final String JSON_PROPERTY_DESTINATIONS_AFFECTED = "destinationsAffected"; + @jakarta.annotation.Nonnull private Integer destinationsAffected; + + public static final String JSON_PROPERTY_DESTINATIONS_SKIPPED = "destinationsSkipped"; + @jakarta.annotation.Nonnull private Integer destinationsSkipped; + + public static final String JSON_PROPERTY_DETAILS = "details"; + @jakarta.annotation.Nonnull private List details; + + public TRLinkManualDecisionResponse() {} + + @JsonCreator + public TRLinkManualDecisionResponse( + @JsonProperty(value = JSON_PROPERTY_ACTION, required = true) + TRLinkManualDecisionAction action, + @JsonProperty(value = JSON_PROPERTY_SOURCE, required = true) + TRLinkManualDecisionSource source, + @JsonProperty(value = JSON_PROPERTY_TX_ID, required = true) String txId, + @JsonProperty(value = JSON_PROPERTY_DESTINATIONS_AFFECTED, required = true) + Integer destinationsAffected, + @JsonProperty(value = JSON_PROPERTY_DESTINATIONS_SKIPPED, required = true) + Integer destinationsSkipped, + @JsonProperty(value = JSON_PROPERTY_DETAILS, required = true) + List details) { + this.action = action; + this.source = source; + this.txId = txId; + this.destinationsAffected = destinationsAffected; + this.destinationsSkipped = destinationsSkipped; + this.details = details; + } + + public TRLinkManualDecisionResponse action( + @jakarta.annotation.Nonnull TRLinkManualDecisionAction action) { + this.action = action; + return this; + } + + /** + * Get action + * + * @return action + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACTION) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public TRLinkManualDecisionAction getAction() { + return action; + } + + @JsonProperty(JSON_PROPERTY_ACTION) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAction(@jakarta.annotation.Nonnull TRLinkManualDecisionAction action) { + this.action = action; + } + + public TRLinkManualDecisionResponse source( + @jakarta.annotation.Nonnull TRLinkManualDecisionSource source) { + this.source = source; + return this; + } + + /** + * Get source + * + * @return source + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public TRLinkManualDecisionSource getSource() { + return source; + } + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(@jakarta.annotation.Nonnull TRLinkManualDecisionSource source) { + this.source = source; + } + + public TRLinkManualDecisionResponse txId(@jakarta.annotation.Nonnull String txId) { + this.txId = txId; + return this; + } + + /** + * Transaction ID + * + * @return txId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getTxId() { + return txId; + } + + @JsonProperty(JSON_PROPERTY_TX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTxId(@jakarta.annotation.Nonnull String txId) { + this.txId = txId; + } + + public TRLinkManualDecisionResponse destinationsAffected( + @jakarta.annotation.Nonnull Integer destinationsAffected) { + this.destinationsAffected = destinationsAffected; + return this; + } + + /** + * Number of destinations where the decision was applied + * + * @return destinationsAffected + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DESTINATIONS_AFFECTED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Integer getDestinationsAffected() { + return destinationsAffected; + } + + @JsonProperty(JSON_PROPERTY_DESTINATIONS_AFFECTED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDestinationsAffected(@jakarta.annotation.Nonnull Integer destinationsAffected) { + this.destinationsAffected = destinationsAffected; + } + + public TRLinkManualDecisionResponse destinationsSkipped( + @jakarta.annotation.Nonnull Integer destinationsSkipped) { + this.destinationsSkipped = destinationsSkipped; + return this; + } + + /** + * Number of destinations that were skipped + * + * @return destinationsSkipped + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DESTINATIONS_SKIPPED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Integer getDestinationsSkipped() { + return destinationsSkipped; + } + + @JsonProperty(JSON_PROPERTY_DESTINATIONS_SKIPPED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDestinationsSkipped(@jakarta.annotation.Nonnull Integer destinationsSkipped) { + this.destinationsSkipped = destinationsSkipped; + } + + public TRLinkManualDecisionResponse details( + @jakarta.annotation.Nonnull List details) { + this.details = details; + return this; + } + + public TRLinkManualDecisionResponse addDetailsItem( + TRLinkManualDecisionDestinationDetail detailsItem) { + if (this.details == null) { + this.details = new ArrayList<>(); + } + this.details.add(detailsItem); + return this; + } + + /** + * Per-destination details + * + * @return details + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DETAILS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getDetails() { + return details; + } + + @JsonProperty(JSON_PROPERTY_DETAILS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDetails( + @jakarta.annotation.Nonnull List details) { + this.details = details; + } + + /** Return true if this TRLinkManualDecisionResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkManualDecisionResponse trLinkManualDecisionResponse = + (TRLinkManualDecisionResponse) o; + return Objects.equals(this.action, trLinkManualDecisionResponse.action) + && Objects.equals(this.source, trLinkManualDecisionResponse.source) + && Objects.equals(this.txId, trLinkManualDecisionResponse.txId) + && Objects.equals( + this.destinationsAffected, + trLinkManualDecisionResponse.destinationsAffected) + && Objects.equals( + this.destinationsSkipped, trLinkManualDecisionResponse.destinationsSkipped) + && Objects.equals(this.details, trLinkManualDecisionResponse.details); + } + + @Override + public int hashCode() { + return Objects.hash( + action, source, txId, destinationsAffected, destinationsSkipped, details); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkManualDecisionResponse {\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append(" txId: ").append(toIndentedString(txId)).append("\n"); + sb.append(" destinationsAffected: ") + .append(toIndentedString(destinationsAffected)) + .append("\n"); + sb.append(" destinationsSkipped: ") + .append(toIndentedString(destinationsSkipped)) + .append("\n"); + sb.append(" details: ").append(toIndentedString(details)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `action` to the URL query string + if (getAction() != null) { + joiner.add( + String.format( + "%saction%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getAction())))); + } + + // add `source` to the URL query string + if (getSource() != null) { + joiner.add( + String.format( + "%ssource%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getSource())))); + } + + // add `txId` to the URL query string + if (getTxId() != null) { + joiner.add( + String.format( + "%stxId%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getTxId())))); + } + + // add `destinationsAffected` to the URL query string + if (getDestinationsAffected() != null) { + joiner.add( + String.format( + "%sdestinationsAffected%s=%s", + prefix, + suffix, + ApiClient.urlEncode( + ApiClient.valueToString(getDestinationsAffected())))); + } + + // add `destinationsSkipped` to the URL query string + if (getDestinationsSkipped() != null) { + joiner.add( + String.format( + "%sdestinationsSkipped%s=%s", + prefix, + suffix, + ApiClient.urlEncode( + ApiClient.valueToString(getDestinationsSkipped())))); + } + + // add `details` to the URL query string + if (getDetails() != null) { + for (int i = 0; i < getDetails().size(); i++) { + if (getDetails().get(i) != null) { + joiner.add( + getDetails() + .get(i) + .toUrlQueryString( + String.format( + "%sdetails%s%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", + containerPrefix, + i, + containerSuffix)))); + } + } + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionSource.java b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionSource.java new file mode 100644 index 00000000..abe110a0 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkManualDecisionSource.java @@ -0,0 +1,64 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** Source of the manual decision */ +public enum TRLinkManualDecisionSource { + MANUAL("MANUAL"), + + POLICY("POLICY"); + + private String value; + + TRLinkManualDecisionSource(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TRLinkManualDecisionSource fromValue(String value) { + for (TRLinkManualDecisionSource b : TRLinkManualDecisionSource.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format("%s=%s", prefix, this.toString()); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java b/src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java index a0d7da87..1cb5730b 100644 --- a/src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java @@ -16,7 +16,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; -/** Gets or Sets TRLinkMissingTrmAction-2 */ +/** TRLink missing TRM action */ public enum TRLinkMissingTrmAction2 { WAIT("WAIT"), diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredAction.java b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredAction.java new file mode 100644 index 00000000..6b08b150 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredAction.java @@ -0,0 +1,223 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** A required action for processing the TRM */ +@JsonPropertyOrder({ + TRLinkRequiredAction.JSON_PROPERTY_TYPE, + TRLinkRequiredAction.JSON_PROPERTY_DESCRIPTION, + TRLinkRequiredAction.JSON_PROPERTY_DATA +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkRequiredAction { + public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + @jakarta.annotation.Nullable private String description; + + public static final String JSON_PROPERTY_DATA = "data"; + @jakarta.annotation.Nullable private TRLinkRequiredActionData data; + + public TRLinkRequiredAction() {} + + @JsonCreator + public TRLinkRequiredAction( + @JsonProperty(value = JSON_PROPERTY_TYPE, required = true) String type) { + this.type = type; + } + + public TRLinkRequiredAction type(@jakarta.annotation.Nonnull String type) { + this.type = type; + return this; + } + + /** + * The action type identifier as defined by the Travel Rule provider. Values are + * provider-specific and may vary across different TRP implementations, so this field is + * intentionally not restricted to a fixed set of values. + * + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(@jakarta.annotation.Nonnull String type) { + this.type = type; + } + + public TRLinkRequiredAction description(@jakarta.annotation.Nullable String description) { + this.description = description; + return this; + } + + /** + * Human-readable description of the action + * + * @return description + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getDescription() { + return description; + } + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(@jakarta.annotation.Nullable String description) { + this.description = description; + } + + public TRLinkRequiredAction data(@jakarta.annotation.Nullable TRLinkRequiredActionData data) { + this.data = data; + return this; + } + + /** + * Get data + * + * @return data + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public TRLinkRequiredActionData getData() { + return data; + } + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setData(@jakarta.annotation.Nullable TRLinkRequiredActionData data) { + this.data = data; + } + + /** Return true if this TRLinkRequiredAction object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkRequiredAction trLinkRequiredAction = (TRLinkRequiredAction) o; + return Objects.equals(this.type, trLinkRequiredAction.type) + && Objects.equals(this.description, trLinkRequiredAction.description) + && Objects.equals(this.data, trLinkRequiredAction.data); + } + + @Override + public int hashCode() { + return Objects.hash(type, description, data); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkRequiredAction {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `type` to the URL query string + if (getType() != null) { + joiner.add( + String.format( + "%stype%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getType())))); + } + + // add `description` to the URL query string + if (getDescription() != null) { + joiner.add( + String.format( + "%sdescription%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getDescription())))); + } + + // add `data` to the URL query string + if (getData() != null) { + joiner.add(getData().toUrlQueryString(prefix + "data" + suffix)); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredActionData.java b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredActionData.java new file mode 100644 index 00000000..c6e9759a --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredActionData.java @@ -0,0 +1,244 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** + * Data describing what fields are required to resolve the action. The structure varies by action + * type and is defined by the TRP provider. For UPLOAD_BENEFICIARY_PII action type: Contains + * beneficiaryRequiredFields and/or originatorRequiredFields listing the IVMS101 field paths that + * must be provided. + */ +@JsonPropertyOrder({ + TRLinkRequiredActionData.JSON_PROPERTY_BENEFICIARY_REQUIRED_FIELDS, + TRLinkRequiredActionData.JSON_PROPERTY_ORIGINATOR_REQUIRED_FIELDS +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkRequiredActionData { + public static final String JSON_PROPERTY_BENEFICIARY_REQUIRED_FIELDS = + "beneficiaryRequiredFields"; + @jakarta.annotation.Nullable private List beneficiaryRequiredFields; + + public static final String JSON_PROPERTY_ORIGINATOR_REQUIRED_FIELDS = + "originatorRequiredFields"; + @jakarta.annotation.Nullable private List originatorRequiredFields; + + public TRLinkRequiredActionData() {} + + public TRLinkRequiredActionData beneficiaryRequiredFields( + @jakarta.annotation.Nullable List beneficiaryRequiredFields) { + this.beneficiaryRequiredFields = beneficiaryRequiredFields; + return this; + } + + public TRLinkRequiredActionData addBeneficiaryRequiredFieldsItem( + TRLinkRequiredField beneficiaryRequiredFieldsItem) { + if (this.beneficiaryRequiredFields == null) { + this.beneficiaryRequiredFields = new ArrayList<>(); + } + this.beneficiaryRequiredFields.add(beneficiaryRequiredFieldsItem); + return this; + } + + /** + * List of required beneficiary IVMS101 fields + * + * @return beneficiaryRequiredFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_BENEFICIARY_REQUIRED_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getBeneficiaryRequiredFields() { + return beneficiaryRequiredFields; + } + + @JsonProperty(JSON_PROPERTY_BENEFICIARY_REQUIRED_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBeneficiaryRequiredFields( + @jakarta.annotation.Nullable List beneficiaryRequiredFields) { + this.beneficiaryRequiredFields = beneficiaryRequiredFields; + } + + public TRLinkRequiredActionData originatorRequiredFields( + @jakarta.annotation.Nullable List originatorRequiredFields) { + this.originatorRequiredFields = originatorRequiredFields; + return this; + } + + public TRLinkRequiredActionData addOriginatorRequiredFieldsItem( + TRLinkRequiredField originatorRequiredFieldsItem) { + if (this.originatorRequiredFields == null) { + this.originatorRequiredFields = new ArrayList<>(); + } + this.originatorRequiredFields.add(originatorRequiredFieldsItem); + return this; + } + + /** + * List of required originator IVMS101 fields + * + * @return originatorRequiredFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ORIGINATOR_REQUIRED_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getOriginatorRequiredFields() { + return originatorRequiredFields; + } + + @JsonProperty(JSON_PROPERTY_ORIGINATOR_REQUIRED_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOriginatorRequiredFields( + @jakarta.annotation.Nullable List originatorRequiredFields) { + this.originatorRequiredFields = originatorRequiredFields; + } + + /** Return true if this TRLinkRequiredActionData object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkRequiredActionData trLinkRequiredActionData = (TRLinkRequiredActionData) o; + return Objects.equals( + this.beneficiaryRequiredFields, + trLinkRequiredActionData.beneficiaryRequiredFields) + && Objects.equals( + this.originatorRequiredFields, + trLinkRequiredActionData.originatorRequiredFields); + } + + @Override + public int hashCode() { + return Objects.hash(beneficiaryRequiredFields, originatorRequiredFields); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkRequiredActionData {\n"); + sb.append(" beneficiaryRequiredFields: ") + .append(toIndentedString(beneficiaryRequiredFields)) + .append("\n"); + sb.append(" originatorRequiredFields: ") + .append(toIndentedString(originatorRequiredFields)) + .append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `beneficiaryRequiredFields` to the URL query string + if (getBeneficiaryRequiredFields() != null) { + for (int i = 0; i < getBeneficiaryRequiredFields().size(); i++) { + if (getBeneficiaryRequiredFields().get(i) != null) { + joiner.add( + getBeneficiaryRequiredFields() + .get(i) + .toUrlQueryString( + String.format( + "%sbeneficiaryRequiredFields%s%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", + containerPrefix, + i, + containerSuffix)))); + } + } + } + + // add `originatorRequiredFields` to the URL query string + if (getOriginatorRequiredFields() != null) { + for (int i = 0; i < getOriginatorRequiredFields().size(); i++) { + if (getOriginatorRequiredFields().get(i) != null) { + joiner.add( + getOriginatorRequiredFields() + .get(i) + .toUrlQueryString( + String.format( + "%soriginatorRequiredFields%s%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", + containerPrefix, + i, + containerSuffix)))); + } + } + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredField.java b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredField.java new file mode 100644 index 00000000..b898d2f3 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkRequiredField.java @@ -0,0 +1,186 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** An IVMS101 field requirement with its type and path */ +@JsonPropertyOrder({TRLinkRequiredField.JSON_PROPERTY_TYPE, TRLinkRequiredField.JSON_PROPERTY_PATH}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkRequiredField { + public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; + + public static final String JSON_PROPERTY_PATH = "path"; + @jakarta.annotation.Nonnull private String path; + + public TRLinkRequiredField() {} + + @JsonCreator + public TRLinkRequiredField( + @JsonProperty(value = JSON_PROPERTY_TYPE, required = true) String type, + @JsonProperty(value = JSON_PROPERTY_PATH, required = true) String path) { + this.type = type; + this.path = path; + } + + public TRLinkRequiredField type(@jakarta.annotation.Nonnull String type) { + this.type = type; + return this; + } + + /** + * The person type for this field + * + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(@jakarta.annotation.Nonnull String type) { + this.type = type; + } + + public TRLinkRequiredField path(@jakarta.annotation.Nonnull String path) { + this.path = path; + return this; + } + + /** + * IVMS101 field path + * + * @return path + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getPath() { + return path; + } + + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setPath(@jakarta.annotation.Nonnull String path) { + this.path = path; + } + + /** Return true if this TRLinkRequiredField object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkRequiredField trLinkRequiredField = (TRLinkRequiredField) o; + return Objects.equals(this.type, trLinkRequiredField.type) + && Objects.equals(this.path, trLinkRequiredField.path); + } + + @Override + public int hashCode() { + return Objects.hash(type, path); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkRequiredField {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `type` to the URL query string + if (getType() != null) { + joiner.add( + String.format( + "%stype%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getType())))); + } + + // add `path` to the URL query string + if (getPath() != null) { + joiner.add( + String.format( + "%spath%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getPath())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionData.java b/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionData.java new file mode 100644 index 00000000..1e2599a4 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionData.java @@ -0,0 +1,139 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import java.util.Objects; +import java.util.StringJoiner; + +/** + * Data to submit when resolving an action. The structure varies by action type and is validated by + * the TRP provider. For UPLOAD_BENEFICIARY_PII action type: Contains beneficiaryPii with + * IVMS101-encoded PII data. + */ +@JsonPropertyOrder({TRLinkResolveActionData.JSON_PROPERTY_BENEFICIARY_PII}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkResolveActionData { + public static final String JSON_PROPERTY_BENEFICIARY_PII = "beneficiaryPii"; + @jakarta.annotation.Nullable private TRLinkBeneficiaryPii beneficiaryPii; + + public TRLinkResolveActionData() {} + + public TRLinkResolveActionData beneficiaryPii( + @jakarta.annotation.Nullable TRLinkBeneficiaryPii beneficiaryPii) { + this.beneficiaryPii = beneficiaryPii; + return this; + } + + /** + * Get beneficiaryPii + * + * @return beneficiaryPii + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_BENEFICIARY_PII) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public TRLinkBeneficiaryPii getBeneficiaryPii() { + return beneficiaryPii; + } + + @JsonProperty(JSON_PROPERTY_BENEFICIARY_PII) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBeneficiaryPii( + @jakarta.annotation.Nullable TRLinkBeneficiaryPii beneficiaryPii) { + this.beneficiaryPii = beneficiaryPii; + } + + /** Return true if this TRLinkResolveActionData object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkResolveActionData trLinkResolveActionData = (TRLinkResolveActionData) o; + return Objects.equals(this.beneficiaryPii, trLinkResolveActionData.beneficiaryPii); + } + + @Override + public int hashCode() { + return Objects.hash(beneficiaryPii); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkResolveActionData {\n"); + sb.append(" beneficiaryPii: ").append(toIndentedString(beneficiaryPii)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `beneficiaryPii` to the URL query string + if (getBeneficiaryPii() != null) { + joiner.add(getBeneficiaryPii().toUrlQueryString(prefix + "beneficiaryPii" + suffix)); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionRequest.java b/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionRequest.java new file mode 100644 index 00000000..d6b4d745 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/TRLinkResolveActionRequest.java @@ -0,0 +1,185 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.Objects; +import java.util.StringJoiner; + +/** Request to resolve a pending TRM action */ +@JsonPropertyOrder({ + TRLinkResolveActionRequest.JSON_PROPERTY_TYPE, + TRLinkResolveActionRequest.JSON_PROPERTY_DATA +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class TRLinkResolveActionRequest { + public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; + + public static final String JSON_PROPERTY_DATA = "data"; + @jakarta.annotation.Nullable private TRLinkResolveActionData data; + + public TRLinkResolveActionRequest() {} + + @JsonCreator + public TRLinkResolveActionRequest( + @JsonProperty(value = JSON_PROPERTY_TYPE, required = true) String type) { + this.type = type; + } + + public TRLinkResolveActionRequest type(@jakarta.annotation.Nonnull String type) { + this.type = type; + return this; + } + + /** + * The action type identifier as defined by the Travel Rule provider. Must match one of the + * types returned by the get required actions endpoint. Values are provider-specific and may + * vary across different TRP implementations. + * + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(@jakarta.annotation.Nonnull String type) { + this.type = type; + } + + public TRLinkResolveActionRequest data( + @jakarta.annotation.Nullable TRLinkResolveActionData data) { + this.data = data; + return this; + } + + /** + * Get data + * + * @return data + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public TRLinkResolveActionData getData() { + return data; + } + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setData(@jakarta.annotation.Nullable TRLinkResolveActionData data) { + this.data = data; + } + + /** Return true if this TRLinkResolveActionRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TRLinkResolveActionRequest trLinkResolveActionRequest = (TRLinkResolveActionRequest) o; + return Objects.equals(this.type, trLinkResolveActionRequest.type) + && Objects.equals(this.data, trLinkResolveActionRequest.data); + } + + @Override + public int hashCode() { + return Objects.hash(type, data); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TRLinkResolveActionRequest {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `type` to the URL query string + if (getType() != null) { + joiner.add( + String.format( + "%stype%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getType())))); + } + + // add `data` to the URL query string + if (getData() != null) { + joiner.add(getData().toUrlQueryString(prefix + "data" + suffix)); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequest.java b/src/main/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequest.java new file mode 100644 index 00000000..10c3b0e9 --- /dev/null +++ b/src/main/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequest.java @@ -0,0 +1,281 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fireblocks.sdk.ApiClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** Request body for updating an existing counterparty group */ +@JsonPropertyOrder({ + UpdateCounterpartyGroupRequest.JSON_PROPERTY_NAME, + UpdateCounterpartyGroupRequest.JSON_PROPERTY_DESCRIPTION, + UpdateCounterpartyGroupRequest.JSON_PROPERTY_JURISDICTION_CODES, + UpdateCounterpartyGroupRequest.JSON_PROPERTY_IS_ACTIVE +}) +@jakarta.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.14.0") +public class UpdateCounterpartyGroupRequest { + public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + @jakarta.annotation.Nullable private String description; + + public static final String JSON_PROPERTY_JURISDICTION_CODES = "jurisdictionCodes"; + @jakarta.annotation.Nullable private List jurisdictionCodes; + + public static final String JSON_PROPERTY_IS_ACTIVE = "isActive"; + @jakarta.annotation.Nullable private Boolean isActive; + + public UpdateCounterpartyGroupRequest() {} + + public UpdateCounterpartyGroupRequest name(@jakarta.annotation.Nullable String name) { + this.name = name; + return this; + } + + /** + * Updated human-readable name of the group + * + * @return name + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getName() { + return name; + } + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(@jakarta.annotation.Nullable String name) { + this.name = name; + } + + public UpdateCounterpartyGroupRequest description( + @jakarta.annotation.Nullable String description) { + this.description = description; + return this; + } + + /** + * Updated description of the group + * + * @return description + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getDescription() { + return description; + } + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(@jakarta.annotation.Nullable String description) { + this.description = description; + } + + public UpdateCounterpartyGroupRequest jurisdictionCodes( + @jakarta.annotation.Nullable List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + return this; + } + + public UpdateCounterpartyGroupRequest addJurisdictionCodesItem(String jurisdictionCodesItem) { + if (this.jurisdictionCodes == null) { + this.jurisdictionCodes = new ArrayList<>(); + } + this.jurisdictionCodes.add(jurisdictionCodesItem); + return this; + } + + /** + * Updated list of jurisdiction codes for the group + * + * @return jurisdictionCodes + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getJurisdictionCodes() { + return jurisdictionCodes; + } + + @JsonProperty(JSON_PROPERTY_JURISDICTION_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setJurisdictionCodes(@jakarta.annotation.Nullable List jurisdictionCodes) { + this.jurisdictionCodes = jurisdictionCodes; + } + + public UpdateCounterpartyGroupRequest isActive(@jakarta.annotation.Nullable Boolean isActive) { + this.isActive = isActive; + return this; + } + + /** + * Whether the counterparty group should be active + * + * @return isActive + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_ACTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsActive() { + return isActive; + } + + @JsonProperty(JSON_PROPERTY_IS_ACTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsActive(@jakarta.annotation.Nullable Boolean isActive) { + this.isActive = isActive; + } + + /** Return true if this UpdateCounterpartyGroupRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UpdateCounterpartyGroupRequest updateCounterpartyGroupRequest = + (UpdateCounterpartyGroupRequest) o; + return Objects.equals(this.name, updateCounterpartyGroupRequest.name) + && Objects.equals(this.description, updateCounterpartyGroupRequest.description) + && Objects.equals( + this.jurisdictionCodes, updateCounterpartyGroupRequest.jurisdictionCodes) + && Objects.equals(this.isActive, updateCounterpartyGroupRequest.isActive); + } + + @Override + public int hashCode() { + return Objects.hash(name, description, jurisdictionCodes, isActive); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UpdateCounterpartyGroupRequest {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" jurisdictionCodes: ") + .append(toIndentedString(jurisdictionCodes)) + .append("\n"); + sb.append(" isActive: ").append(toIndentedString(isActive)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `name` to the URL query string + if (getName() != null) { + joiner.add( + String.format( + "%sname%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getName())))); + } + + // add `description` to the URL query string + if (getDescription() != null) { + joiner.add( + String.format( + "%sdescription%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getDescription())))); + } + + // add `jurisdictionCodes` to the URL query string + if (getJurisdictionCodes() != null) { + for (int i = 0; i < getJurisdictionCodes().size(); i++) { + joiner.add( + String.format( + "%sjurisdictionCodes%s%s=%s", + prefix, + suffix, + "".equals(suffix) + ? "" + : String.format( + "%s%d%s", containerPrefix, i, containerSuffix), + ApiClient.urlEncode( + ApiClient.valueToString(getJurisdictionCodes().get(i))))); + } + } + + // add `isActive` to the URL query string + if (getIsActive() != null) { + joiner.add( + String.format( + "%sisActive%s=%s", + prefix, + suffix, + ApiClient.urlEncode(ApiClient.valueToString(getIsActive())))); + } + + return joiner.toString(); + } +} diff --git a/src/main/java/com/fireblocks/sdk/model/WithdrawRequest.java b/src/main/java/com/fireblocks/sdk/model/WithdrawRequest.java index 66103a18..376a849a 100644 --- a/src/main/java/com/fireblocks/sdk/model/WithdrawRequest.java +++ b/src/main/java/com/fireblocks/sdk/model/WithdrawRequest.java @@ -154,9 +154,11 @@ public WithdrawRequest amount(@jakarta.annotation.Nullable String amount) { } /** - * Amount of tokens to withdraw. Only supported for Cosmos chains to enable partial withdrawals. - * For other chains, this field is ignored and the entire available amount will be withdrawn. If - * not provided, the entire available amount will be withdrawn. + * Amount of tokens to withdraw. Only supported for ETH compounding validators (EIP-7251/Pectra) + * and Cosmos chains to enable partial withdrawals. For ETH compounding validators, the + * remaining balance must be at least 32 ETH after withdrawal. For other chains, this field is + * ignored and the entire available amount will be withdrawn. If not provided, the entire + * available amount will be withdrawn. * * @return amount */ diff --git a/src/test/java/com/fireblocks/sdk/api/ApiUserApiTest.java b/src/test/java/com/fireblocks/sdk/api/ApiUserApiTest.java index c15d872d..68cae2c9 100644 --- a/src/test/java/com/fireblocks/sdk/api/ApiUserApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ApiUserApiTest.java @@ -31,8 +31,8 @@ public class ApiUserApiTest { * Create API Key * *

Create a new API key in your workspace. Learn more about Fireblocks API Keys management in - * the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -49,7 +49,7 @@ public void createApiUserTest() throws ApiException { * Get API Keys * *

List all API keys in your workspace. - Please note that this endpoint is available only - * for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, + * for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, * Non-Signing Admin. * * @throws ApiException if the Api call fails diff --git a/src/test/java/com/fireblocks/sdk/api/AuditLogsApiTest.java b/src/test/java/com/fireblocks/sdk/api/AuditLogsApiTest.java index 4098916e..2f3d53a3 100644 --- a/src/test/java/com/fireblocks/sdk/api/AuditLogsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/AuditLogsApiTest.java @@ -30,7 +30,7 @@ public class AuditLogsApiTest { * Get audit logs * *

Get Audit logs for the last Day/Week. - Please note that this endpoint is available only - * for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, + * for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, * Non-Signing Admin. * * @throws ApiException if the Api call fails diff --git a/src/test/java/com/fireblocks/sdk/api/BlockchainsAssetsApiTest.java b/src/test/java/com/fireblocks/sdk/api/BlockchainsAssetsApiTest.java index ff3f14d8..276848dc 100644 --- a/src/test/java/com/fireblocks/sdk/api/BlockchainsAssetsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/BlockchainsAssetsApiTest.java @@ -42,9 +42,9 @@ public class BlockchainsAssetsApiTest { /** * Get an asset * - *

Returns an asset by ID or legacyID.</br> **Note**: - We will continue displaying and - * supporting the legacy ID (API ID). Since not all Fireblocks services fully support the new - * Assets UUID, please use only the legacy ID until further notice. + *

Returns an asset by ID or legacyID. **Note**: - We will continue displaying and supporting + * the legacy ID (API ID). Since not all Fireblocks services fully support the new Assets UUID, + * please use only the legacy ID until further notice. * * @throws ApiException if the Api call fails */ @@ -122,7 +122,7 @@ public void listAssetsTest() throws ApiException { /** * List blockchains * - *

Returns all blockchains supported by Fireblocks.</br> + *

Returns all blockchains supported by Fireblocks. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ComplianceApiTest.java b/src/test/java/com/fireblocks/sdk/api/ComplianceApiTest.java index 81e425f3..9155bccd 100644 --- a/src/test/java/com/fireblocks/sdk/api/ComplianceApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ComplianceApiTest.java @@ -33,6 +33,9 @@ import com.fireblocks.sdk.model.ByorkVerdictRequest; import com.fireblocks.sdk.model.ByorkVerdictResponse; import com.fireblocks.sdk.model.ComplianceResultFullPayload; +import com.fireblocks.sdk.model.CounterpartyGroup; +import com.fireblocks.sdk.model.CounterpartyGroupsPaginatedResponse; +import com.fireblocks.sdk.model.CreateCounterpartyGroupRequest; import com.fireblocks.sdk.model.CreateTransactionResponse; import com.fireblocks.sdk.model.GetByorkVerdictResponse; import com.fireblocks.sdk.model.LegalEntityRegistration; @@ -43,6 +46,7 @@ import com.fireblocks.sdk.model.ScreeningPolicyResponse; import com.fireblocks.sdk.model.ScreeningProviderRulesConfigurationResponse; import com.fireblocks.sdk.model.ScreeningUpdateConfigurations; +import com.fireblocks.sdk.model.UpdateCounterpartyGroupRequest; import com.fireblocks.sdk.model.UpdateLegalEntityRequest; import java.util.UUID; import java.util.concurrent.CompletableFuture; @@ -91,8 +95,8 @@ public void addAddressRegistryVaultOptOutsTest() throws ApiException { * Assign vault accounts to a legal entity * *

Assigns one or more vault accounts to a specific legal entity registration. Explicitly - * mapped vault accounts take precedence over the workspace default legal entity. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * mapped vault accounts take precedence over the workspace default legal entity. Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -106,6 +110,21 @@ public void assignVaultsToLegalEntityTest() throws ApiException { assignVaultsToLegalEntityRequest, legalEntityId, idempotencyKey); } + /** + * Create a counterparty group + * + *

Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. + * + * @throws ApiException if the Api call fails + */ + @Test + public void createCounterpartyGroupTest() throws ApiException { + CreateCounterpartyGroupRequest createCounterpartyGroupRequest = null; + String idempotencyKey = null; + CompletableFuture> response = + api.createCounterpartyGroup(createCounterpartyGroupRequest, idempotencyKey); + } + /** * Deactivate BYORK Light * @@ -122,6 +141,21 @@ public void deactivateByorkConfigTest() throws ApiException { api.deactivateByorkConfig(idempotencyKey); } + /** + * Delete a counterparty group + * + *

Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing + * Admin. + * + * @throws ApiException if the Api call fails + */ + @Test + public void deleteCounterpartyGroupTest() throws ApiException { + UUID groupId = null; + + CompletableFuture> response = api.deleteCounterpartyGroup(groupId); + } + /** * Get address registry participation status for the authenticated workspace * @@ -209,12 +243,26 @@ public void getByorkVerdictTest() throws ApiException { api.getByorkVerdict(txId); } + /** + * Get a counterparty group + * + *

Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, + * Non-Signing Admin, Viewer. + * + * @throws ApiException if the Api call fails + */ + @Test + public void getCounterpartyGroupTest() throws ApiException { + UUID groupId = null; + CompletableFuture> response = + api.getCounterpartyGroup(groupId); + } + /** * Get a legal entity * *

Returns details of a specific legal entity registration, including GLEIF data when - * available. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor, Viewer. + * available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -300,6 +348,22 @@ public void listAddressRegistryVaultOptOutsTest() throws ApiException { api.listAddressRegistryVaultOptOuts(pageCursor, pageSize, order); } + /** + * List counterparty groups + * + *

Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, + * Non-Signing Admin, Viewer. + * + * @throws ApiException if the Api call fails + */ + @Test + public void listCounterpartyGroupsTest() throws ApiException { + String pageCursor = null; + Integer pageSize = null; + CompletableFuture> response = + api.listCounterpartyGroups(pageCursor, pageSize); + } + /** * List legal entities (Paginated) * @@ -307,8 +371,8 @@ public void listAddressRegistryVaultOptOutsTest() throws ApiException { * query parameter vaultAccountId is used it returns the legal entity registration associated * with a specific vault account. If no explicit mapping exists for the vault, the workspace * default legal entity is returned. Returns an empty response if neither a vault mapping nor a - * default legal entity is configured. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + * default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -325,8 +389,8 @@ public void listLegalEntitiesTest() throws ApiException { * List vault accounts for a legal entity (Paginated) * *

Returns vault account IDs explicitly assigned to a specific legal entity registration, - * with cursor-based pagination. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + * with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -373,7 +437,7 @@ public void optOutAddressRegistryTenantTest() throws ApiException { * *

Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) * code. The LEI is validated against the GLEIF registry. Each workspace can register multiple - * legal entities. </br>Endpoint Permission: Admin, Non-Signing Admin. + * legal entities. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -501,12 +565,30 @@ public void updateAmlScreeningConfigurationTest() throws ApiException { api.updateAmlScreeningConfiguration(idempotencyKey); } + /** + * Update a counterparty group + * + *

Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing + * Admin. + * + * @throws ApiException if the Api call fails + */ + @Test + public void updateCounterpartyGroupTest() throws ApiException { + UpdateCounterpartyGroupRequest updateCounterpartyGroupRequest = null; + UUID groupId = null; + String idempotencyKey = null; + CompletableFuture> response = + api.updateCounterpartyGroup( + updateCounterpartyGroupRequest, groupId, idempotencyKey); + } + /** * Update legal entity * *

Updates the status of a legal entity registration. Setting isDefault to true marks the * registration as the workspace default, which is applied to vault accounts that have no - * explicit legal entity mapping. </br>Endpoint Permission: Admin, Non-Signing Admin. + * explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApiTest.java index 7327c103..87218c18 100644 --- a/src/test/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ConnectedAccountsBetaApiTest.java @@ -35,8 +35,8 @@ public class ConnectedAccountsBetaApiTest { /** * Disconnect connected account * - *

Disconnect a connected account by ID. </br> **Note**: - This endpoint is currently - * in beta and might be subject to changes. + *

Disconnect a connected account by ID. **Note**: - This endpoint is currently in beta and + * might be subject to changes. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ConsoleUserApiTest.java b/src/test/java/com/fireblocks/sdk/api/ConsoleUserApiTest.java index 485d3f70..bfc71464 100644 --- a/src/test/java/com/fireblocks/sdk/api/ConsoleUserApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ConsoleUserApiTest.java @@ -33,7 +33,7 @@ public class ConsoleUserApiTest { *

Create console users in your workspace - Please note that this endpoint is available only * for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users * management in the following [guide](https://developers.fireblocks.com/docs/manage-users). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -50,7 +50,7 @@ public void createConsoleUserTest() throws ApiException { * Get console users * *

Get console users for your workspace. - Please note that this endpoint is available only - * for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, + * for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, * Non-Signing Admin. * * @throws ApiException if the Api call fails diff --git a/src/test/java/com/fireblocks/sdk/api/ContractInteractionsApiTest.java b/src/test/java/com/fireblocks/sdk/api/ContractInteractionsApiTest.java index 86f54cde..a82ae336 100644 --- a/src/test/java/com/fireblocks/sdk/api/ContractInteractionsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ContractInteractionsApiTest.java @@ -74,8 +74,7 @@ public void getContractAddressTest() throws ApiException { * Return deployed contract's ABI * *

Return deployed contract's ABI by blockchain native asset id and contract address. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and - * Viewer. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. * * @throws ApiException if the Api call fails */ @@ -93,8 +92,8 @@ public void getDeployedContractAbiTest() throws ApiException { * *

Retrieve the transaction receipt by blockchain native asset ID and transaction hash > * **Note** > This functionality is exclusively available for EVM (Ethereum Virtual Machine) - * compatible chains. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, and Viewer. + * compatible chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, + * and Viewer. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ContractTemplatesApiTest.java b/src/test/java/com/fireblocks/sdk/api/ContractTemplatesApiTest.java index 6fb494ae..c24304e2 100644 --- a/src/test/java/com/fireblocks/sdk/api/ContractTemplatesApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ContractTemplatesApiTest.java @@ -99,7 +99,7 @@ public void getContractTemplateByIdTest() throws ApiException { * List all contract templates * *

Return minimal representation of all the contract templates available for the workspace. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ContractsApiTest.java b/src/test/java/com/fireblocks/sdk/api/ContractsApiTest.java index de85d733..8057767d 100644 --- a/src/test/java/com/fireblocks/sdk/api/ContractsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ContractsApiTest.java @@ -33,8 +33,8 @@ public class ContractsApiTest { /** * Add an asset to a whitelisted contract * - *

Adds an asset to a whitelisted contract. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Adds an asset to a whitelisted contract. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -51,8 +51,8 @@ public void addContractAssetTest() throws ApiException { /** * Add a contract * - *

Adds a contract to the workspace whitelist. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Adds a contract to the workspace whitelist. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -67,8 +67,8 @@ public void createContractTest() throws ApiException { /** * Delete a contract * - *

Deletes a contract by ID. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor. + *

Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor. * * @throws ApiException if the Api call fails */ @@ -82,8 +82,8 @@ public void deleteContractTest() throws ApiException { /** * Delete an asset from a whitelisted contract * - *

Deletes a whitelisted contract asset by ID. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Deletes a whitelisted contract asset by ID. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -99,8 +99,8 @@ public void deleteContractAssetTest() throws ApiException { /** * Find a Specific Whitelisted Contract * - *

Returns a whitelisted contract by Fireblocks Contract ID. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Returns a whitelisted contract by Fireblocks Contract ID. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -113,8 +113,8 @@ public void getContractTest() throws ApiException { /** * Find a whitelisted contract's asset * - *

Returns a whitelisted contract's asset by ID. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Returns a whitelisted contract's asset by ID. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -129,8 +129,8 @@ public void getContractAssetTest() throws ApiException { /** * List Whitelisted Contracts * - *

Gets a list of whitelisted contracts. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor, Viewer. + *

Gets a list of whitelisted contracts. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/CosignersBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/CosignersBetaApiTest.java index 6a7e6f2e..728a0005 100644 --- a/src/test/java/com/fireblocks/sdk/api/CosignersBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/CosignersBetaApiTest.java @@ -43,7 +43,7 @@ public class CosignersBetaApiTest { * Add cosigner * *

Add a new cosigner. The cosigner will be pending pairing until the API key is manually - * paired </br>Endpoint Permission: Admin and Non-Signing Admin. + * paired Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -59,7 +59,7 @@ public void addCosignerTest() throws ApiException { * Get API key * *

Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject - * to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -74,8 +74,7 @@ public void getApiKeyTest() throws ApiException { * Get all API keys * *

Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in - * beta and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing - * Admin. + * beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -93,7 +92,7 @@ public void getApiKeysTest() throws ApiException { * Get cosigner * *

Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject - * to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -107,7 +106,7 @@ public void getCosignerTest() throws ApiException { * Get all cosigners * *

Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta - * and might be subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -123,8 +122,8 @@ public void getCosignersTest() throws ApiException { /** * Get request status * - *

Get the status of an asynchronous request </br>Endpoint Permission: Admin and - * Non-Signing Admin. + *

Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing + * Admin. * * @throws ApiException if the Api call fails */ @@ -140,7 +139,7 @@ public void getRequestStatusTest() throws ApiException { /** * Pair API key * - *

Pair an API key to a cosigner </br>Endpoint Permission: Admin and Non-Signing Admin. + *

Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -158,7 +157,7 @@ public void pairApiKeyTest() throws ApiException { * Rename cosigner * *

Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be - * subject to changes. </br>Endpoint Permission: Admin and Non-Signing Admin. + * subject to changes. Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -173,8 +172,7 @@ public void renameCosignerTest() throws ApiException { /** * Unpair API key * - *

Unpair an API key from a cosigner </br>Endpoint Permission: Admin and Non-Signing - * Admin. + *

Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -188,8 +186,8 @@ public void unpairApiKeyTest() throws ApiException { /** * Update API key callback handler * - *

Update the callback handler of an API key </br>Endpoint Permission: Admin and - * Non-Signing Admin. + *

Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing + * Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ExchangeAccountsApiTest.java b/src/test/java/com/fireblocks/sdk/api/ExchangeAccountsApiTest.java index df52fa09..350035fd 100644 --- a/src/test/java/com/fireblocks/sdk/api/ExchangeAccountsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ExchangeAccountsApiTest.java @@ -64,7 +64,7 @@ public void addExchangeAccountTest() throws ApiException { * (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions. Learn more about * Fireblocks Exchange Connectivity in the following * [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -80,8 +80,7 @@ public void convertAssetsTest() throws ApiException { /** * Get a specific exchange account * - *

Returns an exchange account by ID. </br>Endpoint Permission: Admin, Non-Signing - * Admin. + *

Returns an exchange account by ID. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -95,8 +94,7 @@ public void getExchangeAccountTest() throws ApiException { /** * Get an asset for an exchange account * - *

Returns an asset for an exchange account. </br>Endpoint Permission: Admin, - * Non-Signing Admin. + *

Returns an asset for an exchange account. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -124,8 +122,8 @@ public void getExchangeAccountsCredentialsPublicKeyTest() throws ApiException { /** * List connected exchange accounts * - *

Returns a list of the connected exchange accounts in your workspace. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + *

Returns a list of the connected exchange accounts in your workspace. Endpoint Permission: + * Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -144,7 +142,7 @@ public void getPagedExchangeAccountsTest() throws ApiException { *

Transfers funds between trading accounts under the same exchange account. Learn more about * Fireblocks Exchange Connectivity in the following * [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ExternalWalletsApiTest.java b/src/test/java/com/fireblocks/sdk/api/ExternalWalletsApiTest.java index 3b10c0f3..95fdb781 100644 --- a/src/test/java/com/fireblocks/sdk/api/ExternalWalletsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ExternalWalletsApiTest.java @@ -34,8 +34,8 @@ public class ExternalWalletsApiTest { /** * Add an asset to an external wallet. * - *

Adds an asset to an existing external wallet. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Adds an asset to an existing external wallet. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -56,8 +56,8 @@ public void addAssetToExternalWalletTest() throws ApiException { *

Creates a new external wallet with the requested name. External Wallet is a whitelisted * address of a wallet that belongs to your users/counterparties. - You cannot see the balance * of the external wallet. - You cannot initiate transactions from an external wallet as the - * source via Fireblocks. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor. + * source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor. * * @throws ApiException if the Api call fails */ @@ -73,8 +73,8 @@ public void createExternalWalletTest() throws ApiException { * Delete an external wallet * *

Deletes an external wallet by ID. External Wallet is a whitelisted address of a wallet - * that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + * that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -89,8 +89,8 @@ public void deleteExternalWalletTest() throws ApiException { * Find an external wallet * *

Returns an external wallet by ID. External Wallet is a whitelisted address of a wallet - * that belongs to your users/counterparties. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor, Viewer. + * that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -104,8 +104,8 @@ public void getExternalWalletTest() throws ApiException { * Get an asset from an external wallet * *

Returns an external wallet by wallet ID and asset ID. External Wallet is a whitelisted - * address of a wallet that belongs to your users/counterparties. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -123,8 +123,8 @@ public void getExternalWalletAssetTest() throws ApiException { *

Gets a list of external wallets under the workspace. External Wallet is a whitelisted * address of a wallet that belongs to your users/counterparties. - You cannot see the balance * of the external wallet. - You cannot initiate transactions from an external wallet as the - * source via Fireblocks. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor, Viewer. + * source via Fireblocks. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, + * Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -136,8 +136,8 @@ public void getExternalWalletsTest() throws ApiException { /** * Delete an asset from an external wallet * - *

Deletes an external wallet asset by ID. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + *

Deletes an external wallet asset by ID. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -154,8 +154,8 @@ public void removeAssetFromExternalWalletTest() throws ApiException { * Set an AML customer reference ID for an external wallet * *

Sets an AML/KYT customer reference ID for the specific external wallet. External Wallet is - * a whitelisted address of a wallet that belongs to your users/counterparties. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/FiatAccountsApiTest.java b/src/test/java/com/fireblocks/sdk/api/FiatAccountsApiTest.java index 1bcbac61..524d3d62 100644 --- a/src/test/java/com/fireblocks/sdk/api/FiatAccountsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/FiatAccountsApiTest.java @@ -49,7 +49,7 @@ public void depositFundsFromLinkedDDATest() throws ApiException { /** * Find a specific fiat account * - *

Returns a fiat account by ID. </br>Endpoint Permission: Admin, Non-Signing Admin. + *

Returns a fiat account by ID. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -62,7 +62,7 @@ public void getFiatAccountTest() throws ApiException { /** * List fiat accounts * - *

Returns all fiat accounts. </br>Endpoint Permission: Admin, Non-Signing Admin. + *

Returns all fiat accounts. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/GasStationsApiTest.java b/src/test/java/com/fireblocks/sdk/api/GasStationsApiTest.java index 8955b75d..abe0d3dc 100644 --- a/src/test/java/com/fireblocks/sdk/api/GasStationsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/GasStationsApiTest.java @@ -31,8 +31,8 @@ public class GasStationsApiTest { /** * Get gas station settings by asset * - *

Returns gas station settings and balances for a requested asset. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Returns gas station settings and balances for a requested asset. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -46,8 +46,8 @@ public void getGasStationByAssetIdTest() throws ApiException { /** * Get gas station settings * - *

Returns gas station settings and ETH balance. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Returns gas station settings and ETH balance. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -61,8 +61,8 @@ public void getGasStationInfoTest() throws ApiException { * Edit gas station settings * *

Configures gas station settings for ETH. Learn more about the Fireblocks Gas Station in - * the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -79,8 +79,8 @@ public void updateGasStationConfigurationTest() throws ApiException { * *

Configures gas station settings for a requested asset. Learn more about the Fireblocks Gas * Station in the following - * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/NftsApiTest.java b/src/test/java/com/fireblocks/sdk/api/NftsApiTest.java index 02b7a6fe..9622264c 100644 --- a/src/test/java/com/fireblocks/sdk/api/NftsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/NftsApiTest.java @@ -175,8 +175,8 @@ public void refreshNFTMetadataTest() throws ApiException { * *

Updates all tokens and balances per blockchain and vault account. Learn more about * Fireblocks NFT management in the following - * [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/OffExchangesApiTest.java b/src/test/java/com/fireblocks/sdk/api/OffExchangesApiTest.java index f4b441cd..fd408b09 100644 --- a/src/test/java/com/fireblocks/sdk/api/OffExchangesApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/OffExchangesApiTest.java @@ -36,8 +36,8 @@ public class OffExchangesApiTest { * Add Collateral * *

Add collateral and create deposit request. Learn more about Fireblocks Off Exchange in the - * following [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -54,7 +54,7 @@ public void addOffExchangeTest() throws ApiException { * *

Returns a collateral account by mainExchangeAccountId. Learn more about Fireblocks Off * Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -69,8 +69,8 @@ public void getOffExchangeCollateralAccountsTest() throws ApiException { * Get Settlements Transactions * *

Get settlements transactions from exchange. Learn more about Fireblocks Off Exchange in - * the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -85,8 +85,8 @@ public void getOffExchangeSettlementTransactionsTest() throws ApiException { * Remove Collateral * *

Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in - * the following [guide](https://developers.fireblocks.com/docs/off-exchange). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -102,8 +102,8 @@ public void removeOffExchangeTest() throws ApiException { * Create Settlement for a Trader * *

Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following - * [guide](https://developers.fireblocks.com/docs/off-exchange). </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/PaymentsPayoutApiTest.java b/src/test/java/com/fireblocks/sdk/api/PaymentsPayoutApiTest.java index aaba3546..76baa20c 100644 --- a/src/test/java/com/fireblocks/sdk/api/PaymentsPayoutApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/PaymentsPayoutApiTest.java @@ -33,19 +33,17 @@ public class PaymentsPayoutApiTest { * *

**Note:** The reference content in this section documents the Payments Engine endpoint. * The Payments Engine endpoints include APIs available only for customers with Payments Engine - * enabled on their accounts. </br> </br>These endpoints are currently in beta and - * might be subject to changes.</br> </br>If you want to learn more about Fireblocks - * Payments Engine, please contact your Fireblocks Customer Success Manager or email - * CSM@fireblocks.com. </br> </br> <b u>Create a payout instruction - * set.</b> </u></br> A payout instruction set is a set of instructions for - * distributing payments from a single payment account to a list of payee accounts. </br> - * The instruction set defines: </br> <ul> <li>the payment account and its - * account type (vault, exchange, or fiat). </li> <li>the account type (vault - * account, exchange account, whitelisted address, network connection, fiat account, or merchant - * account), the amount, and the asset of payment for each payee account.</li> </ul> - * Learn more about Fireblocks Payments - Payouts in the following - * [guide](https://developers.fireblocks.com/docs/create-payouts). </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * enabled on their accounts. These endpoints are currently in beta and might be subject to + * changes. If you want to learn more about Fireblocks Payments Engine, please contact your + * Fireblocks Customer Success Manager or email CSM@fireblocks.com. **Create a payout + * instruction set.** A payout instruction set is a set of instructions for distributing + * payments from a single payment account to a list of payee accounts. The instruction set + * defines: - the payment account and its account type (vault, exchange, or fiat). - the account + * type (vault account, exchange account, whitelisted address, network connection, fiat account, + * or merchant account), the amount, and the asset of payment for each payee account. Learn more + * about Fireblocks Payments - Payouts in the following + * [guide](https://developers.fireblocks.com/docs/create-payouts). Endpoint Permission: Admin, + * Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -62,15 +60,13 @@ public void createPayoutTest() throws ApiException { * *

**Note:** The reference content in this section documents the Payments Engine endpoint. * The Payments Engine endpoints include APIs available only for customers with Payments Engine - * enabled on their accounts. </br> </br>These endpoints are currently in beta and - * might be subject to changes.</br> </br>If you want to learn more about Fireblocks - * Payments Engine, please contact your Fireblocks Customer Success Manager or email - * CSM@fireblocks.com. </br> </br><b u>Execute a payout instruction - * set.</b> </u> </br> </br>The instruction set will be verified and - * executed.</br> <b><u>Source locking</br></b> </u> If you - * are executing a payout instruction set from a payment account with an already active payout - * the active payout will complete before the new payout instruction set can be executed. - * </br> You cannot execute the same payout instruction set more than once. + * enabled on their accounts. These endpoints are currently in beta and might be subject to + * changes. If you want to learn more about Fireblocks Payments Engine, please contact your + * Fireblocks Customer Success Manager or email CSM@fireblocks.com. **Execute a payout + * instruction set.** The instruction set will be verified and executed. **Source locking** If + * you are executing a payout instruction set from a payment account with an already active + * payout the active payout will complete before the new payout instruction set can be executed. + * You cannot execute the same payout instruction set more than once. * * @throws ApiException if the Api call fails */ @@ -87,10 +83,10 @@ public void executePayoutActionTest() throws ApiException { * *

**Note:** The reference content in this section documents the Payments Engine endpoint. * The Payments Engine endpoints include APIs available only for customers with Payments Engine - * enabled on their accounts. </br> </br>These endpoints are currently in beta and - * might be subject to changes.</br> </br>If you want to learn more about Fireblocks - * Payments Engine, please contact your Fireblocks Customer Success Manager or email - * CSM@fireblocks.com. </br> </br>Endpoint Permission: Admin, Non-Signing Admin. + * enabled on their accounts. These endpoints are currently in beta and might be subject to + * changes. If you want to learn more about Fireblocks Payments Engine, please contact your + * Fireblocks Customer Success Manager or email CSM@fireblocks.com. Endpoint Permission: Admin, + * Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/PolicyEditorBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/PolicyEditorBetaApiTest.java index 090c829d..d05f8267 100644 --- a/src/test/java/com/fireblocks/sdk/api/PolicyEditorBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/PolicyEditorBetaApiTest.java @@ -33,13 +33,13 @@ public class PolicyEditorBetaApiTest { /** * Get the active policy and its validation * - *

Legacy Endpoint – Returns the active policy and its validation. </br> **Note:** - - * This endpoint will remain available for the foreseeable future and is not - * deprecated.</br> - The `getActivePolicy` endpoint under policy/paths provides - * policy type-specific operations and improved functionality.</br> - These endpoints are - * currently in beta and might be subject to changes.</br> If you want to participate and - * learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager - * or send an email to CSM@fireblocks.com. + *

Legacy Endpoint – Returns the active policy and its validation. **Note:** - This endpoint + * will remain available for the foreseeable future and is not deprecated. - The + * `getActivePolicy` endpoint under policy/paths provides policy type-specific + * operations and improved functionality. - These endpoints are currently in beta and might be + * subject to changes. If you want to participate and learn more about the Fireblocks TAP, + * please contact your Fireblocks Customer Success Manager or send an email to + * CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ @@ -52,13 +52,12 @@ public void getActivePolicyLegacyTest() throws ApiException { /** * Get the active draft * - *

Legacy Endpoint – Returns the active draft and its validation. </br> **Note:** - - * This endpoint will remain available for the foreseeable future and is not - * deprecated.</br> - The `getDraft` endpoint under policy/paths provides policy - * type-specific operations and improved functionality.</br> - These endpoints are - * currently in beta and might be subject to changes.</br> If you want to participate and - * learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager - * or send an email to CSM@fireblocks.com. + *

Legacy Endpoint – Returns the active draft and its validation. **Note:** - This endpoint + * will remain available for the foreseeable future and is not deprecated. - The + * `getDraft` endpoint under policy/paths provides policy type-specific operations and + * improved functionality. - These endpoints are currently in beta and might be subject to + * changes. If you want to participate and learn more about the Fireblocks TAP, please contact + * your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ @@ -72,12 +71,12 @@ public void getDraftLegacyTest() throws ApiException { * Send publish request for a certain draft id * *

Legacy Endpoint – Send publish request of certain draft id and returns the response. - * </br> **Note:** - This endpoint will remain available for the foreseeable future and is - * not deprecated.</br> - The `publishDraft` endpoint under policy/paths - * provides improved functionality and better performance.</br> - These endpoints are - * currently in beta and might be subject to changes.</br> If you want to participate and - * learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager - * or send an email to CSM@fireblocks.com. + * **Note:** - This endpoint will remain available for the foreseeable future and is not + * deprecated. - The `publishDraft` endpoint under policy/paths provides improved + * functionality and better performance. - These endpoints are currently in beta and might be + * subject to changes. If you want to participate and learn more about the Fireblocks TAP, + * please contact your Fireblocks Customer Success Manager or send an email to + * CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ @@ -92,10 +91,10 @@ public void publishDraftLegacyTest() throws ApiException { /** * Send publish request for a set of policy rules * - *

Send publish request of set of policy rules and returns the response. </br> - * **Note:** These endpoints are currently in beta and might be subject to changes. If you want - * to participate and learn more about the Fireblocks TAP, please contact your Fireblocks - * Customer Success Manager or send an email to CSM@fireblocks.com. + *

Send publish request of set of policy rules and returns the response. **Note:** These + * endpoints are currently in beta and might be subject to changes. If you want to participate + * and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success + * Manager or send an email to CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ @@ -110,13 +109,12 @@ public void publishPolicyRulesTest() throws ApiException { /** * Update the draft with a new set of rules * - *

Legacy Endpoint – Update the draft and return its validation. </br> **Note:** - This - * endpoint will remain available for the foreseeable future and is not deprecated.</br> - - * The `updateDraft` endpoint under policy/paths provides policy type-specific - * operations and improved functionality.</br> - These endpoints are currently in beta and - * might be subject to changes.</br> If you want to participate and learn more about the - * Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to - * CSM@fireblocks.com. + *

Legacy Endpoint – Update the draft and return its validation. **Note:** - This endpoint + * will remain available for the foreseeable future and is not deprecated. - The + * `updateDraft` endpoint under policy/paths provides policy type-specific operations + * and improved functionality. - These endpoints are currently in beta and might be subject to + * changes. If you want to participate and learn more about the Fireblocks TAP, please contact + * your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApiTest.java index b8f86013..3713b1dc 100644 --- a/src/test/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/PolicyEditorV2BetaApiTest.java @@ -51,8 +51,8 @@ public void getActivePolicyTest() throws ApiException { /** * Get the active draft by policy type * - *

Returns the active draft and its validation for a specific policy type. </br> - * **Note:** These endpoints are currently in beta and might be subject to changes. + *

Returns the active draft and its validation for a specific policy type. **Note:** These + * endpoints are currently in beta and might be subject to changes. * * @throws ApiException if the Api call fails */ @@ -66,10 +66,10 @@ public void getDraftTest() throws ApiException { /** * Send publish request for a certain draft id * - *

Send publish request of certain draft id and returns the response. </br> **Note:** - * These endpoints are currently in beta and might be subject to changes. If you want to - * participate and learn more about the Fireblocks Policy Editor, please contact your Fireblocks - * Customer Success Manager or send an email to CSM@fireblocks.com. + *

Send publish request of certain draft id and returns the response. **Note:** These + * endpoints are currently in beta and might be subject to changes. If you want to participate + * and learn more about the Fireblocks Policy Editor, please contact your Fireblocks Customer + * Success Manager or send an email to CSM@fireblocks.com. * * @throws ApiException if the Api call fails */ @@ -84,8 +84,8 @@ public void publishDraftTest() throws ApiException { /** * Update the draft with a new set of rules by policy types * - *

Update the draft and return its validation for specific policy types. </br> - * **Note:** These endpoints are currently in beta and might be subject to changes. + *

Update the draft and return its validation for specific policy types. **Note:** These + * endpoints are currently in beta and might be subject to changes. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/ResetDeviceApiTest.java b/src/test/java/com/fireblocks/sdk/api/ResetDeviceApiTest.java index f125b92d..4df59f08 100644 --- a/src/test/java/com/fireblocks/sdk/api/ResetDeviceApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/ResetDeviceApiTest.java @@ -30,7 +30,7 @@ public class ResetDeviceApiTest { * *

Resets mobile device for given console user, that user will need to do mobile onboarding * again. - Please note that this endpoint is available only for API keys with Admin/Non Signing - * Admin permissions. </br>Endpoint Permission: Admin, Non-Signing Admin. + * Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/SmartTransferApiTest.java b/src/test/java/com/fireblocks/sdk/api/SmartTransferApiTest.java index 32c40016..9d9842f1 100644 --- a/src/test/java/com/fireblocks/sdk/api/SmartTransferApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/SmartTransferApiTest.java @@ -66,8 +66,8 @@ public void approveDvPTicketTermTest() throws ApiException { /** * Cancel Ticket * - *

Cancel Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor. + *

Cancel Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -103,8 +103,8 @@ public void createTicketTest() throws ApiException { * *

Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about * Fireblocks Smart Transfers in the following - * [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -120,8 +120,8 @@ public void createTicketTermTest() throws ApiException { /** * Search Ticket by ID * - *

Find Smart Transfer ticket by id. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor, Viewer. + *

Find Smart Transfer ticket by id. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -135,8 +135,8 @@ public void findTicketByIdTest() throws ApiException { /** * Get Smart Transfer ticket term * - *

Find a specific term of a specific Smart Transfer ticket. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Find a specific term of a specific Smart Transfer ticket. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -151,8 +151,8 @@ public void findTicketTermByIdTest() throws ApiException { /** * Fund ticket manually * - *

Manually fulfill ticket, in case when all terms (legs) are funded manually. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Manually fulfill ticket, in case when all terms (legs) are funded manually. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -184,8 +184,7 @@ public void fundDvpTicketTest() throws ApiException { * Define funding source * *

Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer - * immediately). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * immediately). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -215,8 +214,8 @@ public void getSmartTransferStatisticTest() throws ApiException { /** * Get user group * - *

Get Smart Transfer user groups. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + *

Get Smart Transfer user groups. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -229,8 +228,8 @@ public void getSmartTransferUserGroupsTest() throws ApiException { /** * Manually add term transaction * - *

Manually set ticket term transaction. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + *

Manually set ticket term transaction. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -302,8 +301,8 @@ public void searchTicketsTest() throws ApiException { /** * Add external ref. ID * - *

Set external id Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + *

Set external id Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -319,8 +318,8 @@ public void setExternalRefIdTest() throws ApiException { /** * Set expiration * - *

Set expiration date on Smart Transfer ticket. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + *

Set expiration date on Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -337,7 +336,7 @@ public void setTicketExpirationTest() throws ApiException { * Set user group * *

Set Smart Transfers user group to receive email notifications for Smart Transfers. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -353,8 +352,8 @@ public void setUserGroupsTest() throws ApiException { * Submit ticket * *

Submit Smart Transfer ticket - change status into ready for approval if auto approval is - * not turned on, or OPEN if auto approval is on. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor. + * not turned on, or OPEN if auto approval is on. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/StakingApiTest.java b/src/test/java/com/fireblocks/sdk/api/StakingApiTest.java index 03140e17..0dd65de8 100644 --- a/src/test/java/com/fireblocks/sdk/api/StakingApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/StakingApiTest.java @@ -64,7 +64,7 @@ public void approveTermsOfServiceByProviderIdTest() throws ApiException { * Claim accrued rewards * *

Claims available staking rewards for the specified chain and vault. Supported chains: - * Solana and Polygon (Matic). Behavior depends on protocol reward distribution. + * Solana and Polygon (POL/Matic). Behavior depends on protocol reward distribution. * * @throws ApiException if the Api call fails */ @@ -83,11 +83,11 @@ public void claimRewardsTest() throws ApiException { * *

Consolidates the source staking position into the destination, merging the balance into * the destination and closing the source position once complete. Both positions must be from - * the same funding vaults account (i.e. same withdrawals credentials). On chain, this - * translates into a consolidation transaction, where the source validator is consolidated into - * the destination validator. Supported chains: Ethereum (ETH) only. </br>Endpoint - * Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. **Note:** This - * endpoint is currently in beta and might be subject to changes. + * the same vault account (i.e. same withdrawal credentials). On chain, this translates into a + * consolidation transaction, where the source validator is consolidated into the destination + * validator. Supported chains: Ethereum (ETH) only. Endpoint Permission: Owner, Admin, + * Non-Signing Admin, Signer, Approver, Editor. **Note:** This endpoint is currently in beta and + * might be subject to changes. * * @throws ApiException if the Api call fails */ @@ -104,7 +104,7 @@ public void consolidateTest() throws ApiException { * List staking positions * *

Returns all staking positions with core details: amounts, rewards, status, chain, and - * vault. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -135,7 +135,7 @@ public void getChainInfoTest() throws ApiException { * List supported staking chains * *

Returns an alphabetical list of blockchains supported for staking by the current workspace - * context. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * context. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -163,8 +163,8 @@ public void getDelegationByIdTest() throws ApiException { * *

Returns staking positions with core details: amounts, rewards, status, chain, and vault. * It supports cursor-based pagination for efficient data retrieval. This endpoint always - * returns a paginated response with {data, next} structure. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + * returns a paginated response with {data, next} structure. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -183,7 +183,7 @@ public void getPositionsTest() throws ApiException { * List staking providers * *

Returns all available staking providers with metadata such as name, ID, and supported - * chains. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -223,8 +223,8 @@ public void getSummaryByVaultTest() throws ApiException { * *

Merges the source stake account into the destination, consolidating the balance into the * destination and closing the source account once complete. Both accounts must be from the same - * validator provider and of same vault account.. Supported chains: Solana (SOL). - * </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. + * validator provider and of same vault account.. Supported chains: Solana (SOL). Endpoint + * Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -263,7 +263,8 @@ public void splitTest() throws ApiException { * validator: creates a new position regardless of existing delegations. For Cosmos chains and * Ethereum liquid staking (Lido): automatically add to existing positions for the same * validator provider and same vault account if one exists, otherwise create a new position. For - * Solana and Polygon: always create new positions regardless of existing delegations. + * Solana and Polygon (MATIC/POL): always create new positions regardless of existing + * delegations. * * @throws ApiException if the Api call fails */ @@ -298,7 +299,10 @@ public void unstakeTest() throws ApiException { * *

Withdraws funds that have completed the unbonding period. Typically requires the position * to be deactivated first (unstake → unbond → withdraw). Amount and timing vary by chain - * protocol. + * protocol. Partial withdrawal is supported for ETH compounding validators (EIP-7251/Pectra) + * and Cosmos chains via the optional 'amount' field. For ETH compounding validators, + * the remaining balance must be at least 32 ETH after the withdrawal. For all other chains, + * omitting 'amount' withdraws the entire available balance. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/TokenizationApiTest.java b/src/test/java/com/fireblocks/sdk/api/TokenizationApiTest.java index c459ca81..64881534 100644 --- a/src/test/java/com/fireblocks/sdk/api/TokenizationApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/TokenizationApiTest.java @@ -76,8 +76,8 @@ public void burnCollectionTokenTest() throws ApiException { /** * Create a new collection * - *

Create a new collection and link it as a token. </br>Endpoint Permission: Owner, - * Admin, Non-Signing Admin, Signer, and Editor. + *

Create a new collection and link it as a token. Endpoint Permission: Owner, Admin, + * Non-Signing Admin, Signer, and Editor. * * @throws ApiException if the Api call fails */ @@ -200,8 +200,8 @@ public void getLayerZeroPeersTest() throws ApiException { /** * Get collections * - *

Get collections (paginated). </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + *

Get collections (paginated). Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -263,8 +263,7 @@ public void getLinkedTokensCountTest() throws ApiException { * links the token to the workspace. For Stellar/Ripple, it links a newly created token directly * to the workspace without deploying a contract. Returns the token link with status * \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment - * is needed. </br>Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and - * Editor. + * is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/TrLinkApiTest.java b/src/test/java/com/fireblocks/sdk/api/TrLinkApiTest.java index 3658d403..2df8c52d 100644 --- a/src/test/java/com/fireblocks/sdk/api/TrLinkApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/TrLinkApiTest.java @@ -26,11 +26,15 @@ import com.fireblocks.sdk.model.TRLinkCreateTrmRequest; import com.fireblocks.sdk.model.TRLinkCustomerIntegrationResponse; import com.fireblocks.sdk.model.TRLinkCustomerResponse; +import com.fireblocks.sdk.model.TRLinkGetRequiredActionsResponse; import com.fireblocks.sdk.model.TRLinkGetSupportedAssetResponse; +import com.fireblocks.sdk.model.TRLinkManualDecisionRequest; +import com.fireblocks.sdk.model.TRLinkManualDecisionResponse; import com.fireblocks.sdk.model.TRLinkPartnerResponse; import com.fireblocks.sdk.model.TRLinkPolicyResponse; import com.fireblocks.sdk.model.TRLinkPublicKeyResponse; import com.fireblocks.sdk.model.TRLinkRedirectTrmRequest; +import com.fireblocks.sdk.model.TRLinkResolveActionRequest; import com.fireblocks.sdk.model.TRLinkSetDestinationTravelRuleMessageIdRequest; import com.fireblocks.sdk.model.TRLinkSetDestinationTravelRuleMessageIdResponse; import com.fireblocks.sdk.model.TRLinkSetTransactionTravelRuleMessageIdRequest; @@ -142,6 +146,25 @@ public void createTRLinkIntegrationTest() throws ApiException { api.createTRLinkIntegration(trLinkCreateIntegrationRequest, idempotencyKey); } + /** + * Manual decision for missing TRM + * + *

Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or + * policy timeout. + * + * @throws ApiException if the Api call fails + */ + @Test + public void createTRLinkManualDecisionTest() throws ApiException { + TRLinkManualDecisionRequest trLinkManualDecisionRequest = null; + UUID customerIntegrationId = null; + UUID txId = null; + String idempotencyKey = null; + CompletableFuture> response = + api.createTRLinkManualDecision( + trLinkManualDecisionRequest, customerIntegrationId, txId, idempotencyKey); + } + /** * Create Travel Rule Message * @@ -328,6 +351,22 @@ public void getTRLinkTrmByIdTest() throws ApiException { api.getTRLinkTrmById(customerIntegrationId, trmId); } + /** + * Get required actions for a TRM + * + *

Retrieves the list of required actions (e.g., PII fields) needed to process the Travel + * Rule Message. + * + * @throws ApiException if the Api call fails + */ + @Test + public void getTRLinkTrmRequiredActionsTest() throws ApiException { + UUID customerIntegrationId = null; + String trmId = null; + CompletableFuture> response = + api.getTRLinkTrmRequiredActions(customerIntegrationId, trmId); + } + /** * Get VASP by ID * @@ -398,6 +437,25 @@ public void redirectTRLinkTrmTest() throws ApiException { trLinkRedirectTrmRequest, customerIntegrationId, trmId, idempotencyKey); } + /** + * Resolve action for a TRM + * + *

Submits required data (e.g., beneficiary PII) to resolve a pending Travel Rule Message + * action. + * + * @throws ApiException if the Api call fails + */ + @Test + public void resolveActionTRLinkTrmTest() throws ApiException { + TRLinkResolveActionRequest trLinkResolveActionRequest = null; + UUID customerIntegrationId = null; + String trmId = null; + String idempotencyKey = null; + CompletableFuture> response = + api.resolveActionTRLinkTrm( + trLinkResolveActionRequest, customerIntegrationId, trmId, idempotencyKey); + } + /** * Set destination travel rule message ID * diff --git a/src/test/java/com/fireblocks/sdk/api/TransactionsApiTest.java b/src/test/java/com/fireblocks/sdk/api/TransactionsApiTest.java index 6755b6d1..56c756ee 100644 --- a/src/test/java/com/fireblocks/sdk/api/TransactionsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/TransactionsApiTest.java @@ -44,8 +44,8 @@ public class TransactionsApiTest { * Cancel a transaction * *

Cancels a transaction by Fireblocks Transaction ID. Can be used only for transactions that - * did not get to the BROADCASTING state. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor. + * did not get to the BROADCASTING state. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -82,7 +82,7 @@ public void createTransactionTest() throws ApiException { * Drop ETH (EVM) transaction by ID * *

Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -113,7 +113,7 @@ public void dropTransactionTest() throws ApiException { * the response will contain the transaction fee. - For other assets, the response will contain * the `networkFee` parameter. Learn more about Fireblocks Fee Management in the * following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -129,10 +129,11 @@ public void estimateNetworkFeeTest() throws ApiException { * *

Estimates the transaction fee for a specific transaction request. This endpoint simulates * a transaction which means that the system will expect to have the requested asset and balance - * in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). Learn - * more about Fireblocks Fee Management in the following - * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). - * </br>Endpoint Permission: Admin, Signer, Approver, Editor. + * in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The + * PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program + * calls is not available. Learn more about Fireblocks Fee Management in the following + * [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint + * Permission: Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -149,8 +150,8 @@ public void estimateTransactionFeeTest() throws ApiException { * *

Freezes a transaction by ID. Usually used for AML integrations when the incoming funds * should be quarantined. For account based assets - the entire amount of the transaction is - * frozen For UTXO based assets - all UTXOs of the specified transaction are frozen - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * frozen For UTXO based assets - all UTXOs of the specified transaction are frozen Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -166,8 +167,8 @@ public void freezeTransactionTest() throws ApiException { /** * Get a specific transaction by Fireblocks transaction ID * - *

Get a specific transaction data by Fireblocks Transaction ID </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Get a specific transaction data by Fireblocks Transaction ID Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -180,8 +181,8 @@ public void getTransactionTest() throws ApiException { /** * Get a specific transaction by external transaction ID * - *

Returns transaction by external transaction ID. </br>Endpoint Permission: Admin, - * Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Returns transaction by external transaction ID. Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -242,7 +243,7 @@ public void getTransactionsTest() throws ApiException { * Set confirmation threshold by transaction hash * *

Overrides the required number of confirmations for transaction completion by transaction - * hash. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * hash. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -260,8 +261,7 @@ public void setConfirmationThresholdByTransactionHashTest() throws ApiException * Set confirmation threshold by Fireblocks Transaction ID * *

Overrides the required number of confirmations for transaction completion Fireblocks - * Transaction ID. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, - * Editor. + * Transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -279,7 +279,7 @@ public void setTransactionConfirmationThresholdTest() throws ApiException { * Unfreeze a transaction * *

Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available - * again. </br>Endpoint Permission: Admin, Non-Signing Admin. + * again. Endpoint Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -295,7 +295,7 @@ public void unfreezeTransactionTest() throws ApiException { /** * Validate destination address * - *

Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). </br>Endpoint + *

Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). Endpoint * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails diff --git a/src/test/java/com/fireblocks/sdk/api/UserGroupsBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/UserGroupsBetaApiTest.java index f250906d..df705fd0 100644 --- a/src/test/java/com/fireblocks/sdk/api/UserGroupsBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/UserGroupsBetaApiTest.java @@ -34,8 +34,8 @@ public class UserGroupsBetaApiTest { /** * Create user group * - *

Create a new user group. Users with the Viewer role cannot be added to groups. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + *

Create a new user group. Users with the Viewer role cannot be added to groups. Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -50,9 +50,9 @@ public void createUserGroupTest() throws ApiException { /** * Delete user group * - *

Delete a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled - * for general availability at this time. - Please note that this endpoint is available only for - * API keys with Admin permissions. + *

Delete a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general + * availability at this time. - Please note that this endpoint is available only for API keys + * with Admin permissions. * * @throws ApiException if the Api call fails */ @@ -66,9 +66,9 @@ public void deleteUserGroupTest() throws ApiException { /** * Get user group * - *

Get a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled for - * general availability at this time. - Please note that this endpoint is available only for API - * keys with Admin permissions. + *

Get a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general + * availability at this time. - Please note that this endpoint is available only for API keys + * with Admin permissions. * * @throws ApiException if the Api call fails */ @@ -82,7 +82,7 @@ public void getUserGroupTest() throws ApiException { * List user groups * *

Get all user groups in your workspace - Please note that this endpoint is available only - * for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: Admin, + * for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, * Non-Signing Admin. * * @throws ApiException if the Api call fails @@ -95,9 +95,9 @@ public void getUserGroupsTest() throws ApiException { /** * Update user group * - *

Update a user group by ID.</br> **Note**: - This endpoint is now in Beta, disabled - * for general availability at this time. - Please note that this endpoint is available only for - * API keys with Admin permissions. + *

Update a user group by ID. **Note**: - This endpoint is now in Beta, disabled for general + * availability at this time. - Please note that this endpoint is available only for API keys + * with Admin permissions. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/UtxoManagementBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/UtxoManagementBetaApiTest.java index a016e21a..0e8bfe2a 100644 --- a/src/test/java/com/fireblocks/sdk/api/UtxoManagementBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/UtxoManagementBetaApiTest.java @@ -34,8 +34,8 @@ public class UtxoManagementBetaApiTest { * *

Returns a paginated list of unspent transaction outputs (UTXOs) for a UTXO-based asset in * a vault account, with optional filters for labels, statuses, amounts, and more. **Note:** - * These endpoints are currently in beta and might be subject to changes. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * These endpoints are currently in beta and might be subject to changes. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -82,8 +82,7 @@ public void getUtxosTest() throws ApiException { * organizing and filtering UTXOs. Labels are applied additively — `labelsToAttach` * adds to the existing label set and `labelsToDetach` removes from it. Neither * operation replaces the full set. **Note:** These endpoints are currently in beta and might be - * subject to changes. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, - * Approver, Editor. + * subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/VaultsApiTest.java b/src/test/java/com/fireblocks/sdk/api/VaultsApiTest.java index 36ab20d7..74a97a14 100644 --- a/src/test/java/com/fireblocks/sdk/api/VaultsApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/VaultsApiTest.java @@ -15,6 +15,8 @@ import com.fireblocks.sdk.ApiException; import com.fireblocks.sdk.ApiResponse; +import com.fireblocks.sdk.model.CircleGatewayWalletInfoResponse; +import com.fireblocks.sdk.model.CircleGatewayWalletStatusResponse; import com.fireblocks.sdk.model.CreateAddressRequest; import com.fireblocks.sdk.model.CreateAddressResponse; import com.fireblocks.sdk.model.CreateAssetsRequest; @@ -60,8 +62,8 @@ public class VaultsApiTest { * Activate a wallet in a vault account * *

Initiates activation for a wallet in a vault account. Activation is required for tokens - * that need an on-chain transaction for creation (XLM tokens, SOL tokens etc). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * that need an on-chain transaction for creation (XLM tokens, SOL tokens etc). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -76,6 +78,24 @@ public void activateAssetForVaultAccountTest() throws ApiException { vaultAccountId, assetId, idempotencyKey, blockchainWalletType); } + /** + * Activate a Circle Gateway wallet + * + *

Activates the Circle Gateway wallet associated with the given vault account. If the wallet + * does not yet exist it is created in an activated state. **Note:** This endpoint is currently + * in beta and might be subject to changes. </br>Endpoint Permission: Admin, Non-Signing + * Admin, Signer, Approver. + * + * @throws ApiException if the Api call fails + */ + @Test + public void activateCircleGatewayWalletBetaTest() throws ApiException { + String vaultAccountId = null; + String idempotencyKey = null; + CompletableFuture> response = + api.activateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey); + } + /** * Attach or detach tags from vault accounts * @@ -98,8 +118,8 @@ public void attachOrDetachTagsFromVaultAccountsTest() throws ApiException { /** * Convert a segwit address to legacy format * - *

Converts an existing segwit address to the legacy format. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -156,8 +176,8 @@ public void createMultipleDepositAddressesTest() throws ApiException { * *

Creates a new vault account with the requested name. **Note: ** Vault account names should * consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following - * [guide](https://developers.fireblocks.com/reference/create-vault-account). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -174,7 +194,7 @@ public void createVaultAccountTest() throws ApiException { * *

Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks * Vault Wallets in the following - * [guide](https://developers.fireblocks.com/reference/create-vault-wallet). </br>Endpoint + * [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails @@ -199,7 +219,7 @@ public void createVaultAccountAssetTest() throws ApiException { * Create new asset deposit address * *

Creates a new deposit address for an asset of a vault account. Should be used for UTXO or - * Tag/Memo based assets ONLY. Requests with account based assets will fail. </br>Endpoint + * Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails @@ -215,12 +235,29 @@ public void createVaultAccountAssetAddressTest() throws ApiException { vaultAccountId, assetId, createAddressRequest, idempotencyKey); } + /** + * Deactivate a Circle Gateway wallet + * + *

Deactivates the Circle Gateway wallet associated with the given vault account. **Note:** + * This endpoint is currently in beta and might be subject to changes. </br>Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver. + * + * @throws ApiException if the Api call fails + */ + @Test + public void deactivateCircleGatewayWalletBetaTest() throws ApiException { + String vaultAccountId = null; + String idempotencyKey = null; + CompletableFuture> response = + api.deactivateCircleGatewayWalletBeta(vaultAccountId, idempotencyKey); + } + /** * Get vault wallets (Paginated) * *

Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset - * in a vault account. This method allows fast traversal of all account balances. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * in a vault account. This method allows fast traversal of all account balances. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -236,6 +273,22 @@ public void getAssetWalletsTest() throws ApiException { api.getAssetWallets(totalAmountLargerThan, assetId, orderBy, before, after, limit); } + /** + * Get Circle Gateway wallet info + * + *

Returns the Circle Gateway wallet information associated with the given vault account. + * **Note:** This endpoint is currently in beta and might be subject to changes. + * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * + * @throws ApiException if the Api call fails + */ + @Test + public void getCircleGatewayWalletInfoBetaTest() throws ApiException { + String vaultAccountId = null; + CompletableFuture> response = + api.getCircleGatewayWalletInfoBeta(vaultAccountId); + } + /** * Get the job status of the bulk deposit address creation * @@ -305,8 +358,8 @@ public void getMaxSpendableAmountTest() throws ApiException { * Get vault accounts (Paginated) * *

Gets all vault accounts in your workspace. This endpoint returns a limited amount of - * results with a quick response time. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor, Viewer. + * results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -341,8 +394,8 @@ public void getPagedVaultAccountsTest() throws ApiException { /** * Get the public key for a derivation path * - *

Gets the public key information based on derivation path and signing algorithm. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + *

Gets the public key information based on derivation path and signing algorithm. Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -358,8 +411,8 @@ public void getPublicKeyInfoTest() throws ApiException { /** * Get an asset's public key * - *

Get the public key information for a specific asset in a vault account. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + *

Get the public key information for a specific asset in a vault account. Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -378,8 +431,8 @@ public void getPublicKeyInfoForAddressTest() throws ApiException { /** * Get UTXO unspent inputs information * - *

Returns unspent inputs information of an UTXO asset in a vault account. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Returns unspent inputs information of an UTXO asset in a vault account. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -394,8 +447,8 @@ public void getUnspentInputsTest() throws ApiException { /** * Get a vault account by ID * - *

Get a vault account by its unique ID. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver, Editor, Viewer. + *

Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -408,8 +461,8 @@ public void getVaultAccountTest() throws ApiException { /** * Get the asset balance for a vault account * - *

Returns a specific vault wallet balance information for a specific asset. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Returns a specific vault wallet balance information for a specific asset. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -425,7 +478,7 @@ public void getVaultAccountAssetTest() throws ApiException { * Get addresses (Paginated) * *

Returns a paginated response of the addresses for a given vault account and asset. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + * Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -444,8 +497,8 @@ public void getVaultAccountAssetAddressesPaginatedTest() throws ApiException { /** * Get asset balance for chosen assets * - *

Gets the assets amount summary for all accounts or filtered accounts. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -460,8 +513,8 @@ public void getVaultAssetsTest() throws ApiException { /** * Get vault balance by an asset * - *

Get the total balance of an asset across all the vault accounts. </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. + *

Get the total balance of an asset across all the vault accounts. Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * * @throws ApiException if the Api call fails */ @@ -479,8 +532,8 @@ public void getVaultBalanceByAssetTest() throws ApiException { * web console to be swamped with too much vault accounts. Learn more in the following * [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). * NOTE: Hiding the vault account from the web console will also hide all the related - * transactions to/from this vault. </br>Endpoint Permission: Admin, Non-Signing Admin, - * Signer, Approver, Editor. + * transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, + * Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -495,8 +548,8 @@ public void hideVaultAccountTest() throws ApiException { /** * Assign AML customer reference ID * - *

Sets an AML/KYT customer reference ID for a specific address. </br>Endpoint - * Permission: Admin, Non-Signing Admin. + *

Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, + * Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -522,8 +575,8 @@ public void setCustomerRefIdForAddressTest() throws ApiException { *

Toggles the auto fueling property of the vault account to enabled or disabled. Vault * Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks * Gas Station. Learn more about the Fireblocks Gas Station in the following - * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). </br>Endpoint - * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: + * Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -541,8 +594,8 @@ public void setVaultAccountAutoFuelTest() throws ApiException { * *

Assigns an AML/KYT customer reference ID for the vault account. Learn more about * Fireblocks AML management in the following - * [guide](https://developers.fireblocks.com/docs/define-aml-policies). </br>Endpoint - * Permission: Admin, Non-Signing Admin. + * [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: + * Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ @@ -559,8 +612,8 @@ public void setVaultAccountCustomerRefIdTest() throws ApiException { /** * Unhide a vault account in the console * - *

Makes a hidden vault account visible in web console view. </br>Endpoint Permission: - * Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, + * Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -575,8 +628,8 @@ public void unhideVaultAccountTest() throws ApiException { /** * Rename a vault account * - *

Renames the requested vault account. </br>Endpoint Permission: Admin, Non-Signing - * Admin, Signer, Approver. + *

Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, + * Signer, Approver. * * @throws ApiException if the Api call fails */ @@ -592,8 +645,8 @@ public void updateVaultAccountTest() throws ApiException { /** * Update address description * - *

Updates the description of an existing address of an asset in a vault account. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + *

Updates the description of an existing address of an asset in a vault account. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ @@ -617,8 +670,8 @@ public void updateVaultAccountAssetAddressTest() throws ApiException { * Refresh asset balance data * *

Updates the balance of a specific asset in a vault account. This API endpoint is subject - * to a strict rate limit. Should be used by clients in very specific scenarios. - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/WebhooksApiTest.java b/src/test/java/com/fireblocks/sdk/api/WebhooksApiTest.java index cb27d325..6379f1b7 100644 --- a/src/test/java/com/fireblocks/sdk/api/WebhooksApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/WebhooksApiTest.java @@ -52,8 +52,8 @@ public void resendTransactionWebhooksTest() throws ApiException { * Resend failed webhooks * *

Resends all failed webhook notifications. Learn more about Fireblocks Webhooks in the - * following [guide](https://developers.fireblocks.com/docs/configure-webhooks). - * </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * following [guide](https://developers.fireblocks.com/docs/configure-webhooks). Endpoint + * Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/WhitelistIpAddressesApiTest.java b/src/test/java/com/fireblocks/sdk/api/WhitelistIpAddressesApiTest.java index 2d041ff8..f1598fa0 100644 --- a/src/test/java/com/fireblocks/sdk/api/WhitelistIpAddressesApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/WhitelistIpAddressesApiTest.java @@ -30,8 +30,8 @@ public class WhitelistIpAddressesApiTest { * Get whitelisted ip addresses for an API Key * *

Get a list of the whitelisted IP addresses for a specific API Key - Please note that this - * endpoint is available only for API keys with Admin/Non Signing Admin permissions. - * </br>Endpoint Permission: Admin, Non-Signing Admin. + * endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint + * Permission: Admin, Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApiTest.java b/src/test/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApiTest.java index 3cca8e20..d4f983d8 100644 --- a/src/test/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApiTest.java +++ b/src/test/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApiTest.java @@ -31,8 +31,8 @@ public class WorkspaceStatusBetaApiTest { * *

Returns current workspace status (Beta). **Note**: - This endpoint is now in Beta, * disabled for general availability at this time. - Please note that this endpoint is available - * only for API keys with Admin/Non Signing Admin permissions. </br>Endpoint Permission: - * Admin, Non-Signing Admin. + * only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, + * Non-Signing Admin. * * @throws ApiException if the Api call fails */ diff --git a/src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfoTest.java b/src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfoTest.java index 01394b49..7091a9b2 100644 --- a/src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfoTest.java +++ b/src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfoTest.java @@ -290,6 +290,12 @@ void providerTest() { // TODO: test provider } + /** Test the property 'email' */ + @Test + void emailTest() { + // TODO: test email + } + /** Test the property 'beneficiaryDocumentId' */ @Test void beneficiaryDocumentIdTest() { diff --git a/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponseTest.java b/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponseTest.java new file mode 100644 index 00000000..d9f51c14 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletInfoResponseTest.java @@ -0,0 +1,57 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for CircleGatewayWalletInfoResponse */ +class CircleGatewayWalletInfoResponseTest { + private final CircleGatewayWalletInfoResponse model = new CircleGatewayWalletInfoResponse(); + + /** Model tests for CircleGatewayWalletInfoResponse */ + @Test + void testCircleGatewayWalletInfoResponse() { + // TODO: test CircleGatewayWalletInfoResponse + } + + /** Test the property 'walletId' */ + @Test + void walletIdTest() { + // TODO: test walletId + } + + /** Test the property 'type' */ + @Test + void typeTest() { + // TODO: test type + } + + /** Test the property 'status' */ + @Test + void statusTest() { + // TODO: test status + } + + /** Test the property 'symbol' */ + @Test + void symbolTest() { + // TODO: test symbol + } + + /** Test the property 'assetIds' */ + @Test + void assetIdsTest() { + // TODO: test assetIds + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponseTest.java b/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponseTest.java new file mode 100644 index 00000000..140d69f8 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/CircleGatewayWalletStatusResponseTest.java @@ -0,0 +1,39 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for CircleGatewayWalletStatusResponse */ +class CircleGatewayWalletStatusResponseTest { + private final CircleGatewayWalletStatusResponse model = new CircleGatewayWalletStatusResponse(); + + /** Model tests for CircleGatewayWalletStatusResponse */ + @Test + void testCircleGatewayWalletStatusResponse() { + // TODO: test CircleGatewayWalletStatusResponse + } + + /** Test the property 'walletId' */ + @Test + void walletIdTest() { + // TODO: test walletId + } + + /** Test the property 'status' */ + @Test + void statusTest() { + // TODO: test status + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupTest.java b/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupTest.java new file mode 100644 index 00000000..168d0e3b --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupTest.java @@ -0,0 +1,69 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for CounterpartyGroup */ +class CounterpartyGroupTest { + private final CounterpartyGroup model = new CounterpartyGroup(); + + /** Model tests for CounterpartyGroup */ + @Test + void testCounterpartyGroup() { + // TODO: test CounterpartyGroup + } + + /** Test the property 'groupId' */ + @Test + void groupIdTest() { + // TODO: test groupId + } + + /** Test the property 'name' */ + @Test + void nameTest() { + // TODO: test name + } + + /** Test the property 'description' */ + @Test + void descriptionTest() { + // TODO: test description + } + + /** Test the property 'jurisdictionCodes' */ + @Test + void jurisdictionCodesTest() { + // TODO: test jurisdictionCodes + } + + /** Test the property 'isActive' */ + @Test + void isActiveTest() { + // TODO: test isActive + } + + /** Test the property 'createdAt' */ + @Test + void createdAtTest() { + // TODO: test createdAt + } + + /** Test the property 'updatedAt' */ + @Test + void updatedAtTest() { + // TODO: test updatedAt + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponseTest.java b/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponseTest.java new file mode 100644 index 00000000..0dbf91eb --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/CounterpartyGroupsPaginatedResponseTest.java @@ -0,0 +1,46 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for CounterpartyGroupsPaginatedResponse */ +class CounterpartyGroupsPaginatedResponseTest { + private final CounterpartyGroupsPaginatedResponse model = + new CounterpartyGroupsPaginatedResponse(); + + /** Model tests for CounterpartyGroupsPaginatedResponse */ + @Test + void testCounterpartyGroupsPaginatedResponse() { + // TODO: test CounterpartyGroupsPaginatedResponse + } + + /** Test the property 'data' */ + @Test + void dataTest() { + // TODO: test data + } + + /** Test the property 'total' */ + @Test + void totalTest() { + // TODO: test total + } + + /** Test the property 'next' */ + @Test + void nextTest() { + // TODO: test next + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequestTest.java b/src/test/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequestTest.java new file mode 100644 index 00000000..febf4c26 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/CreateCounterpartyGroupRequestTest.java @@ -0,0 +1,45 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for CreateCounterpartyGroupRequest */ +class CreateCounterpartyGroupRequestTest { + private final CreateCounterpartyGroupRequest model = new CreateCounterpartyGroupRequest(); + + /** Model tests for CreateCounterpartyGroupRequest */ + @Test + void testCreateCounterpartyGroupRequest() { + // TODO: test CreateCounterpartyGroupRequest + } + + /** Test the property 'name' */ + @Test + void nameTest() { + // TODO: test name + } + + /** Test the property 'jurisdictionCodes' */ + @Test + void jurisdictionCodesTest() { + // TODO: test jurisdictionCodes + } + + /** Test the property 'description' */ + @Test + void descriptionTest() { + // TODO: test description + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatusTest.java b/src/test/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatusTest.java index 52083f71..f0a2eb15 100644 --- a/src/test/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatusTest.java +++ b/src/test/java/com/fireblocks/sdk/model/CreateMultipleVaultAccountsJobStatusTest.java @@ -38,9 +38,21 @@ void vaultAccountsTest() { // TODO: test vaultAccounts } + /** Test the property 'tagIds' */ + @Test + void tagIdsTest() { + // TODO: test tagIds + } + /** Test the property 'errorMessage' */ @Test void errorMessageTest() { // TODO: test errorMessage } + + /** Test the property 'approvalRequestId' */ + @Test + void approvalRequestIdTest() { + // TODO: test approvalRequestId + } } diff --git a/src/test/java/com/fireblocks/sdk/model/CreateQuoteTest.java b/src/test/java/com/fireblocks/sdk/model/CreateQuoteTest.java index c1177ff1..8515a726 100644 --- a/src/test/java/com/fireblocks/sdk/model/CreateQuoteTest.java +++ b/src/test/java/com/fireblocks/sdk/model/CreateQuoteTest.java @@ -78,4 +78,10 @@ void settlementTest() { void sideTest() { // TODO: test side } + + /** Test the property 'participantsIdentification' */ + @Test + void participantsIdentificationTest() { + // TODO: test participantsIdentification + } } diff --git a/src/test/java/com/fireblocks/sdk/model/MomoPaymentInfoTest.java b/src/test/java/com/fireblocks/sdk/model/MomoPaymentInfoTest.java index a0e9c5cd..da18a869 100644 --- a/src/test/java/com/fireblocks/sdk/model/MomoPaymentInfoTest.java +++ b/src/test/java/com/fireblocks/sdk/model/MomoPaymentInfoTest.java @@ -67,6 +67,12 @@ void providerTest() { // TODO: test provider } + /** Test the property 'email' */ + @Test + void emailTest() { + // TODO: test email + } + /** Test the property 'beneficiaryDocumentId' */ @Test void beneficiaryDocumentIdTest() { diff --git a/src/test/java/com/fireblocks/sdk/model/QuotePropertiesDetailsTest.java b/src/test/java/com/fireblocks/sdk/model/QuotePropertiesDetailsTest.java index f6307572..42c0b231 100644 --- a/src/test/java/com/fireblocks/sdk/model/QuotePropertiesDetailsTest.java +++ b/src/test/java/com/fireblocks/sdk/model/QuotePropertiesDetailsTest.java @@ -96,4 +96,10 @@ void sideTest() { void expiresAtTest() { // TODO: test expiresAt } + + /** Test the property 'orderCreationRequirements' */ + @Test + void orderCreationRequirementsTest() { + // TODO: test orderCreationRequirements + } } diff --git a/src/test/java/com/fireblocks/sdk/model/QuoteTest.java b/src/test/java/com/fireblocks/sdk/model/QuoteTest.java index b047a3af..dc9a2e35 100644 --- a/src/test/java/com/fireblocks/sdk/model/QuoteTest.java +++ b/src/test/java/com/fireblocks/sdk/model/QuoteTest.java @@ -97,6 +97,12 @@ void expiresAtTest() { // TODO: test expiresAt } + /** Test the property 'orderCreationRequirements' */ + @Test + void orderCreationRequirementsTest() { + // TODO: test orderCreationRequirements + } + /** Test the property 'type' */ @Test void typeTest() { diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPiiTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPiiTest.java new file mode 100644 index 00000000..f41d2d76 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkBeneficiaryPiiTest.java @@ -0,0 +1,33 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkBeneficiaryPii */ +class TRLinkBeneficiaryPiiTest { + private final TRLinkBeneficiaryPii model = new TRLinkBeneficiaryPii(); + + /** Model tests for TRLinkBeneficiaryPii */ + @Test + void testTRLinkBeneficiaryPii() { + // TODO: test TRLinkBeneficiaryPii + } + + /** Test the property 'ivms101' */ + @Test + void ivms101Test() { + // TODO: test ivms101 + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponseTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponseTest.java new file mode 100644 index 00000000..84c9ff72 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkGetRequiredActionsResponseTest.java @@ -0,0 +1,33 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkGetRequiredActionsResponse */ +class TRLinkGetRequiredActionsResponseTest { + private final TRLinkGetRequiredActionsResponse model = new TRLinkGetRequiredActionsResponse(); + + /** Model tests for TRLinkGetRequiredActionsResponse */ + @Test + void testTRLinkGetRequiredActionsResponse() { + // TODO: test TRLinkGetRequiredActionsResponse + } + + /** Test the property 'actions' */ + @Test + void actionsTest() { + // TODO: test actions + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionActionTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionActionTest.java new file mode 100644 index 00000000..bfc2cb3e --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionActionTest.java @@ -0,0 +1,25 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkManualDecisionAction */ +class TRLinkManualDecisionActionTest { + /** Model tests for TRLinkManualDecisionAction */ + @Test + void testTRLinkManualDecisionAction() { + // TODO: test TRLinkManualDecisionAction + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetailTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetailTest.java new file mode 100644 index 00000000..01d229be --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionDestinationDetailTest.java @@ -0,0 +1,46 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkManualDecisionDestinationDetail */ +class TRLinkManualDecisionDestinationDetailTest { + private final TRLinkManualDecisionDestinationDetail model = + new TRLinkManualDecisionDestinationDetail(); + + /** Model tests for TRLinkManualDecisionDestinationDetail */ + @Test + void testTRLinkManualDecisionDestinationDetail() { + // TODO: test TRLinkManualDecisionDestinationDetail + } + + /** Test the property 'destinationScreeningId' */ + @Test + void destinationScreeningIdTest() { + // TODO: test destinationScreeningId + } + + /** Test the property 'applied' */ + @Test + void appliedTest() { + // TODO: test applied + } + + /** Test the property 'skipReason' */ + @Test + void skipReasonTest() { + // TODO: test skipReason + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequestTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequestTest.java new file mode 100644 index 00000000..bf244627 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionRequestTest.java @@ -0,0 +1,39 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkManualDecisionRequest */ +class TRLinkManualDecisionRequestTest { + private final TRLinkManualDecisionRequest model = new TRLinkManualDecisionRequest(); + + /** Model tests for TRLinkManualDecisionRequest */ + @Test + void testTRLinkManualDecisionRequest() { + // TODO: test TRLinkManualDecisionRequest + } + + /** Test the property 'action' */ + @Test + void actionTest() { + // TODO: test action + } + + /** Test the property 'reason' */ + @Test + void reasonTest() { + // TODO: test reason + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponseTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponseTest.java new file mode 100644 index 00000000..8e4a4ae8 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionResponseTest.java @@ -0,0 +1,63 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkManualDecisionResponse */ +class TRLinkManualDecisionResponseTest { + private final TRLinkManualDecisionResponse model = new TRLinkManualDecisionResponse(); + + /** Model tests for TRLinkManualDecisionResponse */ + @Test + void testTRLinkManualDecisionResponse() { + // TODO: test TRLinkManualDecisionResponse + } + + /** Test the property 'action' */ + @Test + void actionTest() { + // TODO: test action + } + + /** Test the property 'source' */ + @Test + void sourceTest() { + // TODO: test source + } + + /** Test the property 'txId' */ + @Test + void txIdTest() { + // TODO: test txId + } + + /** Test the property 'destinationsAffected' */ + @Test + void destinationsAffectedTest() { + // TODO: test destinationsAffected + } + + /** Test the property 'destinationsSkipped' */ + @Test + void destinationsSkippedTest() { + // TODO: test destinationsSkipped + } + + /** Test the property 'details' */ + @Test + void detailsTest() { + // TODO: test details + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionSourceTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionSourceTest.java new file mode 100644 index 00000000..55e68faa --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkManualDecisionSourceTest.java @@ -0,0 +1,25 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkManualDecisionSource */ +class TRLinkManualDecisionSourceTest { + /** Model tests for TRLinkManualDecisionSource */ + @Test + void testTRLinkManualDecisionSource() { + // TODO: test TRLinkManualDecisionSource + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionDataTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionDataTest.java new file mode 100644 index 00000000..9849831f --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionDataTest.java @@ -0,0 +1,39 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkRequiredActionData */ +class TRLinkRequiredActionDataTest { + private final TRLinkRequiredActionData model = new TRLinkRequiredActionData(); + + /** Model tests for TRLinkRequiredActionData */ + @Test + void testTRLinkRequiredActionData() { + // TODO: test TRLinkRequiredActionData + } + + /** Test the property 'beneficiaryRequiredFields' */ + @Test + void beneficiaryRequiredFieldsTest() { + // TODO: test beneficiaryRequiredFields + } + + /** Test the property 'originatorRequiredFields' */ + @Test + void originatorRequiredFieldsTest() { + // TODO: test originatorRequiredFields + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionTest.java new file mode 100644 index 00000000..a68ee0f2 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredActionTest.java @@ -0,0 +1,45 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkRequiredAction */ +class TRLinkRequiredActionTest { + private final TRLinkRequiredAction model = new TRLinkRequiredAction(); + + /** Model tests for TRLinkRequiredAction */ + @Test + void testTRLinkRequiredAction() { + // TODO: test TRLinkRequiredAction + } + + /** Test the property 'type' */ + @Test + void typeTest() { + // TODO: test type + } + + /** Test the property 'description' */ + @Test + void descriptionTest() { + // TODO: test description + } + + /** Test the property 'data' */ + @Test + void dataTest() { + // TODO: test data + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredFieldTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredFieldTest.java new file mode 100644 index 00000000..1154bba9 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkRequiredFieldTest.java @@ -0,0 +1,39 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkRequiredField */ +class TRLinkRequiredFieldTest { + private final TRLinkRequiredField model = new TRLinkRequiredField(); + + /** Model tests for TRLinkRequiredField */ + @Test + void testTRLinkRequiredField() { + // TODO: test TRLinkRequiredField + } + + /** Test the property 'type' */ + @Test + void typeTest() { + // TODO: test type + } + + /** Test the property 'path' */ + @Test + void pathTest() { + // TODO: test path + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionDataTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionDataTest.java new file mode 100644 index 00000000..177f9a02 --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionDataTest.java @@ -0,0 +1,33 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkResolveActionData */ +class TRLinkResolveActionDataTest { + private final TRLinkResolveActionData model = new TRLinkResolveActionData(); + + /** Model tests for TRLinkResolveActionData */ + @Test + void testTRLinkResolveActionData() { + // TODO: test TRLinkResolveActionData + } + + /** Test the property 'beneficiaryPii' */ + @Test + void beneficiaryPiiTest() { + // TODO: test beneficiaryPii + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionRequestTest.java b/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionRequestTest.java new file mode 100644 index 00000000..0be3c12d --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/TRLinkResolveActionRequestTest.java @@ -0,0 +1,39 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for TRLinkResolveActionRequest */ +class TRLinkResolveActionRequestTest { + private final TRLinkResolveActionRequest model = new TRLinkResolveActionRequest(); + + /** Model tests for TRLinkResolveActionRequest */ + @Test + void testTRLinkResolveActionRequest() { + // TODO: test TRLinkResolveActionRequest + } + + /** Test the property 'type' */ + @Test + void typeTest() { + // TODO: test type + } + + /** Test the property 'data' */ + @Test + void dataTest() { + // TODO: test data + } +} diff --git a/src/test/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequestTest.java b/src/test/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequestTest.java new file mode 100644 index 00000000..b78286ac --- /dev/null +++ b/src/test/java/com/fireblocks/sdk/model/UpdateCounterpartyGroupRequestTest.java @@ -0,0 +1,51 @@ +/* + * Fireblocks API + * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: developers@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.fireblocks.sdk.model; + + +import org.junit.jupiter.api.Test; + +/** Model tests for UpdateCounterpartyGroupRequest */ +class UpdateCounterpartyGroupRequestTest { + private final UpdateCounterpartyGroupRequest model = new UpdateCounterpartyGroupRequest(); + + /** Model tests for UpdateCounterpartyGroupRequest */ + @Test + void testUpdateCounterpartyGroupRequest() { + // TODO: test UpdateCounterpartyGroupRequest + } + + /** Test the property 'name' */ + @Test + void nameTest() { + // TODO: test name + } + + /** Test the property 'description' */ + @Test + void descriptionTest() { + // TODO: test description + } + + /** Test the property 'jurisdictionCodes' */ + @Test + void jurisdictionCodesTest() { + // TODO: test jurisdictionCodes + } + + /** Test the property 'isActive' */ + @Test + void isActiveTest() { + // TODO: test isActive + } +}