diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 693800b..59d385c 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -71,9 +71,6 @@ AddressReverseLookupResponse.md AddressesFilters.md AlertExposureTypeEnum.md AlertLevelEnum.md -AllocationResponse.md -AllocationResponseAccept.md -AllocationResponseReject.md AllocationWithdrawPayload.md AllowListPayload.md AllowlistEntry.md @@ -206,7 +203,6 @@ CantonCallEndInvestorInvite.md CantonCallEndInvestorInviteCancel.md CantonCallEndInvestorOffboard.md CantonCallParticipantOnboarding.md -CantonCallTransferWithdraw.md CantonDetails.md CantonDomainEnum.md CantonOfferResponseDetails.md @@ -359,6 +355,8 @@ CreateReportResponse.md CreateSigningKeyDto.md CreateSigningKeyDtoProofOfOwnership.md CreateTagRequest.md +CreateTempoTransferRequest.md +CreateTempoTransferResponse.md CreateTokenRequestDto.md CreateTokenRequestDtoCreateParams.md CreateTransactionResponse.md @@ -383,6 +381,7 @@ DefaultNetworkRoutingDest.md Delegation.md DelegationBlockchainPositionInfo.md DelegationSummary.md +DeleteApprovalApiKeyResponse.md DeleteNetworkConnectionResponse.md DeleteNetworkIdResponse.md DeleteWebhookMtlsConfigResponse.md @@ -427,6 +426,7 @@ DraftResponse.md DraftReviewAndValidationResponse.md DropTransactionRequest.md DropTransactionResponse.md +DtccOnboardingRejectPayload.md DvnConfig.md DvnConfigWithConfirmations.md EVMTokenCreateParamsDto.md @@ -731,15 +731,16 @@ OffExchangesApi.md Offer.md OfferResponse.md OfferResponseAccepted.md -OfferResponseAllocation.md -OfferResponseOnboarding.md -OfferResponseTransfer.md +OfferResponseAllocationAccept.md +OfferResponseAllocationReject.md +OfferResponseDtccOnboardingAccept.md +OfferResponseDtccOnboardingReject.md +OfferResponseTradewebAccept.md +OfferResponseTradewebReject.md +OfferResponseTransferAccept.md +OfferResponseTransferReject.md +OfferResponseTransferWithdraw.md OffersResponse.md -OnboardingResponse.md -OnboardingResponseDtccAccept.md -OnboardingResponseDtccReject.md -OnboardingResponseTradewebAccept.md -OnboardingResponseTradewebReject.md OnchainDataApi.md OnchainTransaction.md OnchainTransactionsPagedResponse.md @@ -1188,6 +1189,10 @@ TagType.md TagsApi.md TagsPagedResponse.md TemplatesPaginatedResponse.md +TempoBetaApi.md +TempoTransferDestination.md +TempoTransferDestinationItem.md +TempoTransferSource.md ThirdPartyRouting.md TimeBasedTrigger.md TimeInForce.md @@ -1256,11 +1261,7 @@ TransferPeerTypeEnum.md TransferPeerTypeEnum2.md TransferRail.md TransferReceipt.md -TransferResponse.md -TransferResponseAccept.md -TransferResponseReject.md TransferValidationFailure.md -TransferWithdrawPayload.md TravelRuleActionEnum.md TravelRuleAddress.md TravelRuleApi.md @@ -1478,6 +1479,7 @@ api/security-posture-management-api.ts api/smart-transfer-api.ts api/staking-api.ts api/tags-api.ts +api/tempo-beta-api.ts api/tokenization-api.ts api/trading-beta-api.ts api/transactions-api.ts @@ -1569,9 +1571,6 @@ models/address-reverse-lookup-response.ts models/addresses-filters.ts models/alert-exposure-type-enum.ts models/alert-level-enum.ts -models/allocation-response-accept.ts -models/allocation-response-reject.ts -models/allocation-response.ts models/allocation-withdraw-payload.ts models/allow-list-payload.ts models/allowlist-entry-provider-metadata.ts @@ -1700,7 +1699,6 @@ models/canton-call-end-investor-invite-cancel.ts models/canton-call-end-investor-invite.ts models/canton-call-end-investor-offboard.ts models/canton-call-participant-onboarding.ts -models/canton-call-transfer-withdraw.ts models/canton-call.ts models/canton-details.ts models/canton-domain-enum.ts @@ -1844,6 +1842,8 @@ models/create-report-response.ts models/create-signing-key-dto-proof-of-ownership.ts models/create-signing-key-dto.ts models/create-tag-request.ts +models/create-tempo-transfer-request.ts +models/create-tempo-transfer-response.ts models/create-token-request-dto-create-params.ts models/create-token-request-dto.ts models/create-transaction-response.ts @@ -1866,6 +1866,7 @@ models/default-network-routing-dest.ts models/delegation-blockchain-position-info.ts models/delegation-summary.ts models/delegation.ts +models/delete-approval-api-key-response.ts models/delete-network-connection-response.ts models/delete-network-id-response.ts models/delete-webhook-mtls-config-response.ts @@ -1909,6 +1910,7 @@ models/draft-response.ts models/draft-review-and-validation-response.ts models/drop-transaction-request.ts models/drop-transaction-response.ts +models/dtcc-onboarding-reject-payload.ts models/dvn-config-with-confirmations.ts models/dvn-config.ts models/dvpsettlement-type.ts @@ -2199,17 +2201,18 @@ models/notification-status.ts models/notification-with-data.ts models/notification.ts models/offer-response-accepted.ts -models/offer-response-allocation.ts -models/offer-response-onboarding.ts -models/offer-response-transfer.ts +models/offer-response-allocation-accept.ts +models/offer-response-allocation-reject.ts +models/offer-response-dtcc-onboarding-accept.ts +models/offer-response-dtcc-onboarding-reject.ts +models/offer-response-tradeweb-accept.ts +models/offer-response-tradeweb-reject.ts +models/offer-response-transfer-accept.ts +models/offer-response-transfer-reject.ts +models/offer-response-transfer-withdraw.ts models/offer-response.ts models/offer.ts models/offers-response.ts -models/onboarding-response-dtcc-accept.ts -models/onboarding-response-dtcc-reject.ts -models/onboarding-response-tradeweb-accept.ts -models/onboarding-response-tradeweb-reject.ts -models/onboarding-response.ts models/onchain-transaction.ts models/onchain-transactions-paged-response.ts models/onchain-transactions-paged-response2.ts @@ -2552,6 +2555,9 @@ models/tag-type.ts models/tag.ts models/tags-paged-response.ts models/templates-paginated-response.ts +models/tempo-transfer-destination-item.ts +models/tempo-transfer-destination.ts +models/tempo-transfer-source.ts models/third-party-routing.ts models/time-based-trigger.ts models/time-in-force.ts @@ -2617,11 +2623,7 @@ models/transfer-peer-type-enum.ts models/transfer-peer-type-enum2.ts models/transfer-rail.ts models/transfer-receipt.ts -models/transfer-response-accept.ts -models/transfer-response-reject.ts -models/transfer-response.ts models/transfer-validation-failure.ts -models/transfer-withdraw-payload.ts models/travel-rule-action-enum.ts models/travel-rule-address.ts models/travel-rule-create-transaction-request.ts diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 955a231..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,258 +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). - -## [v33.0.0](https://github.com/fireblocks/ts-sdk/compare/v19.0.0...v33.0.0) - 2026-09-30 - -### Merged - -- Generated SDK #2897331076 [`#211`](https://github.com/fireblocks/ts-sdk/pull/211) - -## [v19.0.0](https://github.com/fireblocks/ts-sdk/compare/v18.0.0...v19.0.0) - 2026-05-17 - -### Merged - -- Generated SDK #7742 (major) [`#183`](https://github.com/fireblocks/ts-sdk/pull/183) - -## [v18.0.0](https://github.com/fireblocks/ts-sdk/compare/v17.0.0...v18.0.0) - 2026-05-06 - -### Merged - -- Generated SDK #3222 [`#181`](https://github.com/fireblocks/ts-sdk/pull/181) - -## [v17.0.0](https://github.com/fireblocks/ts-sdk/compare/v16.0.0...v17.0.0) - 2026-04-20 - -### Merged - -- Generated SDK #9605 (major) [`#180`](https://github.com/fireblocks/ts-sdk/pull/180) - -## [v16.0.0](https://github.com/fireblocks/ts-sdk/compare/v15.0.0...v16.0.0) - 2026-04-06 - -### Merged - -- Generated SDK #3331 [`#179`](https://github.com/fireblocks/ts-sdk/pull/179) - -## [v15.0.0](https://github.com/fireblocks/ts-sdk/compare/v14.1.0...v15.0.0) - 2026-03-15 - -### Merged - -- Generated SDK #3733 (major) [`#174`](https://github.com/fireblocks/ts-sdk/pull/174) - -## [v14.1.0](https://github.com/fireblocks/ts-sdk/compare/v14.0.0...v14.1.0) - 2026-02-26 - -### Merged - -- Generated SDK #2167 [`#172`](https://github.com/fireblocks/ts-sdk/pull/172) - -## [v14.0.0](https://github.com/fireblocks/ts-sdk/compare/v13.0.0...v14.0.0) - 2026-02-03 - -### Merged - -- Generated SDK #4746 [`#164`](https://github.com/fireblocks/ts-sdk/pull/164) - -## [v13.0.0](https://github.com/fireblocks/ts-sdk/compare/v12.1.2...v13.0.0) - 2025-11-13 - -### Merged - -- Generated SDK #5834 [`#146`](https://github.com/fireblocks/ts-sdk/pull/146) - -## [v12.1.2](https://github.com/fireblocks/ts-sdk/compare/v12.1.1...v12.1.2) - 2025-10-22 - -### Merged - -- Generated SDK #8293 [`#145`](https://github.com/fireblocks/ts-sdk/pull/145) - -## [v12.1.1](https://github.com/fireblocks/ts-sdk/compare/v12.1.0...v12.1.1) - 2025-09-29 - -### Merged - -- Generated SDK #6061 [`#143`](https://github.com/fireblocks/ts-sdk/pull/143) - -## [v12.1.0](https://github.com/fireblocks/ts-sdk/compare/v12.0.0...v12.1.0) - 2025-09-09 - -### Merged - -- Generated SDK #4521 [`#142`](https://github.com/fireblocks/ts-sdk/pull/142) - -## [v12.0.0](https://github.com/fireblocks/ts-sdk/compare/v11.2.0...v12.0.0) - 2025-09-01 - -### Merged - -- Generated SDK #7741 [`#141`](https://github.com/fireblocks/ts-sdk/pull/141) - -## [v11.2.0](https://github.com/fireblocks/ts-sdk/compare/v11.1.0...v11.2.0) - 2025-08-18 - -### Merged - -- Generated SDK #3302 [`#140`](https://github.com/fireblocks/ts-sdk/pull/140) - -## [v11.1.0](https://github.com/fireblocks/ts-sdk/compare/v11.0.0...v11.1.0) - 2025-08-11 - -### Merged - -- Generated SDK #1782 [`#139`](https://github.com/fireblocks/ts-sdk/pull/139) - -## [v11.0.0](https://github.com/fireblocks/ts-sdk/compare/v10.4.0...v11.0.0) - 2025-07-15 - -### Merged - -- Generated SDK #5610 [`#136`](https://github.com/fireblocks/ts-sdk/pull/136) - -## [v10.4.0](https://github.com/fireblocks/ts-sdk/compare/v10.3.0...v10.4.0) - 2025-06-29 - -### Merged - -- Generated SDK #1492 [`#135`](https://github.com/fireblocks/ts-sdk/pull/135) - -## [v10.3.0](https://github.com/fireblocks/ts-sdk/compare/v10.2.0...v10.3.0) - 2025-06-18 - -### Merged - -- Generated SDK #4009 [`#134`](https://github.com/fireblocks/ts-sdk/pull/134) - -## [v10.2.0](https://github.com/fireblocks/ts-sdk/compare/v10.1.1...v10.2.0) - 2025-06-04 - -### Merged - -- Generated SDK #8912 [`#133`](https://github.com/fireblocks/ts-sdk/pull/133) - -## [v10.1.1](https://github.com/fireblocks/ts-sdk/compare/v10.1.0...v10.1.1) - 2025-05-18 - -### Merged - -- Generated SDK #5019 [`#132`](https://github.com/fireblocks/ts-sdk/pull/132) - -## [v10.1.0](https://github.com/fireblocks/ts-sdk/compare/v10.0.2...v10.1.0) - 2025-05-07 - -### Merged - -- Generated SDK #7076 [`#130`](https://github.com/fireblocks/ts-sdk/pull/130) - -## [v10.0.2](https://github.com/fireblocks/ts-sdk/compare/v10.0.1...v10.0.2) - 2025-04-20 - -### Merged - -- Generated SDK #4794 [`#128`](https://github.com/fireblocks/ts-sdk/pull/128) - -## [v10.0.1](https://github.com/fireblocks/ts-sdk/compare/v10.0.0...v10.0.1) - 2025-04-07 - -### Merged - -- Generated SDK #3065 [`#126`](https://github.com/fireblocks/ts-sdk/pull/126) - -## [v10.0.0](https://github.com/fireblocks/ts-sdk/compare/v9.0.0...v10.0.0) - 2025-03-27 - -### Merged - -- Generated SDK #619 [`#124`](https://github.com/fireblocks/ts-sdk/pull/124) - -## [v9.0.0](https://github.com/fireblocks/ts-sdk/compare/v8.1.0...v9.0.0) - 2025-03-17 - -### Merged - -- Generated SDK #645 [`#123`](https://github.com/fireblocks/ts-sdk/pull/123) - -## [v8.1.0](https://github.com/fireblocks/ts-sdk/compare/v8.0.1...v8.1.0) - 2025-02-24 - -### Merged - -- Generated SDK #9833 [`#120`](https://github.com/fireblocks/ts-sdk/pull/120) - -## [v8.0.1](https://github.com/fireblocks/ts-sdk/compare/v8.0.0...v8.0.1) - 2025-02-12 - -### Merged - -- Generated SDK #4262 [`#119`](https://github.com/fireblocks/ts-sdk/pull/119) - -## [v8.0.0](https://github.com/fireblocks/ts-sdk/compare/v7.0.0...v8.0.0) - 2025-02-02 - -### Merged - -- Generated SDK #538 [`#118`](https://github.com/fireblocks/ts-sdk/pull/118) - -## [v7.0.0](https://github.com/fireblocks/ts-sdk/compare/v6.0.0...v7.0.0) - 2025-01-08 - -### Merged - -- Generated SDK #8699 [`#116`](https://github.com/fireblocks/ts-sdk/pull/116) - -## [v6.0.0](https://github.com/fireblocks/ts-sdk/compare/v5.0.0...v6.0.0) - 2024-12-05 - -### Merged - -- Generated SDK #1430 [`#111`](https://github.com/fireblocks/ts-sdk/pull/111) - -## [v5.0.0](https://github.com/fireblocks/ts-sdk/compare/v4.0.0...v5.0.0) - 2024-10-31 - -### Merged - -- Generated SDK #5184 [`#109`](https://github.com/fireblocks/ts-sdk/pull/109) - -## [v4.0.0](https://github.com/fireblocks/ts-sdk/compare/v3.1.0...v4.0.0) - 2024-09-17 - -### Merged - -- Generated SDK #237 [`#107`](https://github.com/fireblocks/ts-sdk/pull/107) - -## [v3.1.0](https://github.com/fireblocks/ts-sdk/compare/v3.0.0...v3.1.0) - 2024-07-25 - -### Merged - -- Generated SDK #6749 [`#102`](https://github.com/fireblocks/ts-sdk/pull/102) - -## [v3.0.0](https://github.com/fireblocks/ts-sdk/compare/v2.1.0...v3.0.0) - 2024-07-17 - -### Merged - -- Generated SDK #6152 [`#90`](https://github.com/fireblocks/ts-sdk/pull/90) -- Generated SDK #2589 [`#86`](https://github.com/fireblocks/ts-sdk/pull/86) -- Generated SDK #7882 [`#85`](https://github.com/fireblocks/ts-sdk/pull/85) -- Generated SDK #8418 [`#84`](https://github.com/fireblocks/ts-sdk/pull/84) -- Generated SDK #3524 [`#83`](https://github.com/fireblocks/ts-sdk/pull/83) -- Generated SDK #7984 [`#82`](https://github.com/fireblocks/ts-sdk/pull/82) -- Generated SDK #2873 [`#81`](https://github.com/fireblocks/ts-sdk/pull/81) - -## [v2.1.0](https://github.com/fireblocks/ts-sdk/compare/v2.0.0...v2.1.0) - 2024-06-04 - -### Merged - -- Generated SDK for version COR-46191/fix_pipelines [`#44`](https://github.com/fireblocks/ts-sdk/pull/44) - -## [v2.0.0](https://github.com/fireblocks/ts-sdk/compare/v1.1.0...v2.0.0) - 2024-05-08 - -### Merged - -- feat: add tokenization api [`#35`](https://github.com/fireblocks/ts-sdk/pull/35) - -## [v1.1.0](https://github.com/fireblocks/ts-sdk/compare/v1.0.1...v1.1.0) - 2024-04-17 - -### Merged - -- feat: adding consigners beta api [`#34`](https://github.com/fireblocks/ts-sdk/pull/34) -- fix: modify error message when secretKey missing and fix readme doc [`#33`](https://github.com/fireblocks/ts-sdk/pull/33) - -## [v1.0.1](https://github.com/fireblocks/ts-sdk/compare/v1.0.0...v1.0.1) - 2024-04-07 - -### Merged - -- Generated SDK for version v1.0.1 [`#32`](https://github.com/fireblocks/ts-sdk/pull/32) - -## v1.0.0 - 2024-04-07 - -### Merged - -- Generated SDK for version v1.0.0 GA [`#31`](https://github.com/fireblocks/ts-sdk/pull/31) -- add_license [`#30`](https://github.com/fireblocks/ts-sdk/pull/30) -- version_3_0_6_beta [`#29`](https://github.com/fireblocks/ts-sdk/pull/29) -- version_3_0_5_beta [`#27`](https://github.com/fireblocks/ts-sdk/pull/27) -- Version 3.0.4-beta [`#26`](https://github.com/fireblocks/ts-sdk/pull/26) -- Fireblocks api spec/generated/9818 [`#25`](https://github.com/fireblocks/ts-sdk/pull/25) -- Generated SDK for version 9817 [`#24`](https://github.com/fireblocks/ts-sdk/pull/24) -- Generated SDK for version master [`#23`](https://github.com/fireblocks/ts-sdk/pull/23) -- Added Idempotency & NCW headers support [`#22`](https://github.com/fireblocks/ts-sdk/pull/22) -- API SDK Improvments [`#21`](https://github.com/fireblocks/ts-sdk/pull/21) -- Update README.md [`#18`](https://github.com/fireblocks/ts-sdk/pull/18) -- Update README.md [`#17`](https://github.com/fireblocks/ts-sdk/pull/17) diff --git a/README.md b/README.md index ed772e2..c927e66 100644 --- a/README.md +++ b/README.md @@ -459,6 +459,7 @@ Class | Method | HTTP request | Description *TagsApi* | [**getTag**](docs/apis/TagsApi.md#getTag) | **GET** /tags/{tagId} | Get a tag *TagsApi* | [**getTags**](docs/apis/TagsApi.md#getTags) | **GET** /tags | Get list of tags *TagsApi* | [**updateTag**](docs/apis/TagsApi.md#updateTag) | **PATCH** /tags/{tagId} | Update a tag +*TempoBetaApi* | [**createTempoTransfer**](docs/apis/TempoBetaApi.md#createTempoTransfer) | **POST** /operations/tempo/transfer | Create a Tempo transfer transaction *TokenizationApi* | [**burnCollectionToken**](docs/apis/TokenizationApi.md#burnCollectionToken) | **POST** /tokenization/collections/{id}/tokens/burn | Burn tokens *TokenizationApi* | [**createNewCollection**](docs/apis/TokenizationApi.md#createNewCollection) | **POST** /tokenization/collections | Create a new collection *TokenizationApi* | [**deactivateAndUnlinkAdapters**](docs/apis/TokenizationApi.md#deactivateAndUnlinkAdapters) | **DELETE** /tokenization/multichain/bridge/layerzero | Remove LayerZero adapters @@ -566,6 +567,7 @@ Class | Method | HTTP request | Description *VaultsApi* | [**getVaultBalanceByAsset**](docs/apis/VaultsApi.md#getVaultBalanceByAsset) | **GET** /vault/assets/{assetId} | Get vault balance by an asset *VaultsApi* | [**hideVaultAccount**](docs/apis/VaultsApi.md#hideVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/hide | Hide a vault account in the console *VaultsApi* | [**lookupVaultByAddress**](docs/apis/VaultsApi.md#lookupVaultByAddress) | **GET** /vault/lookup_by_address | Look up a vault account by blockchain address +*VaultsApi* | [**registerTempoOmnibusWallet**](docs/apis/VaultsApi.md#registerTempoOmnibusWallet) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/omnibus/tempo/register | Register a Tempo omnibus wallet *VaultsApi* | [**setCustomerRefIdForAddress**](docs/apis/VaultsApi.md#setCustomerRefIdForAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id | Assign AML customer reference ID *VaultsApi* | [**setUsdcGatewayDepositAutomationBeta**](docs/apis/VaultsApi.md#setUsdcGatewayDepositAutomationBeta) | **POST** /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation | Set up a USDC Gateway deposit automation for a vault account *VaultsApi* | [**setVaultAccountAutoFuel**](docs/apis/VaultsApi.md#setVaultAccountAutoFuel) | **POST** /vault/accounts/{vaultAccountId}/set_auto_fuel | Set auto fueling to on or off @@ -684,9 +686,6 @@ Class | Method | HTTP request | Description - [AddressesFilters](docs/models/AddressesFilters.md) - [AlertExposureTypeEnum](docs/models/AlertExposureTypeEnum.md) - [AlertLevelEnum](docs/models/AlertLevelEnum.md) - - [AllocationResponse](docs/models/AllocationResponse.md) - - [AllocationResponseAccept](docs/models/AllocationResponseAccept.md) - - [AllocationResponseReject](docs/models/AllocationResponseReject.md) - [AllocationWithdrawPayload](docs/models/AllocationWithdrawPayload.md) - [AllowListPayload](docs/models/AllowListPayload.md) - [AllowlistEntry](docs/models/AllowlistEntry.md) @@ -814,7 +813,6 @@ Class | Method | HTTP request | Description - [CantonCallEndInvestorInviteCancel](docs/models/CantonCallEndInvestorInviteCancel.md) - [CantonCallEndInvestorOffboard](docs/models/CantonCallEndInvestorOffboard.md) - [CantonCallParticipantOnboarding](docs/models/CantonCallParticipantOnboarding.md) - - [CantonCallTransferWithdraw](docs/models/CantonCallTransferWithdraw.md) - [CantonDetails](docs/models/CantonDetails.md) - [CantonDomainEnum](docs/models/CantonDomainEnum.md) - [CantonOfferResponseDetails](docs/models/CantonOfferResponseDetails.md) @@ -957,6 +955,8 @@ Class | Method | HTTP request | Description - [CreateSigningKeyDto](docs/models/CreateSigningKeyDto.md) - [CreateSigningKeyDtoProofOfOwnership](docs/models/CreateSigningKeyDtoProofOfOwnership.md) - [CreateTagRequest](docs/models/CreateTagRequest.md) + - [CreateTempoTransferRequest](docs/models/CreateTempoTransferRequest.md) + - [CreateTempoTransferResponse](docs/models/CreateTempoTransferResponse.md) - [CreateTokenRequestDto](docs/models/CreateTokenRequestDto.md) - [CreateTokenRequestDtoCreateParams](docs/models/CreateTokenRequestDtoCreateParams.md) - [CreateTransactionResponse](docs/models/CreateTransactionResponse.md) @@ -981,6 +981,7 @@ Class | Method | HTTP request | Description - [Delegation](docs/models/Delegation.md) - [DelegationBlockchainPositionInfo](docs/models/DelegationBlockchainPositionInfo.md) - [DelegationSummary](docs/models/DelegationSummary.md) + - [DeleteApprovalApiKeyResponse](docs/models/DeleteApprovalApiKeyResponse.md) - [DeleteNetworkConnectionResponse](docs/models/DeleteNetworkConnectionResponse.md) - [DeleteNetworkIdResponse](docs/models/DeleteNetworkIdResponse.md) - [DeleteWebhookMtlsConfigResponse](docs/models/DeleteWebhookMtlsConfigResponse.md) @@ -1024,6 +1025,7 @@ Class | Method | HTTP request | Description - [DraftReviewAndValidationResponse](docs/models/DraftReviewAndValidationResponse.md) - [DropTransactionRequest](docs/models/DropTransactionRequest.md) - [DropTransactionResponse](docs/models/DropTransactionResponse.md) + - [DtccOnboardingRejectPayload](docs/models/DtccOnboardingRejectPayload.md) - [DvnConfig](docs/models/DvnConfig.md) - [DvnConfigWithConfirmations](docs/models/DvnConfigWithConfirmations.md) - [EVMTokenCreateParamsDto](docs/models/EVMTokenCreateParamsDto.md) @@ -1313,15 +1315,16 @@ Class | Method | HTTP request | Description - [Offer](docs/models/Offer.md) - [OfferResponse](docs/models/OfferResponse.md) - [OfferResponseAccepted](docs/models/OfferResponseAccepted.md) - - [OfferResponseAllocation](docs/models/OfferResponseAllocation.md) - - [OfferResponseOnboarding](docs/models/OfferResponseOnboarding.md) - - [OfferResponseTransfer](docs/models/OfferResponseTransfer.md) + - [OfferResponseAllocationAccept](docs/models/OfferResponseAllocationAccept.md) + - [OfferResponseAllocationReject](docs/models/OfferResponseAllocationReject.md) + - [OfferResponseDtccOnboardingAccept](docs/models/OfferResponseDtccOnboardingAccept.md) + - [OfferResponseDtccOnboardingReject](docs/models/OfferResponseDtccOnboardingReject.md) + - [OfferResponseTradewebAccept](docs/models/OfferResponseTradewebAccept.md) + - [OfferResponseTradewebReject](docs/models/OfferResponseTradewebReject.md) + - [OfferResponseTransferAccept](docs/models/OfferResponseTransferAccept.md) + - [OfferResponseTransferReject](docs/models/OfferResponseTransferReject.md) + - [OfferResponseTransferWithdraw](docs/models/OfferResponseTransferWithdraw.md) - [OffersResponse](docs/models/OffersResponse.md) - - [OnboardingResponse](docs/models/OnboardingResponse.md) - - [OnboardingResponseDtccAccept](docs/models/OnboardingResponseDtccAccept.md) - - [OnboardingResponseDtccReject](docs/models/OnboardingResponseDtccReject.md) - - [OnboardingResponseTradewebAccept](docs/models/OnboardingResponseTradewebAccept.md) - - [OnboardingResponseTradewebReject](docs/models/OnboardingResponseTradewebReject.md) - [OnchainTransaction](docs/models/OnchainTransaction.md) - [OnchainTransactionsPagedResponse](docs/models/OnchainTransactionsPagedResponse.md) - [OnchainTransactionsPagedResponse2](docs/models/OnchainTransactionsPagedResponse2.md) @@ -1757,6 +1760,9 @@ Class | Method | HTTP request | Description - [TagType](docs/models/TagType.md) - [TagsPagedResponse](docs/models/TagsPagedResponse.md) - [TemplatesPaginatedResponse](docs/models/TemplatesPaginatedResponse.md) + - [TempoTransferDestination](docs/models/TempoTransferDestination.md) + - [TempoTransferDestinationItem](docs/models/TempoTransferDestinationItem.md) + - [TempoTransferSource](docs/models/TempoTransferSource.md) - [ThirdPartyRouting](docs/models/ThirdPartyRouting.md) - [TimeBasedTrigger](docs/models/TimeBasedTrigger.md) - [TimeInForce](docs/models/TimeInForce.md) @@ -1822,11 +1828,7 @@ Class | Method | HTTP request | Description - [TransferPeerTypeEnum2](docs/models/TransferPeerTypeEnum2.md) - [TransferRail](docs/models/TransferRail.md) - [TransferReceipt](docs/models/TransferReceipt.md) - - [TransferResponse](docs/models/TransferResponse.md) - - [TransferResponseAccept](docs/models/TransferResponseAccept.md) - - [TransferResponseReject](docs/models/TransferResponseReject.md) - [TransferValidationFailure](docs/models/TransferValidationFailure.md) - - [TransferWithdrawPayload](docs/models/TransferWithdrawPayload.md) - [TravelRuleActionEnum](docs/models/TravelRuleActionEnum.md) - [TravelRuleAddress](docs/models/TravelRuleAddress.md) - [TravelRuleCreateTransactionRequest](docs/models/TravelRuleCreateTransactionRequest.md) diff --git a/api.ts b/api.ts index 43b0624..433d00a 100644 --- a/api.ts +++ b/api.ts @@ -56,6 +56,7 @@ export * from './api/smart-transfer-api'; export * from './api/staking-api'; export * from './api/trlink-api'; export * from './api/tags-api'; +export * from './api/tempo-beta-api'; export * from './api/tokenization-api'; export * from './api/trading-beta-api'; export * from './api/transactions-api'; diff --git a/api/approvals-beta-api.ts b/api/approvals-beta-api.ts index aff8d57..3b0ef35 100644 --- a/api/approvals-beta-api.ts +++ b/api/approvals-beta-api.ts @@ -31,6 +31,8 @@ import { ApprovalRequestItem } from '../models'; // @ts-ignore import { ApproveApprovalRequest } from '../models'; // @ts-ignore +import { DeleteApprovalApiKeyResponse } from '../models'; +// @ts-ignore import { ErrorSchema } from '../models'; // @ts-ignore import { ListApprovalApiKeysResponse } from '../models'; @@ -90,7 +92,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Registration may require approval. In that case the response carries `ccrIdPendingRegistration`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` and cannot sign until the request is approved. A rejected request removes the key. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Register an approval key * @param {RegisterApprovalApiKeyRequest} registerApprovalApiKeyRequest * @param {string} userId The ID of the API user to register the approval key for. @@ -133,7 +135,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user\'s ability to sign approvals. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user\'s last key or another user\'s key. In that case the response carries `ccrIdPendingDeletion`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_DELETION` and stays active until the request is approved. A rejected request leaves the key enabled. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Delete an approval key * @param {string} userId The ID of the API user whose approval key to delete. * @param {string} keyId The ID of the approval key to delete. @@ -383,7 +385,7 @@ export const ApprovalsBetaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Registration may require approval. In that case the response carries `ccrIdPendingRegistration`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` and cannot sign until the request is approved. A rejected request removes the key. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Register an approval key * @param {RegisterApprovalApiKeyRequest} registerApprovalApiKeyRequest * @param {string} userId The ID of the API user to register the approval key for. @@ -398,7 +400,7 @@ export const ApprovalsBetaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user\'s ability to sign approvals. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user\'s last key or another user\'s key. In that case the response carries `ccrIdPendingDeletion`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_DELETION` and stays active until the request is approved. A rejected request leaves the key enabled. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Delete an approval key * @param {string} userId The ID of the API user whose approval key to delete. * @param {string} keyId The ID of the approval key to delete. @@ -406,7 +408,7 @@ export const ApprovalsBetaApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteApprovalKey(userId: string, keyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async deleteApprovalKey(userId: string, keyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApprovalKey(userId, keyId, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['ApprovalsBetaApi.deleteApprovalKey']?.[index]?.url; @@ -495,7 +497,7 @@ export const ApprovalsBetaApiFactory = function (configuration?: Configuration, return localVarFp.approveApproval(requestParameters.approveApprovalRequest, requestParameters.requestId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Registration may require approval. In that case the response carries `ccrIdPendingRegistration`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` and cannot sign until the request is approved. A rejected request removes the key. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Register an approval key * @param {ApprovalsBetaApiCreateApprovalKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -505,13 +507,13 @@ export const ApprovalsBetaApiFactory = function (configuration?: Configuration, return localVarFp.createApprovalKey(requestParameters.registerApprovalApiKeyRequest, requestParameters.userId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user\'s ability to sign approvals. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user\'s last key or another user\'s key. In that case the response carries `ccrIdPendingDeletion`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_DELETION` and stays active until the request is approved. A rejected request leaves the key enabled. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Delete an approval key * @param {ApprovalsBetaApiDeleteApprovalKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteApprovalKey(requestParameters: ApprovalsBetaApiDeleteApprovalKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + deleteApprovalKey(requestParameters: ApprovalsBetaApiDeleteApprovalKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteApprovalKey(requestParameters.userId, requestParameters.keyId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** @@ -787,7 +789,7 @@ export class ApprovalsBetaApi extends BaseAPI { } /** - * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Registration may require approval. In that case the response carries `ccrIdPendingRegistration`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` and cannot sign until the request is approved. A rejected request removes the key. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Register an approval key * @param {ApprovalsBetaApiCreateApprovalKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -799,7 +801,7 @@ export class ApprovalsBetaApi extends BaseAPI { } /** - * Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user\'s ability to sign approvals. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. + * Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user\'s last key or another user\'s key. In that case the response carries `ccrIdPendingDeletion`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_DELETION` and stays active until the request is approved. A rejected request leaves the key enabled. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. * @summary Delete an approval key * @param {ApprovalsBetaApiDeleteApprovalKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/api/console-user-api.ts b/api/console-user-api.ts index 0254da9..ddc55f8 100644 --- a/api/console-user-api.ts +++ b/api/console-user-api.ts @@ -82,7 +82,7 @@ export const ConsoleUserApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Request deletion of a console user * @param {string} id The ID of the console user to delete * @param {boolean} [force] Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console. @@ -174,7 +174,7 @@ export const ConsoleUserApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Request deletion of a console user * @param {string} id The ID of the console user to delete * @param {boolean} [force] Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console. @@ -220,7 +220,7 @@ export const ConsoleUserApiFactory = function (configuration?: Configuration, ba return localVarFp.createConsoleUser(requestParameters.createConsoleUser, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Request deletion of a console user * @param {ConsoleUserApiDeleteConsoleUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -303,7 +303,7 @@ export class ConsoleUserApi extends BaseAPI { } /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Request deletion of a console user * @param {ConsoleUserApiDeleteConsoleUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/api/tempo-beta-api.ts b/api/tempo-beta-api.ts new file mode 100644 index 0000000..13e2281 --- /dev/null +++ b/api/tempo-beta-api.ts @@ -0,0 +1,168 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +import { convertToFireblocksResponse } from "../response/fireblocksResponse"; +// URLSearchParams not necessarily used +// @ts-ignore +import { URL, URLSearchParams } from 'url'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +import { assertParamExistsAndNotEmpty } from '../utils/validation_utils'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +// @ts-ignore +import { CreateTempoTransferRequest } from '../models'; +// @ts-ignore +import { CreateTempoTransferResponse } from '../models'; +// @ts-ignore +import { ErrorSchema } from '../models'; +/** + * TempoBetaApi - axios parameter creator + * @export + */ +export const TempoBetaApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new Tempo transfer transaction. + * @summary Create a Tempo transfer transaction + * @param {CreateTempoTransferRequest} createTempoTransferRequest + * @param {string} [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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createTempoTransfer: async (createTempoTransferRequest: CreateTempoTransferRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('createTempoTransfer', 'createTempoTransferRequest', createTempoTransferRequest) + const localVarPath = `/operations/tempo/transfer`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (idempotencyKey != null) { + localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createTempoTransferRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TempoBetaApi - functional programming interface + * @export + */ +export const TempoBetaApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TempoBetaApiAxiosParamCreator(configuration) + return { + /** + * Creates a new Tempo transfer transaction. + * @summary Create a Tempo transfer transaction + * @param {CreateTempoTransferRequest} createTempoTransferRequest + * @param {string} [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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createTempoTransfer(createTempoTransferRequest: CreateTempoTransferRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createTempoTransfer(createTempoTransferRequest, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TempoBetaApi.createTempoTransfer']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + } +}; + +/** + * TempoBetaApi - factory interface + * @export + */ +export const TempoBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TempoBetaApiFp(configuration) + return { + /** + * Creates a new Tempo transfer transaction. + * @summary Create a Tempo transfer transaction + * @param {TempoBetaApiCreateTempoTransferRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createTempoTransfer(requestParameters: TempoBetaApiCreateTempoTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createTempoTransfer(requestParameters.createTempoTransferRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createTempoTransfer operation in TempoBetaApi. + * @export + * @interface TempoBetaApiCreateTempoTransferRequest + */ +export interface TempoBetaApiCreateTempoTransferRequest { + /** + * + * @type {CreateTempoTransferRequest} + * @memberof TempoBetaApiCreateTempoTransfer + */ + readonly createTempoTransferRequest: CreateTempoTransferRequest + + /** + * 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. + * @type {string} + * @memberof TempoBetaApiCreateTempoTransfer + */ + readonly idempotencyKey?: string +} + +/** + * TempoBetaApi - object-oriented interface + * @export + * @class TempoBetaApi + * @extends {BaseAPI} + */ +export class TempoBetaApi extends BaseAPI { + /** + * Creates a new Tempo transfer transaction. + * @summary Create a Tempo transfer transaction + * @param {TempoBetaApiCreateTempoTransferRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TempoBetaApi + */ + public createTempoTransfer(requestParameters: TempoBetaApiCreateTempoTransferRequest) { + return TempoBetaApiFp(this.configuration).createTempoTransfer(requestParameters.createTempoTransferRequest, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } +} + diff --git a/api/vaults-api.ts b/api/vaults-api.ts index 260c44f..390e317 100644 --- a/api/vaults-api.ts +++ b/api/vaults-api.ts @@ -1337,6 +1337,47 @@ export const VaultsApiAxiosParamCreator = function (configuration?: Configuratio + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Registers a Tempo omnibus wallet for the requested vault account. Triggering this flow requires the vault account to hold PATH_USD with a balance sufficient to cover the gas fee. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * @summary Register a Tempo omnibus wallet + * @param {string} vaultAccountId The ID of the vault account for which to register the Tempo wallet. + * @param {string} assetId The Tempo network asset to register for the vault account. + * @param {string} [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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerTempoOmnibusWallet: async (vaultAccountId: string, assetId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('registerTempoOmnibusWallet', 'vaultAccountId', vaultAccountId) + assertParamExistsAndNotEmpty('registerTempoOmnibusWallet', 'assetId', assetId) + const localVarPath = `/vault/accounts/{vaultAccountId}/{assetId}/omnibus/tempo/register` + .replace(`{${"vaultAccountId"}}`, encodeURIComponent(String(vaultAccountId))) + .replace(`{${"assetId"}}`, encodeURIComponent(String(assetId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (idempotencyKey != null) { + localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2185,6 +2226,21 @@ export const VaultsApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['VaultsApi.lookupVaultByAddress']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Registers a Tempo omnibus wallet for the requested vault account. Triggering this flow requires the vault account to hold PATH_USD with a balance sufficient to cover the gas fee. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * @summary Register a Tempo omnibus wallet + * @param {string} vaultAccountId The ID of the vault account for which to register the Tempo wallet. + * @param {string} assetId The Tempo network asset to register for the vault account. + * @param {string} [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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async registerTempoOmnibusWallet(vaultAccountId: string, assetId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.registerTempoOmnibusWallet(vaultAccountId, assetId, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['VaultsApi.registerTempoOmnibusWallet']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID @@ -2624,6 +2680,16 @@ export const VaultsApiFactory = function (configuration?: Configuration, basePat lookupVaultByAddress(requestParameters: VaultsApiLookupVaultByAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.lookupVaultByAddress(requestParameters.address, options).then((request) => request(axios, basePath)); }, + /** + * Registers a Tempo omnibus wallet for the requested vault account. Triggering this flow requires the vault account to hold PATH_USD with a balance sufficient to cover the gas fee. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * @summary Register a Tempo omnibus wallet + * @param {VaultsApiRegisterTempoOmnibusWalletRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerTempoOmnibusWallet(requestParameters: VaultsApiRegisterTempoOmnibusWalletRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.registerTempoOmnibusWallet(requestParameters.vaultAccountId, requestParameters.assetId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID @@ -3529,6 +3595,34 @@ export interface VaultsApiLookupVaultByAddressRequest { readonly address: string } +/** + * Request parameters for registerTempoOmnibusWallet operation in VaultsApi. + * @export + * @interface VaultsApiRegisterTempoOmnibusWalletRequest + */ +export interface VaultsApiRegisterTempoOmnibusWalletRequest { + /** + * The ID of the vault account for which to register the Tempo wallet. + * @type {string} + * @memberof VaultsApiRegisterTempoOmnibusWallet + */ + readonly vaultAccountId: string + + /** + * The Tempo network asset to register for the vault account. + * @type {string} + * @memberof VaultsApiRegisterTempoOmnibusWallet + */ + readonly assetId: 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. + * @type {string} + * @memberof VaultsApiRegisterTempoOmnibusWallet + */ + readonly idempotencyKey?: string +} + /** * Request parameters for setCustomerRefIdForAddress operation in VaultsApi. * @export @@ -4164,6 +4258,18 @@ export class VaultsApi extends BaseAPI { return VaultsApiFp(this.configuration).lookupVaultByAddress(requestParameters.address).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Registers a Tempo omnibus wallet for the requested vault account. Triggering this flow requires the vault account to hold PATH_USD with a balance sufficient to cover the gas fee. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + * @summary Register a Tempo omnibus wallet + * @param {VaultsApiRegisterTempoOmnibusWalletRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VaultsApi + */ + public registerTempoOmnibusWallet(requestParameters: VaultsApiRegisterTempoOmnibusWalletRequest) { + return VaultsApiFp(this.configuration).registerTempoOmnibusWallet(requestParameters.vaultAccountId, requestParameters.assetId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID diff --git a/client/client.ts b/client/client.ts index 7525527..c06009b 100644 --- a/client/client.ts +++ b/client/client.ts @@ -54,6 +54,7 @@ import { ApiUserApi, StakingApi, TRLinkApi, TagsApi, + TempoBetaApi, TokenizationApi, TradingBetaApi, TransactionsApi, @@ -117,6 +118,7 @@ export class Fireblocks { private _staking?: StakingApi; private _trLink?: TRLinkApi; private _tags?: TagsApi; + private _tempoBeta?: TempoBetaApi; private _tokenization?: TokenizationApi; private _tradingBeta?: TradingBetaApi; private _transactions?: TransactionsApi; @@ -278,6 +280,9 @@ export class Fireblocks { get tags(): TagsApi { return this._tags ?? new TagsApi(this.config, undefined, this.axiosManager.axios); } + get tempoBeta(): TempoBetaApi { + return this._tempoBeta ?? new TempoBetaApi(this.config, undefined, this.axiosManager.axios); + } get tokenization(): TokenizationApi { return this._tokenization ?? new TokenizationApi(this.config, undefined, this.axiosManager.axios); } diff --git a/docs/apis/ApprovalsBetaApi.md b/docs/apis/ApprovalsBetaApi.md index f87ef96..1e4ddca 100644 --- a/docs/apis/ApprovalsBetaApi.md +++ b/docs/apis/ApprovalsBetaApi.md @@ -82,7 +82,7 @@ No authorization required # **createApprovalKey** > RegisterApprovalApiKeyResponse createApprovalKey(registerApprovalApiKeyRequest, ) -Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. +Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. The `userId` must be the authenticated API user\'s own ID. Registering a key for another user is not supported and is rejected. Registration may require approval. In that case the response carries `ccrIdPendingRegistration`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` and cannot sign until the request is approved. A rejected request removes the key. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. ### Example @@ -141,14 +141,15 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | The approval key was registered. | * X-Request-ID -
| +**409** | Another approval key request for this API user is already pending approval. | * X-Request-ID -
| **0** | Error Response | * X-Request-ID -
| [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **deleteApprovalKey** -> deleteApprovalKey() +> DeleteApprovalApiKeyResponse deleteApprovalKey() -Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user\'s ability to sign approvals. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. +Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user\'s last key or another user\'s key. In that case the response carries `ccrIdPendingDeletion`, the key reads as `APPROVAL_API_KEY_STATUS_PENDING_DELETION` and stays active until the request is approved. A rejected request leaves the key enabled. Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin. ### Example @@ -156,7 +157,7 @@ Delete (revoke) an approval public key for the specified API user. Revoking the ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, ApprovalsBetaApiDeleteApprovalKeyRequest } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, ApprovalsBetaApiDeleteApprovalKeyRequest, DeleteApprovalApiKeyResponse } from '@fireblocks/ts-sdk'; // Set the environment variables for authentication process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1" @@ -174,7 +175,7 @@ let body: ApprovalsBetaApiDeleteApprovalKeyRequest = { idempotencyKey: idempotencyKey_example, }; -fireblocks.approvalsBeta.deleteApprovalKey(body).then((res: FireblocksResponse) => { +fireblocks.approvalsBeta.deleteApprovalKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -191,7 +192,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**[DeleteApprovalApiKeyResponse](../models/DeleteApprovalApiKeyResponse.md)** ### Authorization @@ -206,7 +207,8 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | The approval key was deleted. | * X-Request-ID -
| +**200** | The approval key was deleted, or its deletion is pending approval. | * X-Request-ID -
| +**409** | Another approval key request for this API user is already pending approval. | * X-Request-ID -
| **0** | Error Response | * X-Request-ID -
| [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/apis/ConsoleUserApi.md b/docs/apis/ConsoleUserApi.md index 1007fc3..60fe5a1 100644 --- a/docs/apis/ConsoleUserApi.md +++ b/docs/apis/ConsoleUserApi.md @@ -79,7 +79,7 @@ No authorization required # **deleteConsoleUser** > ConsoleUser deleteConsoleUser() -Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. **Note:** This endpoint is currently in beta and might be subject to changes. +Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. ### Example @@ -135,9 +135,10 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **202** | Deletion request accepted. Returns the console user that will be removed once the workspace\'s configured approval completes. | * X-Request-ID -
| +**400** | Bad request: invalid parameters (for example a non-boolean `force`), or TARGET_IS_API_USER - the ID belongs to an API user in this workspace; this endpoint deletes console users only. | * X-Request-ID -
| **401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID -
| **403** | Lacking permissions, or the target cannot be deleted: the user is the workspace Owner, or the caller is the target. | * X-Request-ID -
| -**404** | Console user not found. Also returned for users in other workspaces and for API users, so the endpoint does not reveal whether an ID exists. | * X-Request-ID -
| +**404** | Console user not found. Also returned for users in other workspaces (so the endpoint does not reveal whether an ID exists there) and for users that were already deleted. | * X-Request-ID -
| **409** | PENDING_REQUEST_EXISTS - a deletion request for this user is already awaiting approval; USER_REFERENCED_IN_TAP - the user is referenced by the workspace transaction authorization policy (can be overridden with force=true); or USER_PENDING_ONBOARDING - the user has not completed onboarding, so there is nothing to delete yet. Revoke the invitation from the console instead. | * X-Request-ID -
| **422** | QUORUM_INTEGRITY - the user is required to complete the workspace\'s admin approval quorum. Can be overridden with force=true, matching the console\'s acknowledgement checkbox. | * X-Request-ID -
| **5XX** | Internal error. | * X-Request-ID -
| diff --git a/docs/apis/TempoBetaApi.md b/docs/apis/TempoBetaApi.md new file mode 100644 index 0000000..62e2d16 --- /dev/null +++ b/docs/apis/TempoBetaApi.md @@ -0,0 +1,73 @@ +# TempoBetaApi + +All URIs are relative to https://developers.fireblocks.com/reference/ + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createTempoTransfer**](#createTempoTransfer) | **POST** /operations/tempo/transfer | Create a Tempo transfer transaction + + +# **createTempoTransfer** +> CreateTempoTransferResponse createTempoTransfer(createTempoTransferRequest) + +Creates a new Tempo transfer transaction. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TempoBetaApiCreateTempoTransferRequest, CreateTempoTransferResponse } from '@fireblocks/ts-sdk'; + +// Set the environment variables for authentication +process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1" +process.env.FIREBLOCKS_API_KEY = "my-api-key"; +process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8"); + +const fireblocks = new Fireblocks(); + +let body: TempoBetaApiCreateTempoTransferRequest = { + // CreateTempoTransferRequest + createTempoTransferRequest: param_value, + // 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) + idempotencyKey: idempotencyKey_example, +}; + +fireblocks.tempoBeta.createTempoTransfer(body).then((res: FireblocksResponse) => { + console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); +}).catch((error:any) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createTempoTransferRequest** | **[CreateTempoTransferRequest](../models/CreateTempoTransferRequest.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) defaults to undefined + + +### Return type + +**[CreateTempoTransferResponse](../models/CreateTempoTransferResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Transaction created. | * X-Request-ID -
| +**0** | Error Response | * X-Request-ID -
| + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + diff --git a/docs/apis/VaultsApi.md b/docs/apis/VaultsApi.md index eb3056b..d672d58 100644 --- a/docs/apis/VaultsApi.md +++ b/docs/apis/VaultsApi.md @@ -33,6 +33,7 @@ Method | HTTP request | Description [**getVaultBalanceByAsset**](#getVaultBalanceByAsset) | **GET** /vault/assets/{assetId} | Get vault balance by an asset [**hideVaultAccount**](#hideVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/hide | Hide a vault account in the console [**lookupVaultByAddress**](#lookupVaultByAddress) | **GET** /vault/lookup_by_address | Look up a vault account by blockchain address +[**registerTempoOmnibusWallet**](#registerTempoOmnibusWallet) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/omnibus/tempo/register | Register a Tempo omnibus wallet [**setCustomerRefIdForAddress**](#setCustomerRefIdForAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id | Assign AML customer reference ID [**setUsdcGatewayDepositAutomationBeta**](#setUsdcGatewayDepositAutomationBeta) | **POST** /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation | Set up a USDC Gateway deposit automation for a vault account [**setVaultAccountAutoFuel**](#setVaultAccountAutoFuel) | **POST** /vault/accounts/{vaultAccountId}/set_auto_fuel | Set auto fueling to on or off @@ -1960,6 +1961,72 @@ No authorization required [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +# **registerTempoOmnibusWallet** +> CreateVaultAssetResponse registerTempoOmnibusWallet() + +Registers a Tempo omnibus wallet for the requested vault account. Triggering this flow requires the vault account to hold PATH_USD with a balance sufficient to cover the gas fee. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, VaultsApiRegisterTempoOmnibusWalletRequest, CreateVaultAssetResponse } from '@fireblocks/ts-sdk'; + +// Set the environment variables for authentication +process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1" +process.env.FIREBLOCKS_API_KEY = "my-api-key"; +process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8"); + +const fireblocks = new Fireblocks(); + +let body: VaultsApiRegisterTempoOmnibusWalletRequest = { + // string | The ID of the vault account for which to register the Tempo wallet. + vaultAccountId: vaultAccountId_example, + // string | The Tempo network asset to register for the vault account. + assetId: assetId_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. (optional) + idempotencyKey: idempotencyKey_example, +}; + +fireblocks.vaults.registerTempoOmnibusWallet(body).then((res: FireblocksResponse) => { + console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); +}).catch((error:any) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vaultAccountId** | [**string**] | The ID of the vault account for which to register the Tempo wallet. | defaults to undefined + **assetId** | [**string**] | The Tempo network asset to register for the vault account. | defaults to undefined + **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) defaults to undefined + + +### Return type + +**[CreateVaultAssetResponse](../models/CreateVaultAssetResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | * X-Request-ID -
| +**0** | Error Response | * X-Request-ID -
| + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + # **setCustomerRefIdForAddress** > VaultActionStatus setCustomerRefIdForAddress(setCustomerRefIdForAddressRequest, ) diff --git a/docs/models/AllocationResponseAccept.md b/docs/models/AllocationResponseAccept.md deleted file mode 100644 index d983445..0000000 --- a/docs/models/AllocationResponseAccept.md +++ /dev/null @@ -1,19 +0,0 @@ -# AllocationResponseAccept - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the allocation request. | [default to undefined]| - - -## Enum: AllocationResponseAcceptResponseTypeEnum - - -* `AllocationAccept` (value: `'ALLOCATION_ACCEPT'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/AllocationResponseReject.md b/docs/models/AllocationResponseReject.md deleted file mode 100644 index b65e96e..0000000 --- a/docs/models/AllocationResponseReject.md +++ /dev/null @@ -1,19 +0,0 @@ -# AllocationResponseReject - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the allocation request. | [default to undefined]| - - -## Enum: AllocationResponseRejectResponseTypeEnum - - -* `AllocationReject` (value: `'ALLOCATION_REJECT'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/AllowListPayload.md b/docs/models/AllowListPayload.md index 7284bf9..bf71c73 100644 --- a/docs/models/AllowListPayload.md +++ b/docs/models/AllowListPayload.md @@ -5,11 +5,11 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**vaultAccountId** | **string** | The vault account whose Canton wallet acts here. | [default to undefined]| -|**asset** | **string** | Chain asset — `CANTON` or `CANTON_TEST`. | [default to undefined]| +|**blockchainId** | **string** | The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. | [default to undefined]| |**wallets** | **Array<string>** | Canton party ids to add or remove. | [default to undefined]| -## Enum: AllowListPayloadAssetEnum +## Enum: AllowListPayloadBlockchainIdEnum * `Canton` (value: `'CANTON'`) diff --git a/docs/models/ApprovalApiKey.md b/docs/models/ApprovalApiKey.md index f262321..18e9949 100644 --- a/docs/models/ApprovalApiKey.md +++ b/docs/models/ApprovalApiKey.md @@ -10,6 +10,20 @@ |**lastUsedAt** | **string** | Last time the key was used to sign, as epoch time in seconds (0 if never used). | [default to undefined]| |**approvalApiPublicKey** | [**ApprovalApiPublicKey**](ApprovalApiPublicKey.md) | | [default to undefined]| |**userId** | **string** | The ID of the API user who owns this key. | [default to undefined]| +|**status** | **string** | The state of the key. `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` - registered but waiting for approval, cannot sign yet. `APPROVAL_API_KEY_STATUS_ENABLED` - active. `APPROVAL_API_KEY_STATUS_PENDING_DELETION` - removal is waiting for approval, the key stays active until then. `APPROVAL_API_KEY_STATUS_UNSPECIFIED` - unknown. | [default to undefined]| + + +## Enum: ApprovalApiKeyStatusEnum + + +* `Unspecified` (value: `'APPROVAL_API_KEY_STATUS_UNSPECIFIED'`) + +* `PendingRegistration` (value: `'APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION'`) + +* `Enabled` (value: `'APPROVAL_API_KEY_STATUS_ENABLED'`) + +* `PendingDeletion` (value: `'APPROVAL_API_KEY_STATUS_PENDING_DELETION'`) + diff --git a/docs/models/CantonCall.md b/docs/models/CantonCall.md index 1b30401..ac11e77 100644 --- a/docs/models/CantonCall.md +++ b/docs/models/CantonCall.md @@ -5,7 +5,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**type** | **string** | Which call to make. Selects the shape of `payload`. | [default to undefined]| -|**payload** | [**TransferWithdrawPayload**](TransferWithdrawPayload.md) | | [default to undefined]| +|**payload** | [**AllocationWithdrawPayload**](AllocationWithdrawPayload.md) | | [default to undefined]| ## Enum: CantonCallTypeEnum @@ -25,8 +25,6 @@ * `AllocationWithdraw` (value: `'ALLOCATION_WITHDRAW'`) -* `TransferWithdraw` (value: `'TRANSFER_WITHDRAW'`) - diff --git a/docs/models/CantonCallTransferWithdraw.md b/docs/models/CantonCallTransferWithdraw.md deleted file mode 100644 index 1541f4f..0000000 --- a/docs/models/CantonCallTransferWithdraw.md +++ /dev/null @@ -1,20 +0,0 @@ -# CantonCallTransferWithdraw - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**type** | **string** | Which call to make. Selects the shape of `payload`. | [default to undefined]| -|**payload** | [**TransferWithdrawPayload**](TransferWithdrawPayload.md) | | [default to undefined]| - - -## Enum: CantonCallTransferWithdrawTypeEnum - - -* `TransferWithdraw` (value: `'TRANSFER_WITHDRAW'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/CreateTempoTransferRequest.md b/docs/models/CreateTempoTransferRequest.md new file mode 100644 index 0000000..8ce2105 --- /dev/null +++ b/docs/models/CreateTempoTransferRequest.md @@ -0,0 +1,56 @@ +# CreateTempoTransferRequest + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**assetId** | **string** | The ID of the asset to transfer. Must be a non-deprecated asset supported on a Tempo-eligible blockchain; an unknown, deprecated, or unsupported asset surfaces as 400 UNSUPPORTED_ASSET. | [default to undefined]| +|**source** | [**TempoTransferSource**](TempoTransferSource.md) | | [default to undefined]| +|**note** | **string** | A custom note that can be associated with the transaction. | [optional] [default to undefined]| +|**externalTxId** | **string** | Unique ID provided by the customer, used to identify the transaction. | [optional] [default to undefined]| +|**feeCurrency** | **string** | The asset ID used to pay the transaction fee, if different from assetId. Maps to FeeParams.feeCurrency. Must be a valid fee token for `assetId` (e.g. a TIP-20 gas token for the base asset); an invalid pairing surfaces as 400 INVALID_FEE_CURRENCY_PARAM. | [optional] [default to undefined]| +|**destination** | [**TempoTransferDestination**](TempoTransferDestination.md) | | [optional] [default to undefined]| +|**amount** | **string** | The amount to transfer, as a numeric string. Required when `destination` is set; must be omitted when `destinations` is set (each entry carries its own amount instead). | [optional] [default to undefined]| +|**treatAsGrossAmount** | **boolean** | If true, the specified amount includes the fee (fee is deducted from amount). | [optional] [default to undefined]| +|**feeLevel** | **string** | The fee level to use, mutually exclusive with an explicit custom fee. | [optional] [default to undefined]| +|**travelRuleMessage** | **string** | Beta. An opaque travel-rule payload. | [optional] [default to undefined]| +|**travelRuleMessageId** | **string** | Beta. An identifier of a TravelRule message, already sent to the TravelRule provider. | [optional] [default to undefined]| +|**useGasless** | **boolean** | Opt in to fee-payer-sponsored (gasless) transfer. | [optional] [default to undefined]| +|**configurations** | [**TransactionConfigurations**](TransactionConfigurations.md) | | [optional] [default to undefined]| +|**maxFeePerGas** | **string** | The maximum total fee per gas the sender is willing to pay, in wei. | [optional] [default to undefined]| +|**maxPriorityFeePerGas** | **string** | The maximum priority fee (tip) per gas the sender is willing to pay, in wei. | [optional] [default to undefined]| +|**destinations** | [**Array<TempoTransferDestinationItem>**](TempoTransferDestinationItem.md) | Multiple destinations for a single transfer. Mutually exclusive with `destination`. | [optional] [default to undefined]| +|**failOnLowFee** | **boolean** | Beta. If true, fail the transaction rather than sending it with a low fee. | [optional] [default to undefined]| +|**gasLimit** | **string** | The gas limit for the transaction. | [optional] [default to undefined]| +|**replaceTxByHash** | **string** | Beta. The hash of the EVM transaction to replace (RBF). | [optional] [default to undefined]| +|**feePayerAccountId** | **string** | Vault account ID of the fee payer sponsoring this transfer. | [optional] [default to undefined]| +|**nonceStrategy** | **string** | Tempo\'s 2-dimensional nonce strategy: `SEQUENTIAL` runs under a single nonce lane (lane 0); `USER_DEFINED_LANE` runs in parallel under a specified lane (1–16), and requires `nonceLane`; `EXPIRING` marks the transaction with an expiry of up to 5 minutes (Tempo-defined) and does not use `nonceLane`. | [optional] [default to undefined]| +|**nonceLane** | **number** | The nonce lane to use, 1–16. Required and only meaningful when nonceStrategy is USER_DEFINED_LANE; not used for SEQUENTIAL or EXPIRING. | [optional] [default to undefined]| +|**memo** | **string** | Beta. Tempo TIP-20 memo (max 32 bytes). | [optional] [default to undefined]| + + +## Enum: CreateTempoTransferRequestFeeLevelEnum + + +* `Low` (value: `'LOW'`) + +* `Medium` (value: `'MEDIUM'`) + +* `High` (value: `'HIGH'`) + + + +## Enum: CreateTempoTransferRequestNonceStrategyEnum + + +* `Sequential` (value: `'SEQUENTIAL'`) + +* `UserDefinedLane` (value: `'USER_DEFINED_LANE'`) + +* `Expiring` (value: `'EXPIRING'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/AllocationResponse.md b/docs/models/CreateTempoTransferResponse.md similarity index 57% rename from docs/models/AllocationResponse.md rename to docs/models/CreateTempoTransferResponse.md index 3a826da..faaf0bc 100644 --- a/docs/models/AllocationResponse.md +++ b/docs/models/CreateTempoTransferResponse.md @@ -1,17 +1,11 @@ -# AllocationResponse +# CreateTempoTransferResponse ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the allocation request. | [default to undefined]| - - -## Enum: AllocationResponseResponseTypeEnum - - -* `AllocationReject` (value: `'ALLOCATION_REJECT'`) - +|**id** | **string** | The Fireblocks transaction ID. | [optional] [default to undefined]| +|**status** | **string** | The current status of the transaction. | [optional] [default to undefined]| diff --git a/docs/models/DeleteApprovalApiKeyResponse.md b/docs/models/DeleteApprovalApiKeyResponse.md new file mode 100644 index 0000000..be6abd0 --- /dev/null +++ b/docs/models/DeleteApprovalApiKeyResponse.md @@ -0,0 +1,12 @@ +# DeleteApprovalApiKeyResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**ccrIdPendingDeletion** | **string** | Always returned. An empty string when the key was deleted immediately. Otherwise, the ID of the approval request that must be approved before the key is removed; the key stays active until then. The request appears in `GET /v1/approvals`. | [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TransferResponse.md b/docs/models/DtccOnboardingRejectPayload.md similarity index 58% rename from docs/models/TransferResponse.md rename to docs/models/DtccOnboardingRejectPayload.md index bec98b9..c41a947 100644 --- a/docs/models/TransferResponse.md +++ b/docs/models/DtccOnboardingRejectPayload.md @@ -1,17 +1,10 @@ -# TransferResponse +# DtccOnboardingRejectPayload ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the transfer offer. | [default to undefined]| - - -## Enum: TransferResponseResponseTypeEnum - - -* `TransferReject` (value: `'TRANSFER_REJECT'`) - +|**reason** | **string** | Why the offer is being rejected. Recorded on-chain, where the counterparty can read it. | [default to undefined]| diff --git a/docs/models/EndInvestorPayload.md b/docs/models/EndInvestorPayload.md index 264561a..e05a3c0 100644 --- a/docs/models/EndInvestorPayload.md +++ b/docs/models/EndInvestorPayload.md @@ -5,11 +5,11 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**vaultAccountId** | **string** | The vault account whose Canton wallet acts here. | [default to undefined]| -|**asset** | **string** | Chain asset — `CANTON` or `CANTON_TEST`. | [default to undefined]| +|**blockchainId** | **string** | The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. | [default to undefined]| |**endInvestor** | **string** | The end investor\'s Canton party id. | [default to undefined]| -## Enum: EndInvestorPayloadAssetEnum +## Enum: EndInvestorPayloadBlockchainIdEnum * `Canton` (value: `'CANTON'`) diff --git a/docs/models/OfferResponse.md b/docs/models/OfferResponse.md index 28ebfda..183173e 100644 --- a/docs/models/OfferResponse.md +++ b/docs/models/OfferResponse.md @@ -4,14 +4,14 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**domain** | **string** | Which offer domain this response belongs to. Selects the shape of `response`. | [default to undefined]| -|**response** | [**TransferResponse**](TransferResponse.md) | | [default to undefined]| +|**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| +|**payload** | [**DtccOnboardingRejectPayload**](DtccOnboardingRejectPayload.md) | | [default to undefined]| -## Enum: OfferResponseDomainEnum +## Enum: OfferResponseResponseTypeEnum -* `Transfer` (value: `'TRANSFER'`) +* `TransferWithdraw` (value: `'TRANSFER_WITHDRAW'`) diff --git a/docs/models/OfferResponseAllocation.md b/docs/models/OfferResponseAllocation.md deleted file mode 100644 index 8b5d06e..0000000 --- a/docs/models/OfferResponseAllocation.md +++ /dev/null @@ -1,20 +0,0 @@ -# OfferResponseAllocation - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**domain** | **string** | Which offer domain this response belongs to. Selects the shape of `response`. | [default to undefined]| -|**response** | [**AllocationResponse**](AllocationResponse.md) | | [default to undefined]| - - -## Enum: OfferResponseAllocationDomainEnum - - -* `Allocation` (value: `'ALLOCATION'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OnboardingResponse.md b/docs/models/OfferResponseAllocationAccept.md similarity index 78% rename from docs/models/OnboardingResponse.md rename to docs/models/OfferResponseAllocationAccept.md index ddb1f42..e410b4e 100644 --- a/docs/models/OnboardingResponse.md +++ b/docs/models/OfferResponseAllocationAccept.md @@ -1,17 +1,16 @@ -# OnboardingResponse +# OfferResponseAllocationAccept ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| -|**reason** | **string** | Why the offer is being rejected. Recorded on-chain, where the counterparty can read it. | [default to undefined]| -## Enum: OnboardingResponseResponseTypeEnum +## Enum: OfferResponseAllocationAcceptResponseTypeEnum -* `TradewebCosigningDelegationReject` (value: `'TRADEWEB_COSIGNING_DELEGATION_REJECT'`) +* `AllocationAccept` (value: `'ALLOCATION_ACCEPT'`) diff --git a/docs/models/OfferResponseAllocationReject.md b/docs/models/OfferResponseAllocationReject.md new file mode 100644 index 0000000..339d229 --- /dev/null +++ b/docs/models/OfferResponseAllocationReject.md @@ -0,0 +1,19 @@ +# OfferResponseAllocationReject + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| + + +## Enum: OfferResponseAllocationRejectResponseTypeEnum + + +* `AllocationReject` (value: `'ALLOCATION_REJECT'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OnboardingResponseDtccAccept.md b/docs/models/OfferResponseDtccOnboardingAccept.md similarity index 92% rename from docs/models/OnboardingResponseDtccAccept.md rename to docs/models/OfferResponseDtccOnboardingAccept.md index e1954b3..71baf0d 100644 --- a/docs/models/OnboardingResponseDtccAccept.md +++ b/docs/models/OfferResponseDtccOnboardingAccept.md @@ -1,4 +1,4 @@ -# OnboardingResponseDtccAccept +# OfferResponseDtccOnboardingAccept ## Properties @@ -7,7 +7,7 @@ |**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| -## Enum: OnboardingResponseDtccAcceptResponseTypeEnum +## Enum: OfferResponseDtccOnboardingAcceptResponseTypeEnum * `DtccEndInvestorOnboardingAccept` (value: `'DTCC_END_INVESTOR_ONBOARDING_ACCEPT'`) diff --git a/docs/models/OnboardingResponseDtccReject.md b/docs/models/OfferResponseDtccOnboardingReject.md similarity index 83% rename from docs/models/OnboardingResponseDtccReject.md rename to docs/models/OfferResponseDtccOnboardingReject.md index ea442b7..3b5e33a 100644 --- a/docs/models/OnboardingResponseDtccReject.md +++ b/docs/models/OfferResponseDtccOnboardingReject.md @@ -1,14 +1,14 @@ -# OnboardingResponseDtccReject +# OfferResponseDtccOnboardingReject ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| -|**reason** | **string** | Why the offer is being rejected. Recorded on-chain, where the counterparty can read it. | [default to undefined]| +|**payload** | [**DtccOnboardingRejectPayload**](DtccOnboardingRejectPayload.md) | | [default to undefined]| -## Enum: OnboardingResponseDtccRejectResponseTypeEnum +## Enum: OfferResponseDtccOnboardingRejectResponseTypeEnum * `DtccEndInvestorOnboardingReject` (value: `'DTCC_END_INVESTOR_ONBOARDING_REJECT'`) diff --git a/docs/models/OfferResponseOnboarding.md b/docs/models/OfferResponseOnboarding.md deleted file mode 100644 index c32e323..0000000 --- a/docs/models/OfferResponseOnboarding.md +++ /dev/null @@ -1,20 +0,0 @@ -# OfferResponseOnboarding - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**domain** | **string** | Which offer domain this response belongs to. Selects the shape of `response`. | [default to undefined]| -|**response** | [**OnboardingResponse**](OnboardingResponse.md) | | [default to undefined]| - - -## Enum: OfferResponseOnboardingDomainEnum - - -* `Onboarding` (value: `'ONBOARDING'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OnboardingResponseTradewebAccept.md b/docs/models/OfferResponseTradewebAccept.md similarity index 92% rename from docs/models/OnboardingResponseTradewebAccept.md rename to docs/models/OfferResponseTradewebAccept.md index 19d7477..3352463 100644 --- a/docs/models/OnboardingResponseTradewebAccept.md +++ b/docs/models/OfferResponseTradewebAccept.md @@ -1,4 +1,4 @@ -# OnboardingResponseTradewebAccept +# OfferResponseTradewebAccept ## Properties @@ -7,7 +7,7 @@ |**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| -## Enum: OnboardingResponseTradewebAcceptResponseTypeEnum +## Enum: OfferResponseTradewebAcceptResponseTypeEnum * `TradewebCosigningDelegationAccept` (value: `'TRADEWEB_COSIGNING_DELEGATION_ACCEPT'`) diff --git a/docs/models/OnboardingResponseTradewebReject.md b/docs/models/OfferResponseTradewebReject.md similarity index 92% rename from docs/models/OnboardingResponseTradewebReject.md rename to docs/models/OfferResponseTradewebReject.md index a3ccbea..7ae3128 100644 --- a/docs/models/OnboardingResponseTradewebReject.md +++ b/docs/models/OfferResponseTradewebReject.md @@ -1,4 +1,4 @@ -# OnboardingResponseTradewebReject +# OfferResponseTradewebReject ## Properties @@ -7,7 +7,7 @@ |**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| -## Enum: OnboardingResponseTradewebRejectResponseTypeEnum +## Enum: OfferResponseTradewebRejectResponseTypeEnum * `TradewebCosigningDelegationReject` (value: `'TRADEWEB_COSIGNING_DELEGATION_REJECT'`) diff --git a/docs/models/OfferResponseTransfer.md b/docs/models/OfferResponseTransfer.md deleted file mode 100644 index 211c5b8..0000000 --- a/docs/models/OfferResponseTransfer.md +++ /dev/null @@ -1,20 +0,0 @@ -# OfferResponseTransfer - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**domain** | **string** | Which offer domain this response belongs to. Selects the shape of `response`. | [default to undefined]| -|**response** | [**TransferResponse**](TransferResponse.md) | | [default to undefined]| - - -## Enum: OfferResponseTransferDomainEnum - - -* `Transfer` (value: `'TRANSFER'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OfferResponseTransferAccept.md b/docs/models/OfferResponseTransferAccept.md new file mode 100644 index 0000000..a20e1e1 --- /dev/null +++ b/docs/models/OfferResponseTransferAccept.md @@ -0,0 +1,19 @@ +# OfferResponseTransferAccept + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| + + +## Enum: OfferResponseTransferAcceptResponseTypeEnum + + +* `TransferAccept` (value: `'TRANSFER_ACCEPT'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OfferResponseTransferReject.md b/docs/models/OfferResponseTransferReject.md new file mode 100644 index 0000000..bf18da3 --- /dev/null +++ b/docs/models/OfferResponseTransferReject.md @@ -0,0 +1,19 @@ +# OfferResponseTransferReject + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| + + +## Enum: OfferResponseTransferRejectResponseTypeEnum + + +* `TransferReject` (value: `'TRANSFER_REJECT'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/OfferResponseTransferWithdraw.md b/docs/models/OfferResponseTransferWithdraw.md new file mode 100644 index 0000000..00adee1 --- /dev/null +++ b/docs/models/OfferResponseTransferWithdraw.md @@ -0,0 +1,19 @@ +# OfferResponseTransferWithdraw + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**responseType** | **string** | How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. | [default to undefined]| + + +## Enum: OfferResponseTransferWithdrawResponseTypeEnum + + +* `TransferWithdraw` (value: `'TRANSFER_WITHDRAW'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/ParticipantOnboardingPayload.md b/docs/models/ParticipantOnboardingPayload.md index bf98348..bd48813 100644 --- a/docs/models/ParticipantOnboardingPayload.md +++ b/docs/models/ParticipantOnboardingPayload.md @@ -5,7 +5,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**vaultAccountId** | **string** | The vault account that acts as the participant. Its Canton party is derived for you. | [default to undefined]| -|**asset** | **string** | Chain asset — CANTON or CANTON_TEST. | [default to undefined]| +|**blockchainId** | **string** | The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. | [default to undefined]| |**operator** | **string** | DTCC infra operator party id. | [default to undefined]| |**compliance** | **string** | DTCC compliance party id. | [default to undefined]| |**registrar** | **string** | DTCC registrar party id — co-signs the accept. | [default to undefined]| @@ -14,7 +14,7 @@ |**expiresAt** | **string** | When the onboarding request expires if it has not been answered. RFC 3339. | [optional] [default to undefined]| -## Enum: ParticipantOnboardingPayloadAssetEnum +## Enum: ParticipantOnboardingPayloadBlockchainIdEnum * `Canton` (value: `'CANTON'`) diff --git a/docs/models/RegisterApprovalApiKeyResponse.md b/docs/models/RegisterApprovalApiKeyResponse.md index 25514b2..c7d7931 100644 --- a/docs/models/RegisterApprovalApiKeyResponse.md +++ b/docs/models/RegisterApprovalApiKeyResponse.md @@ -5,6 +5,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**keyId** | **string** | The server-generated ID of the registered key, used for deletion. | [default to undefined]| +|**ccrIdPendingRegistration** | **string** | Always returned. An empty string when the key is active immediately. Otherwise, the ID of the approval request that must be approved before the key becomes active. The request appears in `GET /v1/approvals`. | [default to undefined]| diff --git a/docs/models/TempoTransferDestination.md b/docs/models/TempoTransferDestination.md new file mode 100644 index 0000000..220e256 --- /dev/null +++ b/docs/models/TempoTransferDestination.md @@ -0,0 +1,25 @@ +# TempoTransferDestination + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**type** | **string** | The kind of destination. | [default to undefined]| +|**id** | **string** | Required when type is VAULT_ACCOUNT or UNMANAGED_WALLET. | [optional] [default to undefined]| +|**oneTimeAddress** | [**OneTimeAddress**](OneTimeAddress.md) | | [optional] [default to undefined]| + + +## Enum: TempoTransferDestinationTypeEnum + + +* `VaultAccount` (value: `'VAULT_ACCOUNT'`) + +* `OneTimeAddress` (value: `'ONE_TIME_ADDRESS'`) + +* `UnmanagedWallet` (value: `'UNMANAGED_WALLET'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TempoTransferDestinationItem.md b/docs/models/TempoTransferDestinationItem.md new file mode 100644 index 0000000..be3e147 --- /dev/null +++ b/docs/models/TempoTransferDestinationItem.md @@ -0,0 +1,15 @@ +# TempoTransferDestinationItem + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**amount** | **string** | The amount to transfer to this destination, as a numeric string. | [optional] [default to undefined]| +|**destination** | [**TempoTransferDestination**](TempoTransferDestination.md) | | [optional] [default to undefined]| +|**travelRuleMessageId** | **string** | Beta. An identifier of a TravelRule message, already sent to the TravelRule provider. | [optional] [default to undefined]| +|**customerRefId** | **string** | The ID for AML providers to associate the owner of funds with transactions. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TempoTransferSource.md b/docs/models/TempoTransferSource.md new file mode 100644 index 0000000..fc22b9e --- /dev/null +++ b/docs/models/TempoTransferSource.md @@ -0,0 +1,23 @@ +# TempoTransferSource + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**type** | **string** | The kind of source. | [default to undefined]| +|**id** | **string** | Required when type is VAULT_ACCOUNT — the vault account ID. | [optional] [default to undefined]| +|**walletId** | **string** | Required when type is EMBEDDED_WALLET. | [optional] [default to undefined]| + + +## Enum: TempoTransferSourceTypeEnum + + +* `VaultAccount` (value: `'VAULT_ACCOUNT'`) + +* `EmbeddedWallet` (value: `'EMBEDDED_WALLET'`) + + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TransferResponseAccept.md b/docs/models/TransferResponseAccept.md deleted file mode 100644 index 3670345..0000000 --- a/docs/models/TransferResponseAccept.md +++ /dev/null @@ -1,19 +0,0 @@ -# TransferResponseAccept - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the transfer offer. | [default to undefined]| - - -## Enum: TransferResponseAcceptResponseTypeEnum - - -* `TransferAccept` (value: `'TRANSFER_ACCEPT'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TransferResponseReject.md b/docs/models/TransferResponseReject.md deleted file mode 100644 index f039c3a..0000000 --- a/docs/models/TransferResponseReject.md +++ /dev/null @@ -1,19 +0,0 @@ -# TransferResponseReject - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**responseType** | **string** | How you are answering the transfer offer. | [default to undefined]| - - -## Enum: TransferResponseRejectResponseTypeEnum - - -* `TransferReject` (value: `'TRANSFER_REJECT'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TransferWithdrawPayload.md b/docs/models/TransferWithdrawPayload.md deleted file mode 100644 index b827d04..0000000 --- a/docs/models/TransferWithdrawPayload.md +++ /dev/null @@ -1,23 +0,0 @@ -# TransferWithdrawPayload - -## Properties - -|Name | Type | Description | Notes| -|------------ | ------------- | ------------- | -------------| -|**vaultAccountId** | **string** | The vault account whose Canton wallet acts here. | [default to undefined]| -|**asset** | **string** | Chain asset — `CANTON` or `CANTON_TEST`. | [default to undefined]| -|**offerTransactionId** | **string** | The Fireblocks transaction id of the OUTGOING transfer offer being withdrawn. | [default to undefined]| - - -## Enum: TransferWithdrawPayloadAssetEnum - - -* `Canton` (value: `'CANTON'`) - -* `CantonTest` (value: `'CANTON_TEST'`) - - - - - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/models/allocation-response-accept.ts b/models/allocation-response-accept.ts deleted file mode 100644 index 4103323..0000000 --- a/models/allocation-response-accept.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - - -/** - * Accept a CIP-56 allocation request. Carries no arguments. - * @export - * @interface AllocationResponseAccept - */ -export interface AllocationResponseAccept { - /** - * How you are answering the allocation request. - * @type {string} - * @memberof AllocationResponseAccept - */ - 'responseType': AllocationResponseAcceptResponseTypeEnum; -} - -export const AllocationResponseAcceptResponseTypeEnum = { - AllocationAccept: 'ALLOCATION_ACCEPT' -} as const; - -export type AllocationResponseAcceptResponseTypeEnum = typeof AllocationResponseAcceptResponseTypeEnum[keyof typeof AllocationResponseAcceptResponseTypeEnum]; - - diff --git a/models/allocation-response-reject.ts b/models/allocation-response-reject.ts deleted file mode 100644 index ffcd224..0000000 --- a/models/allocation-response-reject.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - - -/** - * Reject a CIP-56 allocation request. Carries no arguments. - * @export - * @interface AllocationResponseReject - */ -export interface AllocationResponseReject { - /** - * How you are answering the allocation request. - * @type {string} - * @memberof AllocationResponseReject - */ - 'responseType': AllocationResponseRejectResponseTypeEnum; -} - -export const AllocationResponseRejectResponseTypeEnum = { - AllocationReject: 'ALLOCATION_REJECT' -} as const; - -export type AllocationResponseRejectResponseTypeEnum = typeof AllocationResponseRejectResponseTypeEnum[keyof typeof AllocationResponseRejectResponseTypeEnum]; - - diff --git a/models/allow-list-payload.ts b/models/allow-list-payload.ts index 9ca2b3b..5a39dd7 100644 --- a/models/allow-list-payload.ts +++ b/models/allow-list-payload.ts @@ -27,11 +27,11 @@ export interface AllowListPayload { */ 'vaultAccountId': string; /** - * Chain asset — `CANTON` or `CANTON_TEST`. + * The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. * @type {string} * @memberof AllowListPayload */ - 'asset': AllowListPayloadAssetEnum; + 'blockchainId': AllowListPayloadBlockchainIdEnum; /** * Canton party ids to add or remove. * @type {Array} @@ -40,11 +40,11 @@ export interface AllowListPayload { 'wallets': Array; } -export const AllowListPayloadAssetEnum = { +export const AllowListPayloadBlockchainIdEnum = { Canton: 'CANTON', CantonTest: 'CANTON_TEST' } as const; -export type AllowListPayloadAssetEnum = typeof AllowListPayloadAssetEnum[keyof typeof AllowListPayloadAssetEnum]; +export type AllowListPayloadBlockchainIdEnum = typeof AllowListPayloadBlockchainIdEnum[keyof typeof AllowListPayloadBlockchainIdEnum]; diff --git a/models/approval-api-key.ts b/models/approval-api-key.ts index ef391a0..7ec22e8 100644 --- a/models/approval-api-key.ts +++ b/models/approval-api-key.ts @@ -59,5 +59,21 @@ export interface ApprovalApiKey { * @memberof ApprovalApiKey */ 'userId': string; + /** + * The state of the key. `APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION` - registered but waiting for approval, cannot sign yet. `APPROVAL_API_KEY_STATUS_ENABLED` - active. `APPROVAL_API_KEY_STATUS_PENDING_DELETION` - removal is waiting for approval, the key stays active until then. `APPROVAL_API_KEY_STATUS_UNSPECIFIED` - unknown. + * @type {string} + * @memberof ApprovalApiKey + */ + 'status': ApprovalApiKeyStatusEnum; } +export const ApprovalApiKeyStatusEnum = { + Unspecified: 'APPROVAL_API_KEY_STATUS_UNSPECIFIED', + PendingRegistration: 'APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION', + Enabled: 'APPROVAL_API_KEY_STATUS_ENABLED', + PendingDeletion: 'APPROVAL_API_KEY_STATUS_PENDING_DELETION' +} as const; + +export type ApprovalApiKeyStatusEnum = typeof ApprovalApiKeyStatusEnum[keyof typeof ApprovalApiKeyStatusEnum]; + + diff --git a/models/canton-call-transfer-withdraw.ts b/models/canton-call-transfer-withdraw.ts deleted file mode 100644 index 6fc6e47..0000000 --- a/models/canton-call-transfer-withdraw.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import { TransferWithdrawPayload } from './transfer-withdraw-payload'; - -/** - * - * @export - * @interface CantonCallTransferWithdraw - */ -export interface CantonCallTransferWithdraw { - /** - * Which call to make. Selects the shape of `payload`. - * @type {string} - * @memberof CantonCallTransferWithdraw - */ - 'type': CantonCallTransferWithdrawTypeEnum; - /** - * - * @type {TransferWithdrawPayload} - * @memberof CantonCallTransferWithdraw - */ - 'payload': TransferWithdrawPayload; -} - -export const CantonCallTransferWithdrawTypeEnum = { - TransferWithdraw: 'TRANSFER_WITHDRAW' -} as const; - -export type CantonCallTransferWithdrawTypeEnum = typeof CantonCallTransferWithdrawTypeEnum[keyof typeof CantonCallTransferWithdrawTypeEnum]; - - diff --git a/models/canton-call.ts b/models/canton-call.ts index 04d7980..63cfe9d 100644 --- a/models/canton-call.ts +++ b/models/canton-call.ts @@ -13,6 +13,9 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import { AllocationWithdrawPayload } from './allocation-withdraw-payload'; // May contain unused imports in some cases // @ts-ignore import { CantonCallAllocationWithdraw } from './canton-call-allocation-withdraw'; @@ -34,17 +37,11 @@ import { CantonCallEndInvestorOffboard } from './canton-call-end-investor-offboa // May contain unused imports in some cases // @ts-ignore import { CantonCallParticipantOnboarding } from './canton-call-participant-onboarding'; -// May contain unused imports in some cases -// @ts-ignore -import { CantonCallTransferWithdraw } from './canton-call-transfer-withdraw'; -// May contain unused imports in some cases -// @ts-ignore -import { TransferWithdrawPayload } from './transfer-withdraw-payload'; /** * @type CantonCall * @export */ -export type CantonCall = { type: 'ALLOCATION_WITHDRAW' } & CantonCallAllocationWithdraw | { type: 'DTCC_ALLOW_LIST_ADD' } & CantonCallAllowListAdd | { type: 'DTCC_ALLOW_LIST_REMOVE' } & CantonCallAllowListRemove | { type: 'DTCC_END_INVESTOR_INVITE' } & CantonCallEndInvestorInvite | { type: 'DTCC_END_INVESTOR_INVITE_CANCEL' } & CantonCallEndInvestorInviteCancel | { type: 'DTCC_END_INVESTOR_OFFBOARD' } & CantonCallEndInvestorOffboard | { type: 'DTCC_PARTICIPANT_ONBOARDING' } & CantonCallParticipantOnboarding | { type: 'TRANSFER_WITHDRAW' } & CantonCallTransferWithdraw; +export type CantonCall = { type: 'ALLOCATION_WITHDRAW' } & CantonCallAllocationWithdraw | { type: 'DTCC_ALLOW_LIST_ADD' } & CantonCallAllowListAdd | { type: 'DTCC_ALLOW_LIST_REMOVE' } & CantonCallAllowListRemove | { type: 'DTCC_END_INVESTOR_INVITE' } & CantonCallEndInvestorInvite | { type: 'DTCC_END_INVESTOR_INVITE_CANCEL' } & CantonCallEndInvestorInviteCancel | { type: 'DTCC_END_INVESTOR_OFFBOARD' } & CantonCallEndInvestorOffboard | { type: 'DTCC_PARTICIPANT_ONBOARDING' } & CantonCallParticipantOnboarding; diff --git a/models/create-tempo-transfer-request.ts b/models/create-tempo-transfer-request.ts new file mode 100644 index 0000000..444376e --- /dev/null +++ b/models/create-tempo-transfer-request.ts @@ -0,0 +1,190 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TempoTransferDestination } from './tempo-transfer-destination'; +// May contain unused imports in some cases +// @ts-ignore +import { TempoTransferDestinationItem } from './tempo-transfer-destination-item'; +// May contain unused imports in some cases +// @ts-ignore +import { TempoTransferSource } from './tempo-transfer-source'; +// May contain unused imports in some cases +// @ts-ignore +import { TransactionConfigurations } from './transaction-configurations'; + +/** + * Request body for creating a Tempo transfer transaction. + * @export + * @interface CreateTempoTransferRequest + */ +export interface CreateTempoTransferRequest { + /** + * The ID of the asset to transfer. Must be a non-deprecated asset supported on a Tempo-eligible blockchain; an unknown, deprecated, or unsupported asset surfaces as 400 UNSUPPORTED_ASSET. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'assetId': string; + /** + * + * @type {TempoTransferSource} + * @memberof CreateTempoTransferRequest + */ + 'source': TempoTransferSource; + /** + * A custom note that can be associated with the transaction. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'note'?: string; + /** + * Unique ID provided by the customer, used to identify the transaction. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'externalTxId'?: string; + /** + * The asset ID used to pay the transaction fee, if different from assetId. Maps to FeeParams.feeCurrency. Must be a valid fee token for `assetId` (e.g. a TIP-20 gas token for the base asset); an invalid pairing surfaces as 400 INVALID_FEE_CURRENCY_PARAM. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'feeCurrency'?: string; + /** + * + * @type {TempoTransferDestination} + * @memberof CreateTempoTransferRequest + */ + 'destination'?: TempoTransferDestination; + /** + * The amount to transfer, as a numeric string. Required when `destination` is set; must be omitted when `destinations` is set (each entry carries its own amount instead). + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'amount'?: string; + /** + * If true, the specified amount includes the fee (fee is deducted from amount). + * @type {boolean} + * @memberof CreateTempoTransferRequest + */ + 'treatAsGrossAmount'?: boolean; + /** + * The fee level to use, mutually exclusive with an explicit custom fee. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'feeLevel'?: CreateTempoTransferRequestFeeLevelEnum; + /** + * Beta. An opaque travel-rule payload. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'travelRuleMessage'?: string; + /** + * Beta. An identifier of a TravelRule message, already sent to the TravelRule provider. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'travelRuleMessageId'?: string; + /** + * Opt in to fee-payer-sponsored (gasless) transfer. + * @type {boolean} + * @memberof CreateTempoTransferRequest + */ + 'useGasless'?: boolean; + /** + * + * @type {TransactionConfigurations} + * @memberof CreateTempoTransferRequest + */ + 'configurations'?: TransactionConfigurations; + /** + * The maximum total fee per gas the sender is willing to pay, in wei. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'maxFeePerGas'?: string; + /** + * The maximum priority fee (tip) per gas the sender is willing to pay, in wei. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'maxPriorityFeePerGas'?: string; + /** + * Multiple destinations for a single transfer. Mutually exclusive with `destination`. + * @type {Array} + * @memberof CreateTempoTransferRequest + */ + 'destinations'?: Array; + /** + * Beta. If true, fail the transaction rather than sending it with a low fee. + * @type {boolean} + * @memberof CreateTempoTransferRequest + */ + 'failOnLowFee'?: boolean; + /** + * The gas limit for the transaction. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'gasLimit'?: string; + /** + * Beta. The hash of the EVM transaction to replace (RBF). + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'replaceTxByHash'?: string; + /** + * Vault account ID of the fee payer sponsoring this transfer. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'feePayerAccountId'?: string; + /** + * Tempo\'s 2-dimensional nonce strategy: `SEQUENTIAL` runs under a single nonce lane (lane 0); `USER_DEFINED_LANE` runs in parallel under a specified lane (1–16), and requires `nonceLane`; `EXPIRING` marks the transaction with an expiry of up to 5 minutes (Tempo-defined) and does not use `nonceLane`. + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'nonceStrategy'?: CreateTempoTransferRequestNonceStrategyEnum; + /** + * The nonce lane to use, 1–16. Required and only meaningful when nonceStrategy is USER_DEFINED_LANE; not used for SEQUENTIAL or EXPIRING. + * @type {number} + * @memberof CreateTempoTransferRequest + */ + 'nonceLane'?: number; + /** + * Beta. Tempo TIP-20 memo (max 32 bytes). + * @type {string} + * @memberof CreateTempoTransferRequest + */ + 'memo'?: string; +} + +export const CreateTempoTransferRequestFeeLevelEnum = { + Low: 'LOW', + Medium: 'MEDIUM', + High: 'HIGH' +} as const; + +export type CreateTempoTransferRequestFeeLevelEnum = typeof CreateTempoTransferRequestFeeLevelEnum[keyof typeof CreateTempoTransferRequestFeeLevelEnum]; +export const CreateTempoTransferRequestNonceStrategyEnum = { + Sequential: 'SEQUENTIAL', + UserDefinedLane: 'USER_DEFINED_LANE', + Expiring: 'EXPIRING' +} as const; + +export type CreateTempoTransferRequestNonceStrategyEnum = typeof CreateTempoTransferRequestNonceStrategyEnum[keyof typeof CreateTempoTransferRequestNonceStrategyEnum]; + + diff --git a/models/transfer-response.ts b/models/create-tempo-transfer-response.ts similarity index 60% rename from models/transfer-response.ts rename to models/create-tempo-transfer-response.ts index 0752e1d..a205bd7 100644 --- a/models/transfer-response.ts +++ b/models/create-tempo-transfer-response.ts @@ -13,17 +13,24 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { TransferResponseAccept } from './transfer-response-accept'; -// May contain unused imports in some cases -// @ts-ignore -import { TransferResponseReject } from './transfer-response-reject'; /** - * @type TransferResponse + * * @export + * @interface CreateTempoTransferResponse */ -export type TransferResponse = { responseType: 'TRANSFER_ACCEPT' } & TransferResponseAccept | { responseType: 'TRANSFER_REJECT' } & TransferResponseReject; - +export interface CreateTempoTransferResponse { + /** + * The Fireblocks transaction ID. + * @type {string} + * @memberof CreateTempoTransferResponse + */ + 'id'?: string; + /** + * The current status of the transaction. + * @type {string} + * @memberof CreateTempoTransferResponse + */ + 'status'?: string; +} diff --git a/models/transfer-response-reject.ts b/models/delete-approval-api-key-response.ts similarity index 56% rename from models/transfer-response-reject.ts rename to models/delete-approval-api-key-response.ts index 55a5d8f..3897d12 100644 --- a/models/transfer-response-reject.ts +++ b/models/delete-approval-api-key-response.ts @@ -15,23 +15,16 @@ /** - * Reject an inbound 2-step transfer offer. Carries no arguments. + * The result of deleting an approval API key. * @export - * @interface TransferResponseReject + * @interface DeleteApprovalApiKeyResponse */ -export interface TransferResponseReject { +export interface DeleteApprovalApiKeyResponse { /** - * How you are answering the transfer offer. + * Always returned. An empty string when the key was deleted immediately. Otherwise, the ID of the approval request that must be approved before the key is removed; the key stays active until then. The request appears in `GET /v1/approvals`. * @type {string} - * @memberof TransferResponseReject + * @memberof DeleteApprovalApiKeyResponse */ - 'responseType': TransferResponseRejectResponseTypeEnum; + 'ccrIdPendingDeletion': string; } -export const TransferResponseRejectResponseTypeEnum = { - TransferReject: 'TRANSFER_REJECT' -} as const; - -export type TransferResponseRejectResponseTypeEnum = typeof TransferResponseRejectResponseTypeEnum[keyof typeof TransferResponseRejectResponseTypeEnum]; - - diff --git a/models/allocation-response.ts b/models/dtcc-onboarding-reject-payload.ts similarity index 59% rename from models/allocation-response.ts rename to models/dtcc-onboarding-reject-payload.ts index 08f4518..d5ebf64 100644 --- a/models/allocation-response.ts +++ b/models/dtcc-onboarding-reject-payload.ts @@ -13,17 +13,18 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { AllocationResponseAccept } from './allocation-response-accept'; -// May contain unused imports in some cases -// @ts-ignore -import { AllocationResponseReject } from './allocation-response-reject'; /** - * @type AllocationResponse + * * @export + * @interface DtccOnboardingRejectPayload */ -export type AllocationResponse = { responseType: 'ALLOCATION_ACCEPT' } & AllocationResponseAccept | { responseType: 'ALLOCATION_REJECT' } & AllocationResponseReject; - +export interface DtccOnboardingRejectPayload { + /** + * Why the offer is being rejected. Recorded on-chain, where the counterparty can read it. + * @type {string} + * @memberof DtccOnboardingRejectPayload + */ + 'reason': string; +} diff --git a/models/end-investor-payload.ts b/models/end-investor-payload.ts index 1d73091..70264fa 100644 --- a/models/end-investor-payload.ts +++ b/models/end-investor-payload.ts @@ -27,11 +27,11 @@ export interface EndInvestorPayload { */ 'vaultAccountId': string; /** - * Chain asset — `CANTON` or `CANTON_TEST`. + * The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. * @type {string} * @memberof EndInvestorPayload */ - 'asset': EndInvestorPayloadAssetEnum; + 'blockchainId': EndInvestorPayloadBlockchainIdEnum; /** * The end investor\'s Canton party id. * @type {string} @@ -40,11 +40,11 @@ export interface EndInvestorPayload { 'endInvestor': string; } -export const EndInvestorPayloadAssetEnum = { +export const EndInvestorPayloadBlockchainIdEnum = { Canton: 'CANTON', CantonTest: 'CANTON_TEST' } as const; -export type EndInvestorPayloadAssetEnum = typeof EndInvestorPayloadAssetEnum[keyof typeof EndInvestorPayloadAssetEnum]; +export type EndInvestorPayloadBlockchainIdEnum = typeof EndInvestorPayloadBlockchainIdEnum[keyof typeof EndInvestorPayloadBlockchainIdEnum]; diff --git a/models/index.ts b/models/index.ts index 89f658d..7f824b6 100644 --- a/models/index.ts +++ b/models/index.ts @@ -68,9 +68,6 @@ export * from './address-reverse-lookup-response'; export * from './addresses-filters'; export * from './alert-exposure-type-enum'; export * from './alert-level-enum'; -export * from './allocation-response'; -export * from './allocation-response-accept'; -export * from './allocation-response-reject'; export * from './allocation-withdraw-payload'; export * from './allow-list-payload'; export * from './allowlist-entry'; @@ -198,7 +195,6 @@ export * from './canton-call-end-investor-invite'; export * from './canton-call-end-investor-invite-cancel'; export * from './canton-call-end-investor-offboard'; export * from './canton-call-participant-onboarding'; -export * from './canton-call-transfer-withdraw'; export * from './canton-details'; export * from './canton-domain-enum'; export * from './canton-offer-response-details'; @@ -341,6 +337,8 @@ export * from './create-report-response'; export * from './create-signing-key-dto'; export * from './create-signing-key-dto-proof-of-ownership'; export * from './create-tag-request'; +export * from './create-tempo-transfer-request'; +export * from './create-tempo-transfer-response'; export * from './create-token-request-dto'; export * from './create-token-request-dto-create-params'; export * from './create-transaction-response'; @@ -365,6 +363,7 @@ export * from './default-network-routing-dest'; export * from './delegation'; export * from './delegation-blockchain-position-info'; export * from './delegation-summary'; +export * from './delete-approval-api-key-response'; export * from './delete-network-connection-response'; export * from './delete-network-id-response'; export * from './delete-webhook-mtls-config-response'; @@ -408,6 +407,7 @@ export * from './draft-response'; export * from './draft-review-and-validation-response'; export * from './drop-transaction-request'; export * from './drop-transaction-response'; +export * from './dtcc-onboarding-reject-payload'; export * from './dvn-config'; export * from './dvn-config-with-confirmations'; export * from './evmtoken-create-params-dto'; @@ -697,15 +697,16 @@ export * from './notification-with-data'; export * from './offer'; export * from './offer-response'; export * from './offer-response-accepted'; -export * from './offer-response-allocation'; -export * from './offer-response-onboarding'; -export * from './offer-response-transfer'; +export * from './offer-response-allocation-accept'; +export * from './offer-response-allocation-reject'; +export * from './offer-response-dtcc-onboarding-accept'; +export * from './offer-response-dtcc-onboarding-reject'; +export * from './offer-response-tradeweb-accept'; +export * from './offer-response-tradeweb-reject'; +export * from './offer-response-transfer-accept'; +export * from './offer-response-transfer-reject'; +export * from './offer-response-transfer-withdraw'; export * from './offers-response'; -export * from './onboarding-response'; -export * from './onboarding-response-dtcc-accept'; -export * from './onboarding-response-dtcc-reject'; -export * from './onboarding-response-tradeweb-accept'; -export * from './onboarding-response-tradeweb-reject'; export * from './onchain-transaction'; export * from './onchain-transactions-paged-response'; export * from './onchain-transactions-paged-response2'; @@ -1141,6 +1142,9 @@ export * from './tag-attachment-operation-action'; export * from './tag-type'; export * from './tags-paged-response'; export * from './templates-paginated-response'; +export * from './tempo-transfer-destination'; +export * from './tempo-transfer-destination-item'; +export * from './tempo-transfer-source'; export * from './third-party-routing'; export * from './time-based-trigger'; export * from './time-in-force'; @@ -1206,11 +1210,7 @@ export * from './transfer-peer-type-enum'; export * from './transfer-peer-type-enum2'; export * from './transfer-rail'; export * from './transfer-receipt'; -export * from './transfer-response'; -export * from './transfer-response-accept'; -export * from './transfer-response-reject'; export * from './transfer-validation-failure'; -export * from './transfer-withdraw-payload'; export * from './travel-rule-action-enum'; export * from './travel-rule-address'; export * from './travel-rule-create-transaction-request'; diff --git a/models/offer-response-allocation-accept.ts b/models/offer-response-allocation-accept.ts new file mode 100644 index 0000000..158ce09 --- /dev/null +++ b/models/offer-response-allocation-accept.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + + +/** + * Accept a CIP-56 allocation request. Carries no arguments. + * @export + * @interface OfferResponseAllocationAccept + */ +export interface OfferResponseAllocationAccept { + /** + * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. + * @type {string} + * @memberof OfferResponseAllocationAccept + */ + 'responseType': OfferResponseAllocationAcceptResponseTypeEnum; +} + +export const OfferResponseAllocationAcceptResponseTypeEnum = { + AllocationAccept: 'ALLOCATION_ACCEPT' +} as const; + +export type OfferResponseAllocationAcceptResponseTypeEnum = typeof OfferResponseAllocationAcceptResponseTypeEnum[keyof typeof OfferResponseAllocationAcceptResponseTypeEnum]; + + diff --git a/models/offer-response-allocation-reject.ts b/models/offer-response-allocation-reject.ts new file mode 100644 index 0000000..241166c --- /dev/null +++ b/models/offer-response-allocation-reject.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + + +/** + * Reject a CIP-56 allocation request. Carries no arguments. + * @export + * @interface OfferResponseAllocationReject + */ +export interface OfferResponseAllocationReject { + /** + * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. + * @type {string} + * @memberof OfferResponseAllocationReject + */ + 'responseType': OfferResponseAllocationRejectResponseTypeEnum; +} + +export const OfferResponseAllocationRejectResponseTypeEnum = { + AllocationReject: 'ALLOCATION_REJECT' +} as const; + +export type OfferResponseAllocationRejectResponseTypeEnum = typeof OfferResponseAllocationRejectResponseTypeEnum[keyof typeof OfferResponseAllocationRejectResponseTypeEnum]; + + diff --git a/models/offer-response-allocation.ts b/models/offer-response-allocation.ts deleted file mode 100644 index c4140b8..0000000 --- a/models/offer-response-allocation.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import { AllocationResponse } from './allocation-response'; - -/** - * - * @export - * @interface OfferResponseAllocation - */ -export interface OfferResponseAllocation { - /** - * Which offer domain this response belongs to. Selects the shape of `response`. - * @type {string} - * @memberof OfferResponseAllocation - */ - 'domain': OfferResponseAllocationDomainEnum; - /** - * - * @type {AllocationResponse} - * @memberof OfferResponseAllocation - */ - 'response': AllocationResponse; -} - -export const OfferResponseAllocationDomainEnum = { - Allocation: 'ALLOCATION' -} as const; - -export type OfferResponseAllocationDomainEnum = typeof OfferResponseAllocationDomainEnum[keyof typeof OfferResponseAllocationDomainEnum]; - - diff --git a/models/onboarding-response-dtcc-accept.ts b/models/offer-response-dtcc-onboarding-accept.ts similarity index 76% rename from models/onboarding-response-dtcc-accept.ts rename to models/offer-response-dtcc-onboarding-accept.ts index 223adb5..78308a7 100644 --- a/models/onboarding-response-dtcc-accept.ts +++ b/models/offer-response-dtcc-onboarding-accept.ts @@ -17,21 +17,21 @@ /** * Accept a DTCC end-investor onboarding offer. Carries no arguments. * @export - * @interface OnboardingResponseDtccAccept + * @interface OfferResponseDtccOnboardingAccept */ -export interface OnboardingResponseDtccAccept { +export interface OfferResponseDtccOnboardingAccept { /** * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. * @type {string} - * @memberof OnboardingResponseDtccAccept + * @memberof OfferResponseDtccOnboardingAccept */ - 'responseType': OnboardingResponseDtccAcceptResponseTypeEnum; + 'responseType': OfferResponseDtccOnboardingAcceptResponseTypeEnum; } -export const OnboardingResponseDtccAcceptResponseTypeEnum = { +export const OfferResponseDtccOnboardingAcceptResponseTypeEnum = { DtccEndInvestorOnboardingAccept: 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT' } as const; -export type OnboardingResponseDtccAcceptResponseTypeEnum = typeof OnboardingResponseDtccAcceptResponseTypeEnum[keyof typeof OnboardingResponseDtccAcceptResponseTypeEnum]; +export type OfferResponseDtccOnboardingAcceptResponseTypeEnum = typeof OfferResponseDtccOnboardingAcceptResponseTypeEnum[keyof typeof OfferResponseDtccOnboardingAcceptResponseTypeEnum]; diff --git a/models/onboarding-response-dtcc-reject.ts b/models/offer-response-dtcc-onboarding-reject.ts similarity index 66% rename from models/onboarding-response-dtcc-reject.ts rename to models/offer-response-dtcc-onboarding-reject.ts index 1360e24..8da467a 100644 --- a/models/onboarding-response-dtcc-reject.ts +++ b/models/offer-response-dtcc-onboarding-reject.ts @@ -13,31 +13,34 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import { DtccOnboardingRejectPayload } from './dtcc-onboarding-reject-payload'; /** * Reject a DTCC end-investor onboarding offer. * @export - * @interface OnboardingResponseDtccReject + * @interface OfferResponseDtccOnboardingReject */ -export interface OnboardingResponseDtccReject { +export interface OfferResponseDtccOnboardingReject { /** * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. * @type {string} - * @memberof OnboardingResponseDtccReject + * @memberof OfferResponseDtccOnboardingReject */ - 'responseType': OnboardingResponseDtccRejectResponseTypeEnum; + 'responseType': OfferResponseDtccOnboardingRejectResponseTypeEnum; /** - * Why the offer is being rejected. Recorded on-chain, where the counterparty can read it. - * @type {string} - * @memberof OnboardingResponseDtccReject + * + * @type {DtccOnboardingRejectPayload} + * @memberof OfferResponseDtccOnboardingReject */ - 'reason': string; + 'payload': DtccOnboardingRejectPayload; } -export const OnboardingResponseDtccRejectResponseTypeEnum = { +export const OfferResponseDtccOnboardingRejectResponseTypeEnum = { DtccEndInvestorOnboardingReject: 'DTCC_END_INVESTOR_ONBOARDING_REJECT' } as const; -export type OnboardingResponseDtccRejectResponseTypeEnum = typeof OnboardingResponseDtccRejectResponseTypeEnum[keyof typeof OnboardingResponseDtccRejectResponseTypeEnum]; +export type OfferResponseDtccOnboardingRejectResponseTypeEnum = typeof OfferResponseDtccOnboardingRejectResponseTypeEnum[keyof typeof OfferResponseDtccOnboardingRejectResponseTypeEnum]; diff --git a/models/offer-response-onboarding.ts b/models/offer-response-onboarding.ts deleted file mode 100644 index db9e607..0000000 --- a/models/offer-response-onboarding.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import { OnboardingResponse } from './onboarding-response'; - -/** - * - * @export - * @interface OfferResponseOnboarding - */ -export interface OfferResponseOnboarding { - /** - * Which offer domain this response belongs to. Selects the shape of `response`. - * @type {string} - * @memberof OfferResponseOnboarding - */ - 'domain': OfferResponseOnboardingDomainEnum; - /** - * - * @type {OnboardingResponse} - * @memberof OfferResponseOnboarding - */ - 'response': OnboardingResponse; -} - -export const OfferResponseOnboardingDomainEnum = { - Onboarding: 'ONBOARDING' -} as const; - -export type OfferResponseOnboardingDomainEnum = typeof OfferResponseOnboardingDomainEnum[keyof typeof OfferResponseOnboardingDomainEnum]; - - diff --git a/models/onboarding-response-tradeweb-accept.ts b/models/offer-response-tradeweb-accept.ts similarity index 76% rename from models/onboarding-response-tradeweb-accept.ts rename to models/offer-response-tradeweb-accept.ts index 57c2f14..cc623b0 100644 --- a/models/onboarding-response-tradeweb-accept.ts +++ b/models/offer-response-tradeweb-accept.ts @@ -17,21 +17,21 @@ /** * Accept a Tradeweb co-signing delegation offer. Carries no arguments. * @export - * @interface OnboardingResponseTradewebAccept + * @interface OfferResponseTradewebAccept */ -export interface OnboardingResponseTradewebAccept { +export interface OfferResponseTradewebAccept { /** * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. * @type {string} - * @memberof OnboardingResponseTradewebAccept + * @memberof OfferResponseTradewebAccept */ - 'responseType': OnboardingResponseTradewebAcceptResponseTypeEnum; + 'responseType': OfferResponseTradewebAcceptResponseTypeEnum; } -export const OnboardingResponseTradewebAcceptResponseTypeEnum = { +export const OfferResponseTradewebAcceptResponseTypeEnum = { TradewebCosigningDelegationAccept: 'TRADEWEB_COSIGNING_DELEGATION_ACCEPT' } as const; -export type OnboardingResponseTradewebAcceptResponseTypeEnum = typeof OnboardingResponseTradewebAcceptResponseTypeEnum[keyof typeof OnboardingResponseTradewebAcceptResponseTypeEnum]; +export type OfferResponseTradewebAcceptResponseTypeEnum = typeof OfferResponseTradewebAcceptResponseTypeEnum[keyof typeof OfferResponseTradewebAcceptResponseTypeEnum]; diff --git a/models/onboarding-response-tradeweb-reject.ts b/models/offer-response-tradeweb-reject.ts similarity index 77% rename from models/onboarding-response-tradeweb-reject.ts rename to models/offer-response-tradeweb-reject.ts index 3c3e93d..19ad913 100644 --- a/models/onboarding-response-tradeweb-reject.ts +++ b/models/offer-response-tradeweb-reject.ts @@ -17,21 +17,21 @@ /** * Reject a Tradeweb co-signing delegation offer. Carries no arguments — the DAR has nowhere on-ledger to record a reason, so none is accepted. * @export - * @interface OnboardingResponseTradewebReject + * @interface OfferResponseTradewebReject */ -export interface OnboardingResponseTradewebReject { +export interface OfferResponseTradewebReject { /** * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. * @type {string} - * @memberof OnboardingResponseTradewebReject + * @memberof OfferResponseTradewebReject */ - 'responseType': OnboardingResponseTradewebRejectResponseTypeEnum; + 'responseType': OfferResponseTradewebRejectResponseTypeEnum; } -export const OnboardingResponseTradewebRejectResponseTypeEnum = { +export const OfferResponseTradewebRejectResponseTypeEnum = { TradewebCosigningDelegationReject: 'TRADEWEB_COSIGNING_DELEGATION_REJECT' } as const; -export type OnboardingResponseTradewebRejectResponseTypeEnum = typeof OnboardingResponseTradewebRejectResponseTypeEnum[keyof typeof OnboardingResponseTradewebRejectResponseTypeEnum]; +export type OfferResponseTradewebRejectResponseTypeEnum = typeof OfferResponseTradewebRejectResponseTypeEnum[keyof typeof OfferResponseTradewebRejectResponseTypeEnum]; diff --git a/models/offer-response-transfer-accept.ts b/models/offer-response-transfer-accept.ts new file mode 100644 index 0000000..53fd48b --- /dev/null +++ b/models/offer-response-transfer-accept.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + + +/** + * Accept an inbound 2-step transfer offer. Carries no arguments. + * @export + * @interface OfferResponseTransferAccept + */ +export interface OfferResponseTransferAccept { + /** + * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. + * @type {string} + * @memberof OfferResponseTransferAccept + */ + 'responseType': OfferResponseTransferAcceptResponseTypeEnum; +} + +export const OfferResponseTransferAcceptResponseTypeEnum = { + TransferAccept: 'TRANSFER_ACCEPT' +} as const; + +export type OfferResponseTransferAcceptResponseTypeEnum = typeof OfferResponseTransferAcceptResponseTypeEnum[keyof typeof OfferResponseTransferAcceptResponseTypeEnum]; + + diff --git a/models/offer-response-transfer-reject.ts b/models/offer-response-transfer-reject.ts new file mode 100644 index 0000000..c5f9ba5 --- /dev/null +++ b/models/offer-response-transfer-reject.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + + +/** + * Reject an inbound 2-step transfer offer. Carries no arguments. + * @export + * @interface OfferResponseTransferReject + */ +export interface OfferResponseTransferReject { + /** + * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. + * @type {string} + * @memberof OfferResponseTransferReject + */ + 'responseType': OfferResponseTransferRejectResponseTypeEnum; +} + +export const OfferResponseTransferRejectResponseTypeEnum = { + TransferReject: 'TRANSFER_REJECT' +} as const; + +export type OfferResponseTransferRejectResponseTypeEnum = typeof OfferResponseTransferRejectResponseTypeEnum[keyof typeof OfferResponseTransferRejectResponseTypeEnum]; + + diff --git a/models/offer-response-transfer-withdraw.ts b/models/offer-response-transfer-withdraw.ts new file mode 100644 index 0000000..062b66d --- /dev/null +++ b/models/offer-response-transfer-withdraw.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + + +/** + * Withdraw your own OUTGOING transfer offer. Carries no arguments — `offerId` in the path is the offer, so the vault account and blockchain are resolved from it rather than restated. Was `CantonCallType.TRANSFER_WITHDRAW` with a 3-field payload until FA-10624. + * @export + * @interface OfferResponseTransferWithdraw + */ +export interface OfferResponseTransferWithdraw { + /** + * How you are answering the offer. Must be one of the values listed in the transaction\'s `cantonDetails.offerResponse.availableResponses` — TOP-LEVEL on the transaction, not nested under an `additionalInfo` envelope, which does not exist on `TransactionResponse`. `availableResponses` states what this offer TYPE accepts. It is set when the offer arrives and does not change, so it does NOT tell you whether the offer is still answerable — check `expiresAt` and the transaction\'s status for that, and expect this endpoint to be the authority: it re-checks state and expiry on every call and answers 409 when either has moved. + * @type {string} + * @memberof OfferResponseTransferWithdraw + */ + 'responseType': OfferResponseTransferWithdrawResponseTypeEnum; +} + +export const OfferResponseTransferWithdrawResponseTypeEnum = { + TransferWithdraw: 'TRANSFER_WITHDRAW' +} as const; + +export type OfferResponseTransferWithdrawResponseTypeEnum = typeof OfferResponseTransferWithdrawResponseTypeEnum[keyof typeof OfferResponseTransferWithdrawResponseTypeEnum]; + + diff --git a/models/offer-response-transfer.ts b/models/offer-response-transfer.ts deleted file mode 100644 index fed878c..0000000 --- a/models/offer-response-transfer.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import { TransferResponse } from './transfer-response'; - -/** - * - * @export - * @interface OfferResponseTransfer - */ -export interface OfferResponseTransfer { - /** - * Which offer domain this response belongs to. Selects the shape of `response`. - * @type {string} - * @memberof OfferResponseTransfer - */ - 'domain': OfferResponseTransferDomainEnum; - /** - * - * @type {TransferResponse} - * @memberof OfferResponseTransfer - */ - 'response': TransferResponse; -} - -export const OfferResponseTransferDomainEnum = { - Transfer: 'TRANSFER' -} as const; - -export type OfferResponseTransferDomainEnum = typeof OfferResponseTransferDomainEnum[keyof typeof OfferResponseTransferDomainEnum]; - - diff --git a/models/offer-response.ts b/models/offer-response.ts index 586077b..4ec3b95 100644 --- a/models/offer-response.ts +++ b/models/offer-response.ts @@ -15,21 +15,39 @@ // May contain unused imports in some cases // @ts-ignore -import { OfferResponseAllocation } from './offer-response-allocation'; +import { DtccOnboardingRejectPayload } from './dtcc-onboarding-reject-payload'; // May contain unused imports in some cases // @ts-ignore -import { OfferResponseOnboarding } from './offer-response-onboarding'; +import { OfferResponseAllocationAccept } from './offer-response-allocation-accept'; // May contain unused imports in some cases // @ts-ignore -import { OfferResponseTransfer } from './offer-response-transfer'; +import { OfferResponseAllocationReject } from './offer-response-allocation-reject'; // May contain unused imports in some cases // @ts-ignore -import { TransferResponse } from './transfer-response'; +import { OfferResponseDtccOnboardingAccept } from './offer-response-dtcc-onboarding-accept'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseDtccOnboardingReject } from './offer-response-dtcc-onboarding-reject'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseTradewebAccept } from './offer-response-tradeweb-accept'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseTradewebReject } from './offer-response-tradeweb-reject'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseTransferAccept } from './offer-response-transfer-accept'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseTransferReject } from './offer-response-transfer-reject'; +// May contain unused imports in some cases +// @ts-ignore +import { OfferResponseTransferWithdraw } from './offer-response-transfer-withdraw'; /** * @type OfferResponse * @export */ -export type OfferResponse = { domain: 'ALLOCATION' } & OfferResponseAllocation | { domain: 'ONBOARDING' } & OfferResponseOnboarding | { domain: 'TRANSFER' } & OfferResponseTransfer; +export type OfferResponse = { responseType: 'ALLOCATION_ACCEPT' } & OfferResponseAllocationAccept | { responseType: 'ALLOCATION_REJECT' } & OfferResponseAllocationReject | { responseType: 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT' } & OfferResponseDtccOnboardingAccept | { responseType: 'DTCC_END_INVESTOR_ONBOARDING_REJECT' } & OfferResponseDtccOnboardingReject | { responseType: 'TRADEWEB_COSIGNING_DELEGATION_ACCEPT' } & OfferResponseTradewebAccept | { responseType: 'TRADEWEB_COSIGNING_DELEGATION_REJECT' } & OfferResponseTradewebReject | { responseType: 'TRANSFER_ACCEPT' } & OfferResponseTransferAccept | { responseType: 'TRANSFER_REJECT' } & OfferResponseTransferReject | { responseType: 'TRANSFER_WITHDRAW' } & OfferResponseTransferWithdraw; diff --git a/models/onboarding-response.ts b/models/onboarding-response.ts deleted file mode 100644 index fad395f..0000000 --- a/models/onboarding-response.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import { OnboardingResponseDtccAccept } from './onboarding-response-dtcc-accept'; -// May contain unused imports in some cases -// @ts-ignore -import { OnboardingResponseDtccReject } from './onboarding-response-dtcc-reject'; -// May contain unused imports in some cases -// @ts-ignore -import { OnboardingResponseTradewebAccept } from './onboarding-response-tradeweb-accept'; -// May contain unused imports in some cases -// @ts-ignore -import { OnboardingResponseTradewebReject } from './onboarding-response-tradeweb-reject'; - -/** - * @type OnboardingResponse - * @export - */ -export type OnboardingResponse = { responseType: 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT' } & OnboardingResponseDtccAccept | { responseType: 'DTCC_END_INVESTOR_ONBOARDING_REJECT' } & OnboardingResponseDtccReject | { responseType: 'TRADEWEB_COSIGNING_DELEGATION_ACCEPT' } & OnboardingResponseTradewebAccept | { responseType: 'TRADEWEB_COSIGNING_DELEGATION_REJECT' } & OnboardingResponseTradewebReject; - - diff --git a/models/participant-onboarding-payload.ts b/models/participant-onboarding-payload.ts index 6d124f1..b3ba3d0 100644 --- a/models/participant-onboarding-payload.ts +++ b/models/participant-onboarding-payload.ts @@ -27,11 +27,11 @@ export interface ParticipantOnboardingPayload { */ 'vaultAccountId': string; /** - * Chain asset — CANTON or CANTON_TEST. + * The blockchain this party is connected to — `CANTON` or `CANTON_TEST`. * @type {string} * @memberof ParticipantOnboardingPayload */ - 'asset': ParticipantOnboardingPayloadAssetEnum; + 'blockchainId': ParticipantOnboardingPayloadBlockchainIdEnum; /** * DTCC infra operator party id. * @type {string} @@ -70,11 +70,11 @@ export interface ParticipantOnboardingPayload { 'expiresAt'?: string; } -export const ParticipantOnboardingPayloadAssetEnum = { +export const ParticipantOnboardingPayloadBlockchainIdEnum = { Canton: 'CANTON', CantonTest: 'CANTON_TEST' } as const; -export type ParticipantOnboardingPayloadAssetEnum = typeof ParticipantOnboardingPayloadAssetEnum[keyof typeof ParticipantOnboardingPayloadAssetEnum]; +export type ParticipantOnboardingPayloadBlockchainIdEnum = typeof ParticipantOnboardingPayloadBlockchainIdEnum[keyof typeof ParticipantOnboardingPayloadBlockchainIdEnum]; diff --git a/models/register-approval-api-key-response.ts b/models/register-approval-api-key-response.ts index 0d6df84..09eb39d 100644 --- a/models/register-approval-api-key-response.ts +++ b/models/register-approval-api-key-response.ts @@ -26,5 +26,11 @@ export interface RegisterApprovalApiKeyResponse { * @memberof RegisterApprovalApiKeyResponse */ 'keyId': string; + /** + * Always returned. An empty string when the key is active immediately. Otherwise, the ID of the approval request that must be approved before the key becomes active. The request appears in `GET /v1/approvals`. + * @type {string} + * @memberof RegisterApprovalApiKeyResponse + */ + 'ccrIdPendingRegistration': string; } diff --git a/models/tempo-transfer-destination-item.ts b/models/tempo-transfer-destination-item.ts new file mode 100644 index 0000000..bfe45cf --- /dev/null +++ b/models/tempo-transfer-destination-item.ts @@ -0,0 +1,51 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TempoTransferDestination } from './tempo-transfer-destination'; + +/** + * One destination in a multi-destination transfer. `destination.type` is narrowed the same way as the top-level `destination` field. + * @export + * @interface TempoTransferDestinationItem + */ +export interface TempoTransferDestinationItem { + /** + * The amount to transfer to this destination, as a numeric string. + * @type {string} + * @memberof TempoTransferDestinationItem + */ + 'amount'?: string; + /** + * + * @type {TempoTransferDestination} + * @memberof TempoTransferDestinationItem + */ + 'destination'?: TempoTransferDestination; + /** + * Beta. An identifier of a TravelRule message, already sent to the TravelRule provider. + * @type {string} + * @memberof TempoTransferDestinationItem + */ + 'travelRuleMessageId'?: string; + /** + * The ID for AML providers to associate the owner of funds with transactions. + * @type {string} + * @memberof TempoTransferDestinationItem + */ + 'customerRefId'?: string; +} + diff --git a/models/tempo-transfer-destination.ts b/models/tempo-transfer-destination.ts new file mode 100644 index 0000000..646a954 --- /dev/null +++ b/models/tempo-transfer-destination.ts @@ -0,0 +1,54 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { OneTimeAddress } from './one-time-address'; + +/** + * The transfer\'s destination. Mutually exclusive with `destinations`. + * @export + * @interface TempoTransferDestination + */ +export interface TempoTransferDestination { + /** + * The kind of destination. + * @type {string} + * @memberof TempoTransferDestination + */ + 'type': TempoTransferDestinationTypeEnum; + /** + * Required when type is VAULT_ACCOUNT or UNMANAGED_WALLET. + * @type {string} + * @memberof TempoTransferDestination + */ + 'id'?: string; + /** + * + * @type {OneTimeAddress} + * @memberof TempoTransferDestination + */ + 'oneTimeAddress'?: OneTimeAddress; +} + +export const TempoTransferDestinationTypeEnum = { + VaultAccount: 'VAULT_ACCOUNT', + OneTimeAddress: 'ONE_TIME_ADDRESS', + UnmanagedWallet: 'UNMANAGED_WALLET' +} as const; + +export type TempoTransferDestinationTypeEnum = typeof TempoTransferDestinationTypeEnum[keyof typeof TempoTransferDestinationTypeEnum]; + + diff --git a/models/transfer-withdraw-payload.ts b/models/tempo-transfer-source.ts similarity index 51% rename from models/transfer-withdraw-payload.ts rename to models/tempo-transfer-source.ts index 8330d3a..3aae520 100644 --- a/models/transfer-withdraw-payload.ts +++ b/models/tempo-transfer-source.ts @@ -15,36 +15,36 @@ /** - * + * The transfer\'s source. * @export - * @interface TransferWithdrawPayload + * @interface TempoTransferSource */ -export interface TransferWithdrawPayload { +export interface TempoTransferSource { /** - * The vault account whose Canton wallet acts here. + * The kind of source. * @type {string} - * @memberof TransferWithdrawPayload + * @memberof TempoTransferSource */ - 'vaultAccountId': string; + 'type': TempoTransferSourceTypeEnum; /** - * Chain asset — `CANTON` or `CANTON_TEST`. + * Required when type is VAULT_ACCOUNT — the vault account ID. * @type {string} - * @memberof TransferWithdrawPayload + * @memberof TempoTransferSource */ - 'asset': TransferWithdrawPayloadAssetEnum; + 'id'?: string; /** - * The Fireblocks transaction id of the OUTGOING transfer offer being withdrawn. + * Required when type is EMBEDDED_WALLET. * @type {string} - * @memberof TransferWithdrawPayload + * @memberof TempoTransferSource */ - 'offerTransactionId': string; + 'walletId'?: string; } -export const TransferWithdrawPayloadAssetEnum = { - Canton: 'CANTON', - CantonTest: 'CANTON_TEST' +export const TempoTransferSourceTypeEnum = { + VaultAccount: 'VAULT_ACCOUNT', + EmbeddedWallet: 'EMBEDDED_WALLET' } as const; -export type TransferWithdrawPayloadAssetEnum = typeof TransferWithdrawPayloadAssetEnum[keyof typeof TransferWithdrawPayloadAssetEnum]; +export type TempoTransferSourceTypeEnum = typeof TempoTransferSourceTypeEnum[keyof typeof TempoTransferSourceTypeEnum]; diff --git a/models/transfer-response-accept.ts b/models/transfer-response-accept.ts deleted file mode 100644 index b30c1f1..0000000 --- a/models/transfer-response-accept.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * 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. - */ - - - -/** - * Accept an inbound 2-step transfer offer. Carries no arguments. - * @export - * @interface TransferResponseAccept - */ -export interface TransferResponseAccept { - /** - * How you are answering the transfer offer. - * @type {string} - * @memberof TransferResponseAccept - */ - 'responseType': TransferResponseAcceptResponseTypeEnum; -} - -export const TransferResponseAcceptResponseTypeEnum = { - TransferAccept: 'TRANSFER_ACCEPT' -} as const; - -export type TransferResponseAcceptResponseTypeEnum = typeof TransferResponseAcceptResponseTypeEnum[keyof typeof TransferResponseAcceptResponseTypeEnum]; - - diff --git a/package-lock.json b/package-lock.json index f2a6a5c..e6e1f52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@fireblocks/ts-sdk", - "version": "33.0.0", + "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@fireblocks/ts-sdk", - "version": "33.0.0", + "version": "0.0.0", "license": "MIT License", "dependencies": { "axios": "^1.15.2", @@ -1294,9 +1294,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.11.21", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.21.tgz", - "integrity": "sha512-uh8vpY/1/YyFkunIDFH/12p7/7VdPKA1hejMVEbdkEaWnUz0Hesvx5EbiU6XxjyHZIOju+ZMbQJkRh+es3/spQ==", + "version": "2.11.24", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.24.tgz", + "integrity": "sha512-hYrgxie335U08WqICoGqKRzV1HFXv6zdxwJE4ekCb80CM9a0SVVsN4QPwT67RraRo+9h8IATk6uxHJw7QSkdOg==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1307,9 +1307,9 @@ } }, "node_modules/brace-expansion": { - "version": "1.1.20", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.20.tgz", - "integrity": "sha512-5/qk29RyvatwgzNMrvGjkIhKYzpJ0OUnPK+9TU+zS/CMJqzmb+UD0irWu42JfpUvO636fxd8IstgiydZRM/76A==", + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.21.tgz", + "integrity": "sha512-9zeA+KLZNNzglF2TPKRQEDyx6Yby7daAkuy8MiPzpXPsYDWi/DRM8jmwUDxokQjYqBpv5DgPiwD4h4ZZSy1Ujw==", "dev": true, "license": "MIT", "dependencies": { @@ -1331,9 +1331,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.9", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.9.tgz", - "integrity": "sha512-EWazOblFYUvlGZcfGhPUPmYh3nikUxBVb+y9MJun5f3hBi812X+8MSQTujLBtgK3cf51fJWbWfOjyeO954d+Eg==", + "version": "4.29.0", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.29.0.tgz", + "integrity": "sha512-3GSvyjvDI4Dur1Meg2BekJquu5uF+9R9a1+5M1Mde192eZoXbeXjzgOsgqPS2V8D5wrrip0gR5Hf/GhWQ9ZzaA==", "dev": true, "funding": [ { @@ -1351,11 +1351,11 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.11.20", + "baseline-browser-mapping": "^2.11.23", "caniuse-lite": "^1.0.30001810", - "electron-to-chromium": "^1.5.420", - "node-releases": "^2.0.54", - "update-browserslist-db": "^1.3.2" + "electron-to-chromium": "^1.5.427", + "node-releases": "^2.0.55", + "update-browserslist-db": "^1.3.3" }, "bin": { "browserslist": "cli.js" @@ -1715,9 +1715,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.425", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.425.tgz", - "integrity": "sha512-QvPtl41EUOnuT1HBvMKgxXRIaHNcagBPs50u7VULzhZXaGfqTbZyE16LQsctZ/RQHlGu+FOWeDTR4mY6YbeF1g==", + "version": "1.5.429", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.429.tgz", + "integrity": "sha512-/1ENIE3cx4HTIx4IfPZFaOunJmsrSVTnj6coXoRVbiJUbkeTyFkJvBeWGkdgh08OhFbxYLMT1kbkwFVSarq6Ow==", "dev": true, "license": "ISC" }, @@ -4078,9 +4078,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.2.tgz", - "integrity": "sha512-UQ+MSxlhRm1bzjhU+DcuXfjFO1FzNtqhK5+9Yvlp90ItDLk5vT932A0rFu619nf7RVS+Y/VeaUW1jaRDqZ8VJw==", + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.3.tgz", + "integrity": "sha512-pJ2sYawQS0R/WI928Gj5GlPhTGzbMelq0+4INtSYNDV9ErKJcX6xjGWkoG/VnB3dpUm00zALaqkrUD77pO5TDQ==", "dev": true, "funding": [ { diff --git a/package.json b/package.json index 27495f1..584251d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fireblocks/ts-sdk", - "version": "33.0.0", + "version": "0.0.0", "description": "OpenAPI client for @fireblocks/ts-sdk", "author": "Fireblocks SDK Generator", "repository": { diff --git a/tests/client.spec.ts b/tests/client.spec.ts index 3681582..714605c 100644 --- a/tests/client.spec.ts +++ b/tests/client.spec.ts @@ -53,6 +53,7 @@ SmartTransferApi, StakingApi, TRLinkApi, TagsApi, +TempoBetaApi, TokenizationApi, TradingBetaApi, TransactionsApi, @@ -114,6 +115,7 @@ let mockSmartTransferApi: jest.Mock; let mockStakingApi: jest.Mock; let mockTRLinkApi: jest.Mock; let mockTagsApi: jest.Mock; +let mockTempoBetaApi: jest.Mock; let mockTokenizationApi: jest.Mock; let mockTradingBetaApi: jest.Mock; let mockTransactionsApi: jest.Mock; @@ -172,6 +174,7 @@ jest.mock('../api', () => { mockStakingApi = jest.fn(); mockTRLinkApi = jest.fn(); mockTagsApi = jest.fn(); + mockTempoBetaApi = jest.fn(); mockTokenizationApi = jest.fn(); mockTradingBetaApi = jest.fn(); mockTransactionsApi = jest.fn(); @@ -231,6 +234,7 @@ jest.mock('../api', () => { StakingApi: mockStakingApi, TRLinkApi: mockTRLinkApi, TagsApi: mockTagsApi, + TempoBetaApi: mockTempoBetaApi, TokenizationApi: mockTokenizationApi, TradingBetaApi: mockTradingBetaApi, TransactionsApi: mockTransactionsApi, @@ -492,6 +496,10 @@ describe("Fireblocks Client Tests", () => { expect(fireblocks.tags).toBeInstanceOf(TagsApi); expect(mockTagsApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); + it('Should return TempoBetaApi', async () => { + expect(fireblocks.tempoBeta).toBeInstanceOf(TempoBetaApi); + expect(mockTempoBetaApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); + }); it('Should return TokenizationApi', async () => { expect(fireblocks.tokenization).toBeInstanceOf(TokenizationApi); expect(mockTokenizationApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios);