From e63ede5e6d706d9ddb07bd895be30e2ce6790b14 Mon Sep 17 00:00:00 2001 From: fireblocks_dx_team Date: Thu, 11 Jun 2026 13:37:01 +0000 Subject: [PATCH] Generated SDK #5364 --- .openapi-generator/FILES | 54 + CHANGELOG.md | 258 -- README.md | 45 + api/connected-accounts-beta-api.ts | 396 +++ api/onchain-data-api.ts | 36 +- api/staking-api.ts | 132 + api/tokenization-api.ts | 2136 ++++++++++++++--- api/trading-beta-api.ts | 321 +++ api/transactions-api.ts | 5 +- api/webhooks-v2-api.ts | 64 + docs/apis/ConnectedAccountsBetaApi.md | 215 ++ docs/apis/OnchainDataApi.md | 48 +- docs/apis/StakingApi.md | 75 + docs/apis/TokenizationApi.md | 732 ++++++ docs/apis/TradingBetaApi.md | 218 ++ docs/apis/TransactionsApi.md | 4 +- docs/apis/WebhooksV2Api.md | 55 + .../AccessRegistryCurrentStateResponse2.md | 15 + docs/models/ActiveRolesMap.md | 11 + docs/models/ActiveRolesResponse.md | 1 + docs/models/ActiveRolesResponse2.md | 11 + docs/models/AddressBalancePagedResponse2.md | 15 + docs/models/AllowlistEntry.md | 21 + docs/models/AllowlistEntryProviderMetadata.md | 11 + docs/models/AllowlistEntryStatus.md | 20 + docs/models/AllowlistMetadata.md | 26 + docs/models/AllowlistResponse.md | 15 + docs/models/BalanceHistoryPagedResponse2.md | 15 + docs/models/BusinessIdentification.md | 2 + docs/models/ConnectedAccount.md | 3 + docs/models/ConnectedAccountType.md | 14 + docs/models/ConnectedSingleAccountResponse.md | 3 + docs/models/CreateWebhookRequest.md | 1 + docs/models/Identification.md | 12 +- docs/models/Offer.md | 2 +- .../OnchainTransactionsPagedResponse2.md | 15 + docs/models/OnchainTransferEvent.md | 24 + docs/models/OnchainTransfersPagedResponse.md | 15 + .../models/OrderRequirementAllowedFileType.md | 28 + docs/models/OrderRequirementDetails.md | 15 + docs/models/OrderRequirementFile.md | 14 + docs/models/OrderStatus.md | 2 + docs/models/PersonalIdentification.md | 10 +- docs/models/PersonalIdentificationDocument.md | 14 + docs/models/PositionRelatedTransaction.md | 56 + docs/models/Quote.md | 2 +- docs/models/QuoteOffer.md | 2 +- docs/models/RoleDetails2.md | 14 + .../ScreeningTRLinkMissingTrmDecision.md | 4 +- docs/models/ScreeningTRLinkMissingTrmRule.md | 4 +- .../ScreeningTRLinkPostScreeningRule.md | 4 +- .../models/ScreeningTRLinkPrescreeningRule.md | 4 +- docs/models/ScreeningTRLinkRuleBase.md | 4 +- .../ScreeningTravelRulePrescreeningRule.md | 6 +- ...ionRelatedTransactionsPaginatedResponse.md | 13 + docs/models/SubmitOrderRequirementRequest.md | 12 + docs/models/TotalSupplyPagedResponse2.md | 15 + docs/models/TransactionConfigurations.md | 12 + docs/models/TransactionRequest.md | 2 +- docs/models/TransferPeerPathType.md | 2 + docs/models/TransferPeerTypeEnum.md | 2 + docs/models/TransferPeerTypeEnum2.md | 36 + docs/models/UpdateWebhookRequest.md | 1 + docs/models/Webhook.md | 1 + docs/models/WebhookMtls.md | 12 + docs/models/WebhookMtlsCsrResponse.md | 12 + ...access-registry-current-state-response2.ts | 51 + models/active-roles-map.ts | 29 + models/active-roles-response.ts | 12 +- models/active-roles-response2.ts | 29 + models/address-balance-paged-response2.ts | 51 + models/allowlist-entry-provider-metadata.ts | 26 + models/allowlist-entry-status.ts | 35 + models/allowlist-entry.ts | 92 + models/allowlist-metadata.ts | 46 + models/allowlist-response.ts | 54 + models/balance-history-paged-response2.ts | 51 + models/business-identification.ts | 12 + models/connected-account-type.ts | 32 + models/connected-account.ts | 21 + models/connected-single-account-response.ts | 3 + models/create-webhook-request.ts | 9 + models/identification.ts | 3 + models/index.ts | 27 + .../onchain-transactions-paged-response2.ts | 51 + models/onchain-transfer-event.ts | 102 + models/onchain-transfers-paged-response.ts | 51 + models/order-requirement-allowed-file-type.ts | 39 + models/order-requirement-details.ts | 51 + models/order-requirement-file.ts | 45 + models/order-status.ts | 1 + models/personal-identification-document.ts | 47 + models/personal-identification.ts | 27 +- models/position-related-transaction.ts | 90 + models/quote.ts | 2 +- models/role-details2.ts | 45 + ...screening-travel-rule-prescreening-rule.ts | 14 +- .../screening-trlink-missing-trm-decision.ts | 2 +- models/screening-trlink-missing-trm-rule.ts | 2 +- .../screening-trlink-post-screening-rule.ts | 2 +- models/screening-trlink-prescreening-rule.ts | 2 +- models/screening-trlink-rule-base.ts | 10 +- ...related-transactions-paginated-response.ts | 39 + models/submit-order-requirement-request.ts | 30 + models/total-supply-paged-response2.ts | 51 + models/transaction-configurations.ts | 30 + models/transaction-request.ts | 9 +- models/transfer-peer-path-type.ts | 3 +- models/transfer-peer-type-enum.ts | 3 +- models/transfer-peer-type-enum2.ts | 43 + models/update-webhook-request.ts | 9 + models/webhook-mtls-csr-response.ts | 30 + models/webhook-mtls.ts | 30 + models/webhook.ts | 9 + package-lock.json | 96 +- package.json | 2 +- 116 files changed, 6167 insertions(+), 732 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 docs/models/AccessRegistryCurrentStateResponse2.md create mode 100644 docs/models/ActiveRolesMap.md create mode 100644 docs/models/ActiveRolesResponse2.md create mode 100644 docs/models/AddressBalancePagedResponse2.md create mode 100644 docs/models/AllowlistEntry.md create mode 100644 docs/models/AllowlistEntryProviderMetadata.md create mode 100644 docs/models/AllowlistEntryStatus.md create mode 100644 docs/models/AllowlistMetadata.md create mode 100644 docs/models/AllowlistResponse.md create mode 100644 docs/models/BalanceHistoryPagedResponse2.md create mode 100644 docs/models/ConnectedAccountType.md create mode 100644 docs/models/OnchainTransactionsPagedResponse2.md create mode 100644 docs/models/OnchainTransferEvent.md create mode 100644 docs/models/OnchainTransfersPagedResponse.md create mode 100644 docs/models/OrderRequirementAllowedFileType.md create mode 100644 docs/models/OrderRequirementDetails.md create mode 100644 docs/models/OrderRequirementFile.md create mode 100644 docs/models/PersonalIdentificationDocument.md create mode 100644 docs/models/PositionRelatedTransaction.md create mode 100644 docs/models/RoleDetails2.md create mode 100644 docs/models/StakingPositionRelatedTransactionsPaginatedResponse.md create mode 100644 docs/models/SubmitOrderRequirementRequest.md create mode 100644 docs/models/TotalSupplyPagedResponse2.md create mode 100644 docs/models/TransactionConfigurations.md create mode 100644 docs/models/TransferPeerTypeEnum2.md create mode 100644 docs/models/WebhookMtls.md create mode 100644 docs/models/WebhookMtlsCsrResponse.md create mode 100644 models/access-registry-current-state-response2.ts create mode 100644 models/active-roles-map.ts create mode 100644 models/active-roles-response2.ts create mode 100644 models/address-balance-paged-response2.ts create mode 100644 models/allowlist-entry-provider-metadata.ts create mode 100644 models/allowlist-entry-status.ts create mode 100644 models/allowlist-entry.ts create mode 100644 models/allowlist-metadata.ts create mode 100644 models/allowlist-response.ts create mode 100644 models/balance-history-paged-response2.ts create mode 100644 models/connected-account-type.ts create mode 100644 models/onchain-transactions-paged-response2.ts create mode 100644 models/onchain-transfer-event.ts create mode 100644 models/onchain-transfers-paged-response.ts create mode 100644 models/order-requirement-allowed-file-type.ts create mode 100644 models/order-requirement-details.ts create mode 100644 models/order-requirement-file.ts create mode 100644 models/personal-identification-document.ts create mode 100644 models/position-related-transaction.ts create mode 100644 models/role-details2.ts create mode 100644 models/staking-position-related-transactions-paginated-response.ts create mode 100644 models/submit-order-requirement-request.ts create mode 100644 models/total-supply-paged-response2.ts create mode 100644 models/transaction-configurations.ts create mode 100644 models/transfer-peer-type-enum2.ts create mode 100644 models/webhook-mtls-csr-response.ts create mode 100644 models/webhook-mtls.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index ccf6bf51..df2aa578 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -7,6 +7,7 @@ AbaPaymentInfo.md AbiFunction.md AccessRegistryAddressItem.md AccessRegistryCurrentStateResponse.md +AccessRegistryCurrentStateResponse2.md AccessRegistrySummaryResponse.md AccessType.md Account.md @@ -25,7 +26,9 @@ AchAddress.md AchDestination.md AchPaymentInfo.md ActionRecord.md +ActiveRolesMap.md ActiveRolesResponse.md +ActiveRolesResponse2.md AdapterProcessingResult.md AddAbiRequestDto.md AddAssetToExternalWalletRequest.md @@ -40,6 +43,7 @@ AdditionalInfoRequest.md AdditionalInfoRequestAdditionalInfo.md AddressBalanceItemDto.md AddressBalancePagedResponse.md +AddressBalancePagedResponse2.md AddressNotAvailableError.md AddressRegistryAddVaultOptOutsRequest.md AddressRegistryAddVaultOptOutsRequestVaultAccountIdsInner.md @@ -57,6 +61,11 @@ AddressRegistryVaultOptOutItem.md AddressReverseLookupResponse.md AlertExposureTypeEnum.md AlertLevelEnum.md +AllowlistEntry.md +AllowlistEntryProviderMetadata.md +AllowlistEntryStatus.md +AllowlistMetadata.md +AllowlistResponse.md AmlAlert.md AmlMatchedRule.md AmlRegistrationResult.md @@ -124,6 +133,7 @@ AuthorizationGroups.md AuthorizationInfo.md BalanceHistoryItemDto.md BalanceHistoryPagedResponse.md +BalanceHistoryPagedResponse2.md BankAddress.md BaseProvider.md BasicAddressRequest.md @@ -199,6 +209,7 @@ ConnectedAccountTotalBalance.md ConnectedAccountTradingPair.md ConnectedAccountTradingPairSupportedType.md ConnectedAccountTradingPairsResponse.md +ConnectedAccountType.md ConnectedAccountsBetaApi.md ConnectedAccountsResponse.md ConnectedSingleAccount.md @@ -612,6 +623,9 @@ OffersResponse.md OnchainDataApi.md OnchainTransaction.md OnchainTransactionsPagedResponse.md +OnchainTransactionsPagedResponse2.md +OnchainTransferEvent.md +OnchainTransfersPagedResponse.md OneTimeAddress.md OneTimeAddressAccount.md OneTimeAddressPeerType.md @@ -620,6 +634,9 @@ OperationExecutionFailure.md Opportunity.md OrderDetails.md OrderExecutionStep.md +OrderRequirementAllowedFileType.md +OrderRequirementDetails.md +OrderRequirementFile.md OrderSide.md OrderStatus.md OrderSummary.md @@ -662,6 +679,7 @@ PeerAdapterInfo.md PeerType.md PersonalEntityTypeEnum.md PersonalIdentification.md +PersonalIdentificationDocument.md PersonalIdentificationFullName.md PersonalIdentificationType.md PixAddress.md @@ -691,6 +709,7 @@ PolicyVerdictActionEnum.md PolicyVerdictActionEnum2.md Position.md Position2.md +PositionRelatedTransaction.md PostalAddress.md PreScreening.md PrefundedSettlement.md @@ -756,6 +775,7 @@ RetryRequoteTypeEnum.md RewardInfo.md RewardsInfo.md RoleDetails.md +RoleDetails2.md RoleGrantee.md SEPAAddress.md SEPADestination.md @@ -882,10 +902,12 @@ StakingGetAllDelegationsResponse.md StakingGetChainsResponse.md StakingGetProvidersResponse.md StakingGetSummaryByVaultResponse.md +StakingPositionRelatedTransactionsPaginatedResponse.md StakingPositionsPaginatedResponse.md StakingProvider.md Status.md StellarRippleCreateParamsDto.md +SubmitOrderRequirementRequest.md SupportedBlockChainsResponse.md SupportedBlockchain.md SwiftAddress.md @@ -1012,11 +1034,13 @@ TokenizationApi.md TokensPaginatedResponse.md TotalSupplyItemDto.md TotalSupplyPagedResponse.md +TotalSupplyPagedResponse2.md TradingAccountType.md TradingBetaApi.md TradingErrorSchema.md TradingProvider.md Transaction.md +TransactionConfigurations.md TransactionDirection.md TransactionFee.md TransactionOperation.md @@ -1050,6 +1074,7 @@ TransferPeerPathSubType.md TransferPeerPathType.md TransferPeerSubTypeEnum.md TransferPeerTypeEnum.md +TransferPeerTypeEnum2.md TransferRail.md TransferReceipt.md TransferValidationFailure.md @@ -1171,6 +1196,8 @@ Web3ConnectionsApi.md Webhook.md WebhookEvent.md WebhookMetric.md +WebhookMtls.md +WebhookMtlsCsrResponse.md WebhookPaginatedResponse.md WebhooksApi.md WebhooksV2Api.md @@ -1248,6 +1275,7 @@ models/aba-payment-info.ts models/abi-function.ts models/access-registry-address-item.ts models/access-registry-current-state-response.ts +models/access-registry-current-state-response2.ts models/access-registry-summary-response.ts models/access-type.ts models/account-access.ts @@ -1266,7 +1294,9 @@ models/ach-address.ts models/ach-destination.ts models/ach-payment-info.ts models/action-record.ts +models/active-roles-map.ts models/active-roles-response.ts +models/active-roles-response2.ts models/adapter-processing-result.ts models/add-abi-request-dto.ts models/add-asset-to-external-wallet-request.ts @@ -1281,6 +1311,7 @@ models/additional-info-request.ts models/additional-info.ts models/address-balance-item-dto.ts models/address-balance-paged-response.ts +models/address-balance-paged-response2.ts models/address-not-available-error.ts models/address-registry-add-vault-opt-outs-request-vault-account-ids-inner.ts models/address-registry-add-vault-opt-outs-request.ts @@ -1298,6 +1329,11 @@ models/address-registry-vault-opt-out-item.ts models/address-reverse-lookup-response.ts models/alert-exposure-type-enum.ts models/alert-level-enum.ts +models/allowlist-entry-provider-metadata.ts +models/allowlist-entry-status.ts +models/allowlist-entry.ts +models/allowlist-metadata.ts +models/allowlist-response.ts models/aml-alert.ts models/aml-matched-rule.ts models/aml-registration-result-full-payload.ts @@ -1365,6 +1401,7 @@ models/authorization-groups.ts models/authorization-info.ts models/balance-history-item-dto.ts models/balance-history-paged-response.ts +models/balance-history-paged-response2.ts models/bank-address.ts models/base-provider.ts models/basic-address-request.ts @@ -1436,6 +1473,7 @@ models/connected-account-total-balance.ts models/connected-account-trading-pair-supported-type.ts models/connected-account-trading-pair.ts models/connected-account-trading-pairs-response.ts +models/connected-account-type.ts models/connected-account.ts models/connected-accounts-response.ts models/connected-single-account-response.ts @@ -1828,6 +1866,9 @@ models/offer.ts models/offers-response.ts models/onchain-transaction.ts models/onchain-transactions-paged-response.ts +models/onchain-transactions-paged-response2.ts +models/onchain-transfer-event.ts +models/onchain-transfers-paged-response.ts models/one-time-address-account.ts models/one-time-address-peer-type.ts models/one-time-address-reference.ts @@ -1836,6 +1877,9 @@ models/operation-execution-failure.ts models/opportunity.ts models/order-details.ts models/order-execution-step.ts +models/order-requirement-allowed-file-type.ts +models/order-requirement-details.ts +models/order-requirement-file.ts models/order-side.ts models/order-status.ts models/order-summary.ts @@ -1876,6 +1920,7 @@ models/payout-status.ts models/peer-adapter-info.ts models/peer-type.ts models/personal-entity-type-enum.ts +models/personal-identification-document.ts models/personal-identification-full-name.ts models/personal-identification-type.ts models/personal-identification.ts @@ -1902,6 +1947,7 @@ models/policy-user-ids.ts models/policy-validation.ts models/policy-verdict-action-enum.ts models/policy-verdict-action-enum2.ts +models/position-related-transaction.ts models/position.ts models/position2.ts models/postal-address.ts @@ -1967,6 +2013,7 @@ models/retry-requote-type-enum.ts models/reward-info.ts models/rewards-info.ts models/role-details.ts +models/role-details2.ts models/role-grantee.ts models/scope-item-failure.ts models/scope-item.ts @@ -2091,10 +2138,12 @@ models/staking-get-all-delegations-response.ts models/staking-get-chains-response.ts models/staking-get-providers-response.ts models/staking-get-summary-by-vault-response.ts +models/staking-position-related-transactions-paginated-response.ts models/staking-positions-paginated-response.ts models/staking-provider.ts models/status.ts models/stellar-ripple-create-params-dto.ts +models/submit-order-requirement-request.ts models/supported-block-chains-response.ts models/supported-blockchain.ts models/swift-address.ts @@ -2125,9 +2174,11 @@ models/token-response.ts models/tokens-paginated-response.ts models/total-supply-item-dto.ts models/total-supply-paged-response.ts +models/total-supply-paged-response2.ts models/trading-account-type.ts models/trading-error-schema.ts models/trading-provider.ts +models/transaction-configurations.ts models/transaction-direction.ts models/transaction-fee.ts models/transaction-operation-enum.ts @@ -2161,6 +2212,7 @@ models/transfer-peer-path-sub-type.ts models/transfer-peer-path-type.ts models/transfer-peer-sub-type-enum.ts models/transfer-peer-type-enum.ts +models/transfer-peer-type-enum2.ts models/transfer-rail.ts models/transfer-receipt.ts models/transfer-validation-failure.ts @@ -2368,6 +2420,8 @@ models/wallet-asset-additional-info.ts models/wallet-asset.ts models/webhook-event.ts models/webhook-metric.ts +models/webhook-mtls-csr-response.ts +models/webhook-mtls.ts models/webhook-paginated-response.ts models/webhook.ts models/withdraw-request.ts diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 51130747..00000000 --- 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). - -## [v20.0.0](https://github.com/fireblocks/ts-sdk/compare/v19.0.0...v20.0.0) - 2026-06-02 - -### Merged - -- Generated SDK #2839 (major) [`#185`](https://github.com/fireblocks/ts-sdk/pull/185) - -## [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 39274cd2..03663092 100644 --- a/README.md +++ b/README.md @@ -179,11 +179,14 @@ Class | Method | HTTP request | Description *ComplianceScreeningConfigurationApi* | [**getScreeningConfiguration**](docs/apis/ComplianceScreeningConfigurationApi.md#getScreeningConfiguration) | **GET** /screening/travel_rule/policy_configuration | Get Travel Rule Screening Policy Configuration *ConnectedAccountsBetaApi* | [**disconnectConnectedAccount**](docs/apis/ConnectedAccountsBetaApi.md#disconnectConnectedAccount) | **DELETE** /connected_accounts/{accountId} | Disconnect connected account *ConnectedAccountsBetaApi* | [**getConnectedAccount**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccount) | **GET** /connected_accounts/{accountId} | Get connected account +*ConnectedAccountsBetaApi* | [**getConnectedAccountAllowlist**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccountAllowlist) | **GET** /connected_accounts/{accountId}/allowlist | Get allowlist for connected account +*ConnectedAccountsBetaApi* | [**getConnectedAccountAllowlistEntry**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccountAllowlistEntry) | **GET** /connected_accounts/{accountId}/allowlist/{allowlistId} | Get a single allowlist entry for a connected account *ConnectedAccountsBetaApi* | [**getConnectedAccountBalances**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccountBalances) | **GET** /connected_accounts/{accountId}/balances | Get balances for an account *ConnectedAccountsBetaApi* | [**getConnectedAccountRates**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccountRates) | **GET** /connected_accounts/{accountId}/rates | Get exchange rates for an account *ConnectedAccountsBetaApi* | [**getConnectedAccountTradingPairs**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccountTradingPairs) | **GET** /connected_accounts/{accountId}/manifest/capabilities/trading/pairs | Get supported trading pairs for an account *ConnectedAccountsBetaApi* | [**getConnectedAccounts**](docs/apis/ConnectedAccountsBetaApi.md#getConnectedAccounts) | **GET** /connected_accounts | Get connected accounts *ConnectedAccountsBetaApi* | [**renameConnectedAccount**](docs/apis/ConnectedAccountsBetaApi.md#renameConnectedAccount) | **POST** /connected_accounts/{accountId}/rename | Rename Connected Account +*ConnectedAccountsBetaApi* | [**syncConnectedAccountAllowlist**](docs/apis/ConnectedAccountsBetaApi.md#syncConnectedAccountAllowlist) | **POST** /connected_accounts/{accountId}/allowlist/sync | Sync allowlist for connected account *ConsoleUserApi* | [**createConsoleUser**](docs/apis/ConsoleUserApi.md#createConsoleUser) | **POST** /management/users | Create console user *ConsoleUserApi* | [**getConsoleUsers**](docs/apis/ConsoleUserApi.md#getConsoleUsers) | **GET** /management/users | Get console users *ContractInteractionsApi* | [**decodeContractData**](docs/apis/ContractInteractionsApi.md#decodeContractData) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode | Decode a function call data, error, or event log @@ -375,6 +378,7 @@ Class | Method | HTTP request | Description *StakingApi* | [**getChainInfo**](docs/apis/StakingApi.md#getChainInfo) | **GET** /staking/chains/{chainDescriptor}/chainInfo | Get chain-level staking parameters *StakingApi* | [**getChains**](docs/apis/StakingApi.md#getChains) | **GET** /staking/chains | List supported staking chains *StakingApi* | [**getDelegationById**](docs/apis/StakingApi.md#getDelegationById) | **GET** /staking/positions/{id} | Get position details +*StakingApi* | [**getPositionRelatedTransactions**](docs/apis/StakingApi.md#getPositionRelatedTransactions) | **GET** /staking/positions/{id}/related_transactions | List related transactions for a position *StakingApi* | [**getPositions**](docs/apis/StakingApi.md#getPositions) | **GET** /staking/positions_paginated | List staking positions (Paginated) *StakingApi* | [**getProviders**](docs/apis/StakingApi.md#getProviders) | **GET** /staking/providers | List staking providers *StakingApi* | [**getSummary**](docs/apis/StakingApi.md#getSummary) | **GET** /staking/positions/summary | Get positions summary @@ -432,6 +436,16 @@ Class | Method | HTTP request | Description *TokenizationApi* | [**getLinkedToken**](docs/apis/TokenizationApi.md#getLinkedToken) | **GET** /tokenization/tokens/{id} | Return a linked token *TokenizationApi* | [**getLinkedTokens**](docs/apis/TokenizationApi.md#getLinkedTokens) | **GET** /tokenization/tokens | List all linked tokens *TokenizationApi* | [**getLinkedTokensCount**](docs/apis/TokenizationApi.md#getLinkedTokensCount) | **GET** /tokenization/tokens/count | Get the total count of linked tokens +*TokenizationApi* | [**getTokenAccessRegistryAddresses**](docs/apis/TokenizationApi.md#getTokenAccessRegistryAddresses) | **GET** /tokenization/access_registries/{id}/addresses | Get current state of addresses in an access registry +*TokenizationApi* | [**getTokenAccessRegistrySummary**](docs/apis/TokenizationApi.md#getTokenAccessRegistrySummary) | **GET** /tokenization/access_registries/{id}/summary | Get summary of an access registry +*TokenizationApi* | [**getTokenBalanceForAccount**](docs/apis/TokenizationApi.md#getTokenBalanceForAccount) | **GET** /tokenization/tokens/{id}/balances/{accountAddress} | Get the latest balance for a specific account +*TokenizationApi* | [**getTokenBalanceHistory**](docs/apis/TokenizationApi.md#getTokenBalanceHistory) | **GET** /tokenization/tokens/{id}/balances/{accountAddress}/history | Get balance history for a specific account +*TokenizationApi* | [**getTokenBalances**](docs/apis/TokenizationApi.md#getTokenBalances) | **GET** /tokenization/tokens/{id}/balances | Get latest balances for all holders of a token +*TokenizationApi* | [**getTokenContractSummary**](docs/apis/TokenizationApi.md#getTokenContractSummary) | **GET** /tokenization/tokens/{id}/summary | Get onchain summary for a token +*TokenizationApi* | [**getTokenRbac**](docs/apis/TokenizationApi.md#getTokenRbac) | **GET** /tokenization/tokens/{id}/rbac | Get active RBAC roles for a token +*TokenizationApi* | [**getTokenTotalSupply**](docs/apis/TokenizationApi.md#getTokenTotalSupply) | **GET** /tokenization/tokens/{id}/total_supply | Get historical total supply for a token +*TokenizationApi* | [**getTokenTransactions**](docs/apis/TokenizationApi.md#getTokenTransactions) | **GET** /tokenization/tokens/{id}/transactions | Get onchain transactions for a token +*TokenizationApi* | [**getTokenTransfers**](docs/apis/TokenizationApi.md#getTokenTransfers) | **GET** /tokenization/tokens/{id}/transfers | Get onchain transfers for a token *TokenizationApi* | [**issueNewToken**](docs/apis/TokenizationApi.md#issueNewToken) | **POST** /tokenization/tokens | Issue a new token *TokenizationApi* | [**issueTokenMultiChain**](docs/apis/TokenizationApi.md#issueTokenMultiChain) | **POST** /tokenization/multichain/tokens | Issue a token on one or more blockchains *TokenizationApi* | [**link**](docs/apis/TokenizationApi.md#link) | **POST** /tokenization/tokens/link | Link a contract @@ -448,9 +462,12 @@ Class | Method | HTTP request | Description *TradingBetaApi* | [**fetchAllOffers**](docs/apis/TradingBetaApi.md#fetchAllOffers) | **POST** /trading/offers | Get all offers *TradingBetaApi* | [**fetchRates**](docs/apis/TradingBetaApi.md#fetchRates) | **POST** /trading/rates | Get rates *TradingBetaApi* | [**getOrder**](docs/apis/TradingBetaApi.md#getOrder) | **GET** /trading/orders/{orderId} | Get order details +*TradingBetaApi* | [**getOrderRequirements**](docs/apis/TradingBetaApi.md#getOrderRequirements) | **GET** /trading/orders/{orderId}/requirement | Get order requirement details for an order *TradingBetaApi* | [**getOrders**](docs/apis/TradingBetaApi.md#getOrders) | **GET** /trading/orders | Get orders *TradingBetaApi* | [**getTradingProviderById**](docs/apis/TradingBetaApi.md#getTradingProviderById) | **GET** /trading/providers/{providerId} | Get trading provider by ID *TradingBetaApi* | [**getTradingProviders**](docs/apis/TradingBetaApi.md#getTradingProviders) | **GET** /trading/providers | Get providers +*TradingBetaApi* | [**submitOrderRequirements**](docs/apis/TradingBetaApi.md#submitOrderRequirements) | **POST** /trading/orders/{orderId}/requirement/data | Submit a response to an order requirement +*TradingBetaApi* | [**uploadOrderRequirementFile**](docs/apis/TradingBetaApi.md#uploadOrderRequirementFile) | **POST** /trading/orders/{orderId}/requirement/file | Upload a file for an order requirement *TransactionsApi* | [**cancelTransaction**](docs/apis/TransactionsApi.md#cancelTransaction) | **POST** /transactions/{txId}/cancel | Cancel a transaction *TransactionsApi* | [**createTransaction**](docs/apis/TransactionsApi.md#createTransaction) | **POST** /transactions | Create a new transaction *TransactionsApi* | [**dropTransaction**](docs/apis/TransactionsApi.md#dropTransaction) | **POST** /transactions/{txId}/drop | Drop ETH (EVM) transaction by ID @@ -523,6 +540,7 @@ Class | Method | HTTP request | Description *WebhooksV2Api* | [**createWebhook**](docs/apis/WebhooksV2Api.md#createWebhook) | **POST** /webhooks | Create a new webhook *WebhooksV2Api* | [**deleteWebhook**](docs/apis/WebhooksV2Api.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook *WebhooksV2Api* | [**getMetrics**](docs/apis/WebhooksV2Api.md#getMetrics) | **GET** /webhooks/{webhookId}/metrics/{metricName} | Get webhook metrics +*WebhooksV2Api* | [**getMtlsCsr**](docs/apis/WebhooksV2Api.md#getMtlsCsr) | **GET** /webhooks/mtls/csr | Get mTLS CSR *WebhooksV2Api* | [**getNotification**](docs/apis/WebhooksV2Api.md#getNotification) | **GET** /webhooks/{webhookId}/notifications/{notificationId} | Get notification by id *WebhooksV2Api* | [**getNotificationAttempts**](docs/apis/WebhooksV2Api.md#getNotificationAttempts) | **GET** /webhooks/{webhookId}/notifications/{notificationId}/attempts | Get notification attempts *WebhooksV2Api* | [**getNotifications**](docs/apis/WebhooksV2Api.md#getNotifications) | **GET** /webhooks/{webhookId}/notifications | Get all notifications by webhook id @@ -548,6 +566,7 @@ Class | Method | HTTP request | Description - [AbiFunction](docs/models/AbiFunction.md) - [AccessRegistryAddressItem](docs/models/AccessRegistryAddressItem.md) - [AccessRegistryCurrentStateResponse](docs/models/AccessRegistryCurrentStateResponse.md) + - [AccessRegistryCurrentStateResponse2](docs/models/AccessRegistryCurrentStateResponse2.md) - [AccessRegistrySummaryResponse](docs/models/AccessRegistrySummaryResponse.md) - [AccessType](docs/models/AccessType.md) - [Account](docs/models/Account.md) @@ -566,7 +585,9 @@ Class | Method | HTTP request | Description - [AchDestination](docs/models/AchDestination.md) - [AchPaymentInfo](docs/models/AchPaymentInfo.md) - [ActionRecord](docs/models/ActionRecord.md) + - [ActiveRolesMap](docs/models/ActiveRolesMap.md) - [ActiveRolesResponse](docs/models/ActiveRolesResponse.md) + - [ActiveRolesResponse2](docs/models/ActiveRolesResponse2.md) - [AdapterProcessingResult](docs/models/AdapterProcessingResult.md) - [AddAbiRequestDto](docs/models/AddAbiRequestDto.md) - [AddAssetToExternalWalletRequest](docs/models/AddAssetToExternalWalletRequest.md) @@ -581,6 +602,7 @@ Class | Method | HTTP request | Description - [AdditionalInfoRequestAdditionalInfo](docs/models/AdditionalInfoRequestAdditionalInfo.md) - [AddressBalanceItemDto](docs/models/AddressBalanceItemDto.md) - [AddressBalancePagedResponse](docs/models/AddressBalancePagedResponse.md) + - [AddressBalancePagedResponse2](docs/models/AddressBalancePagedResponse2.md) - [AddressNotAvailableError](docs/models/AddressNotAvailableError.md) - [AddressRegistryAddVaultOptOutsRequest](docs/models/AddressRegistryAddVaultOptOutsRequest.md) - [AddressRegistryAddVaultOptOutsRequestVaultAccountIdsInner](docs/models/AddressRegistryAddVaultOptOutsRequestVaultAccountIdsInner.md) @@ -598,6 +620,11 @@ Class | Method | HTTP request | Description - [AddressReverseLookupResponse](docs/models/AddressReverseLookupResponse.md) - [AlertExposureTypeEnum](docs/models/AlertExposureTypeEnum.md) - [AlertLevelEnum](docs/models/AlertLevelEnum.md) + - [AllowlistEntry](docs/models/AllowlistEntry.md) + - [AllowlistEntryProviderMetadata](docs/models/AllowlistEntryProviderMetadata.md) + - [AllowlistEntryStatus](docs/models/AllowlistEntryStatus.md) + - [AllowlistMetadata](docs/models/AllowlistMetadata.md) + - [AllowlistResponse](docs/models/AllowlistResponse.md) - [AmlAlert](docs/models/AmlAlert.md) - [AmlMatchedRule](docs/models/AmlMatchedRule.md) - [AmlRegistrationResult](docs/models/AmlRegistrationResult.md) @@ -663,6 +690,7 @@ Class | Method | HTTP request | Description - [AuthorizationInfo](docs/models/AuthorizationInfo.md) - [BalanceHistoryItemDto](docs/models/BalanceHistoryItemDto.md) - [BalanceHistoryPagedResponse](docs/models/BalanceHistoryPagedResponse.md) + - [BalanceHistoryPagedResponse2](docs/models/BalanceHistoryPagedResponse2.md) - [BankAddress](docs/models/BankAddress.md) - [BaseProvider](docs/models/BaseProvider.md) - [BasicAddressRequest](docs/models/BasicAddressRequest.md) @@ -735,6 +763,7 @@ Class | Method | HTTP request | Description - [ConnectedAccountTradingPair](docs/models/ConnectedAccountTradingPair.md) - [ConnectedAccountTradingPairSupportedType](docs/models/ConnectedAccountTradingPairSupportedType.md) - [ConnectedAccountTradingPairsResponse](docs/models/ConnectedAccountTradingPairsResponse.md) + - [ConnectedAccountType](docs/models/ConnectedAccountType.md) - [ConnectedAccountsResponse](docs/models/ConnectedAccountsResponse.md) - [ConnectedSingleAccount](docs/models/ConnectedSingleAccount.md) - [ConnectedSingleAccountResponse](docs/models/ConnectedSingleAccountResponse.md) @@ -1125,6 +1154,9 @@ Class | Method | HTTP request | Description - [OffersResponse](docs/models/OffersResponse.md) - [OnchainTransaction](docs/models/OnchainTransaction.md) - [OnchainTransactionsPagedResponse](docs/models/OnchainTransactionsPagedResponse.md) + - [OnchainTransactionsPagedResponse2](docs/models/OnchainTransactionsPagedResponse2.md) + - [OnchainTransferEvent](docs/models/OnchainTransferEvent.md) + - [OnchainTransfersPagedResponse](docs/models/OnchainTransfersPagedResponse.md) - [OneTimeAddress](docs/models/OneTimeAddress.md) - [OneTimeAddressAccount](docs/models/OneTimeAddressAccount.md) - [OneTimeAddressPeerType](docs/models/OneTimeAddressPeerType.md) @@ -1133,6 +1165,9 @@ Class | Method | HTTP request | Description - [Opportunity](docs/models/Opportunity.md) - [OrderDetails](docs/models/OrderDetails.md) - [OrderExecutionStep](docs/models/OrderExecutionStep.md) + - [OrderRequirementAllowedFileType](docs/models/OrderRequirementAllowedFileType.md) + - [OrderRequirementDetails](docs/models/OrderRequirementDetails.md) + - [OrderRequirementFile](docs/models/OrderRequirementFile.md) - [OrderSide](docs/models/OrderSide.md) - [OrderStatus](docs/models/OrderStatus.md) - [OrderSummary](docs/models/OrderSummary.md) @@ -1174,6 +1209,7 @@ Class | Method | HTTP request | Description - [PeerType](docs/models/PeerType.md) - [PersonalEntityTypeEnum](docs/models/PersonalEntityTypeEnum.md) - [PersonalIdentification](docs/models/PersonalIdentification.md) + - [PersonalIdentificationDocument](docs/models/PersonalIdentificationDocument.md) - [PersonalIdentificationFullName](docs/models/PersonalIdentificationFullName.md) - [PersonalIdentificationType](docs/models/PersonalIdentificationType.md) - [PixAddress](docs/models/PixAddress.md) @@ -1201,6 +1237,7 @@ Class | Method | HTTP request | Description - [PolicyVerdictActionEnum2](docs/models/PolicyVerdictActionEnum2.md) - [Position](docs/models/Position.md) - [Position2](docs/models/Position2.md) + - [PositionRelatedTransaction](docs/models/PositionRelatedTransaction.md) - [PostalAddress](docs/models/PostalAddress.md) - [PreScreening](docs/models/PreScreening.md) - [PrefundedSettlement](docs/models/PrefundedSettlement.md) @@ -1264,6 +1301,7 @@ Class | Method | HTTP request | Description - [RewardInfo](docs/models/RewardInfo.md) - [RewardsInfo](docs/models/RewardsInfo.md) - [RoleDetails](docs/models/RoleDetails.md) + - [RoleDetails2](docs/models/RoleDetails2.md) - [RoleGrantee](docs/models/RoleGrantee.md) - [SEPAAddress](docs/models/SEPAAddress.md) - [SEPADestination](docs/models/SEPADestination.md) @@ -1388,10 +1426,12 @@ Class | Method | HTTP request | Description - [StakingGetChainsResponse](docs/models/StakingGetChainsResponse.md) - [StakingGetProvidersResponse](docs/models/StakingGetProvidersResponse.md) - [StakingGetSummaryByVaultResponse](docs/models/StakingGetSummaryByVaultResponse.md) + - [StakingPositionRelatedTransactionsPaginatedResponse](docs/models/StakingPositionRelatedTransactionsPaginatedResponse.md) - [StakingPositionsPaginatedResponse](docs/models/StakingPositionsPaginatedResponse.md) - [StakingProvider](docs/models/StakingProvider.md) - [Status](docs/models/Status.md) - [StellarRippleCreateParamsDto](docs/models/StellarRippleCreateParamsDto.md) + - [SubmitOrderRequirementRequest](docs/models/SubmitOrderRequirementRequest.md) - [SupportedBlockChainsResponse](docs/models/SupportedBlockChainsResponse.md) - [SupportedBlockchain](docs/models/SupportedBlockchain.md) - [SwiftAddress](docs/models/SwiftAddress.md) @@ -1515,10 +1555,12 @@ Class | Method | HTTP request | Description - [TokensPaginatedResponse](docs/models/TokensPaginatedResponse.md) - [TotalSupplyItemDto](docs/models/TotalSupplyItemDto.md) - [TotalSupplyPagedResponse](docs/models/TotalSupplyPagedResponse.md) + - [TotalSupplyPagedResponse2](docs/models/TotalSupplyPagedResponse2.md) - [TradingAccountType](docs/models/TradingAccountType.md) - [TradingErrorSchema](docs/models/TradingErrorSchema.md) - [TradingProvider](docs/models/TradingProvider.md) - [Transaction](docs/models/Transaction.md) + - [TransactionConfigurations](docs/models/TransactionConfigurations.md) - [TransactionDirection](docs/models/TransactionDirection.md) - [TransactionFee](docs/models/TransactionFee.md) - [TransactionOperation](docs/models/TransactionOperation.md) @@ -1551,6 +1593,7 @@ Class | Method | HTTP request | Description - [TransferPeerPathType](docs/models/TransferPeerPathType.md) - [TransferPeerSubTypeEnum](docs/models/TransferPeerSubTypeEnum.md) - [TransferPeerTypeEnum](docs/models/TransferPeerTypeEnum.md) + - [TransferPeerTypeEnum2](docs/models/TransferPeerTypeEnum2.md) - [TransferRail](docs/models/TransferRail.md) - [TransferReceipt](docs/models/TransferReceipt.md) - [TransferValidationFailure](docs/models/TransferValidationFailure.md) @@ -1666,6 +1709,8 @@ Class | Method | HTTP request | Description - [Webhook](docs/models/Webhook.md) - [WebhookEvent](docs/models/WebhookEvent.md) - [WebhookMetric](docs/models/WebhookMetric.md) + - [WebhookMtls](docs/models/WebhookMtls.md) + - [WebhookMtlsCsrResponse](docs/models/WebhookMtlsCsrResponse.md) - [WebhookPaginatedResponse](docs/models/WebhookPaginatedResponse.md) - [WithdrawRequest](docs/models/WithdrawRequest.md) - [WorkflowConfigStatus](docs/models/WorkflowConfigStatus.md) diff --git a/api/connected-accounts-beta-api.ts b/api/connected-accounts-beta-api.ts index 064e97a7..1baf8818 100644 --- a/api/connected-accounts-beta-api.ts +++ b/api/connected-accounts-beta-api.ts @@ -27,6 +27,12 @@ import { assertParamExistsAndNotEmpty } from '../utils/validation_utils'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore +import { AllowlistEntry } from '../models'; +// @ts-ignore +import { AllowlistEntryStatus } from '../models'; +// @ts-ignore +import { AllowlistResponse } from '../models'; +// @ts-ignore import { ConnectedAccountBalancesResponse } from '../models'; // @ts-ignore import { ConnectedAccountErrorResponse } from '../models'; @@ -107,6 +113,115 @@ export const ConnectedAccountsBetaApiAxiosParamCreator = function (configuration + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Retrieves the address allowlist for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get allowlist for connected account + * @param {string} accountId The connected account identifier + * @param {AllowlistEntryStatus} [status] Filter by allowlist entry status + * @param {string} [assetId] Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. + * @param {string} [networkId] Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. + * @param {string} [address] Filter by specific address + * @param {string} [pageCursor] Pagination cursor for next page + * @param {number} [pageSize] Maximum number of entries to return + * @param {GetConnectedAccountAllowlistSortByEnum} [sortBy] Field to sort results by. + * @param {GetConnectedAccountAllowlistOrderEnum} [order] Sort order (ASC or DESC). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getConnectedAccountAllowlist: async (accountId: string, status?: AllowlistEntryStatus, assetId?: string, networkId?: string, address?: string, pageCursor?: string, pageSize?: number, sortBy?: GetConnectedAccountAllowlistSortByEnum, order?: GetConnectedAccountAllowlistOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getConnectedAccountAllowlist', 'accountId', accountId) + const localVarPath = `/connected_accounts/{accountId}/allowlist` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (status !== undefined) { + localVarQueryParameter['status'] = status; + } + + if (assetId !== undefined) { + localVarQueryParameter['assetId'] = assetId; + } + + if (networkId !== undefined) { + localVarQueryParameter['networkId'] = networkId; + } + + if (address !== undefined) { + localVarQueryParameter['address'] = address; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get a single allowlist entry for a connected account + * @param {string} accountId The connected account identifier + * @param {string} allowlistId The Fireblocks allowlist entry identifier + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getConnectedAccountAllowlistEntry: async (accountId: string, allowlistId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getConnectedAccountAllowlistEntry', 'accountId', accountId) + assertParamExistsAndNotEmpty('getConnectedAccountAllowlistEntry', 'allowlistId', allowlistId) + const localVarPath = `/connected_accounts/{accountId}/allowlist/{allowlistId}` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))) + .replace(`{${"allowlistId"}}`, encodeURIComponent(String(allowlistId))); + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -330,6 +445,44 @@ export const ConnectedAccountsBetaApiAxiosParamCreator = function (configuration localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(renameConnectedAccountRequest, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Sync allowlist for connected account + * @param {string} accountId The connected account identifier + * @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} + */ + syncConnectedAccountAllowlist: async (accountId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('syncConnectedAccountAllowlist', 'accountId', accountId) + const localVarPath = `/connected_accounts/{accountId}/allowlist/sync` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // 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}; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -371,6 +524,41 @@ export const ConnectedAccountsBetaApiFp = function(configuration?: Configuration const operationBasePath = operationServerMap['ConnectedAccountsBetaApi.getConnectedAccount']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Retrieves the address allowlist for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get allowlist for connected account + * @param {string} accountId The connected account identifier + * @param {AllowlistEntryStatus} [status] Filter by allowlist entry status + * @param {string} [assetId] Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. + * @param {string} [networkId] Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. + * @param {string} [address] Filter by specific address + * @param {string} [pageCursor] Pagination cursor for next page + * @param {number} [pageSize] Maximum number of entries to return + * @param {GetConnectedAccountAllowlistSortByEnum} [sortBy] Field to sort results by. + * @param {GetConnectedAccountAllowlistOrderEnum} [order] Sort order (ASC or DESC). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getConnectedAccountAllowlist(accountId: string, status?: AllowlistEntryStatus, assetId?: string, networkId?: string, address?: string, pageCursor?: string, pageSize?: number, sortBy?: GetConnectedAccountAllowlistSortByEnum, order?: GetConnectedAccountAllowlistOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectedAccountAllowlist(accountId, status, assetId, networkId, address, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ConnectedAccountsBetaApi.getConnectedAccountAllowlist']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get a single allowlist entry for a connected account + * @param {string} accountId The connected account identifier + * @param {string} allowlistId The Fireblocks allowlist entry identifier + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getConnectedAccountAllowlistEntry(accountId: string, allowlistId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectedAccountAllowlistEntry(accountId, allowlistId, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ConnectedAccountsBetaApi.getConnectedAccountAllowlistEntry']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Get balances for an account @@ -446,6 +634,20 @@ export const ConnectedAccountsBetaApiFp = function(configuration?: Configuration const operationBasePath = operationServerMap['ConnectedAccountsBetaApi.renameConnectedAccount']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Sync allowlist for connected account + * @param {string} accountId The connected account identifier + * @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 syncConnectedAccountAllowlist(accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.syncConnectedAccountAllowlist(accountId, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ConnectedAccountsBetaApi.syncConnectedAccountAllowlist']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, } }; @@ -476,6 +678,26 @@ export const ConnectedAccountsBetaApiFactory = function (configuration?: Configu getConnectedAccount(requestParameters: ConnectedAccountsBetaApiGetConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getConnectedAccount(requestParameters.accountId, options).then((request) => request(axios, basePath)); }, + /** + * Retrieves the address allowlist for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get allowlist for connected account + * @param {ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getConnectedAccountAllowlist(requestParameters: ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectedAccountAllowlist(requestParameters.accountId, requestParameters.status, requestParameters.assetId, requestParameters.networkId, requestParameters.address, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get a single allowlist entry for a connected account + * @param {ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getConnectedAccountAllowlistEntry(requestParameters: ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectedAccountAllowlistEntry(requestParameters.accountId, requestParameters.allowlistId, options).then((request) => request(axios, basePath)); + }, /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Get balances for an account @@ -526,6 +748,16 @@ export const ConnectedAccountsBetaApiFactory = function (configuration?: Configu renameConnectedAccount(requestParameters: ConnectedAccountsBetaApiRenameConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.renameConnectedAccount(requestParameters.renameConnectedAccountRequest, requestParameters.accountId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, + /** + * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Sync allowlist for connected account + * @param {ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + syncConnectedAccountAllowlist(requestParameters: ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.syncConnectedAccountAllowlist(requestParameters.accountId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, }; }; @@ -557,6 +789,97 @@ export interface ConnectedAccountsBetaApiGetConnectedAccountRequest { readonly accountId: string } +/** + * Request parameters for getConnectedAccountAllowlist operation in ConnectedAccountsBetaApi. + * @export + * @interface ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest + */ +export interface ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest { + /** + * The connected account identifier + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly accountId: string + + /** + * Filter by allowlist entry status + * @type {AllowlistEntryStatus} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly status?: AllowlistEntryStatus + + /** + * Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly assetId?: string + + /** + * Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly networkId?: string + + /** + * Filter by specific address + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly address?: string + + /** + * Pagination cursor for next page + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly pageCursor?: string + + /** + * Maximum number of entries to return + * @type {number} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly pageSize?: number + + /** + * Field to sort results by. + * @type {'addedAt' | 'lastSyncedAt'} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly sortBy?: GetConnectedAccountAllowlistSortByEnum + + /** + * Sort order (ASC or DESC). + * @type {'ASC' | 'DESC'} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlist + */ + readonly order?: GetConnectedAccountAllowlistOrderEnum +} + +/** + * Request parameters for getConnectedAccountAllowlistEntry operation in ConnectedAccountsBetaApi. + * @export + * @interface ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest + */ +export interface ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest { + /** + * The connected account identifier + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntry + */ + readonly accountId: string + + /** + * The Fireblocks allowlist entry identifier + * @type {string} + * @memberof ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntry + */ + readonly allowlistId: string +} + /** * Request parameters for getConnectedAccountBalances operation in ConnectedAccountsBetaApi. * @export @@ -697,6 +1020,27 @@ export interface ConnectedAccountsBetaApiRenameConnectedAccountRequest { readonly idempotencyKey?: string } +/** + * Request parameters for syncConnectedAccountAllowlist operation in ConnectedAccountsBetaApi. + * @export + * @interface ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest + */ +export interface ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest { + /** + * The connected account identifier + * @type {string} + * @memberof ConnectedAccountsBetaApiSyncConnectedAccountAllowlist + */ + readonly accountId: 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 ConnectedAccountsBetaApiSyncConnectedAccountAllowlist + */ + readonly idempotencyKey?: string +} + /** * ConnectedAccountsBetaApi - object-oriented interface * @export @@ -728,6 +1072,30 @@ export class ConnectedAccountsBetaApi extends BaseAPI { return ConnectedAccountsBetaApiFp(this.configuration).getConnectedAccount(requestParameters.accountId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Retrieves the address allowlist for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get allowlist for connected account + * @param {ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ConnectedAccountsBetaApi + */ + public getConnectedAccountAllowlist(requestParameters: ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest) { + return ConnectedAccountsBetaApiFp(this.configuration).getConnectedAccountAllowlist(requestParameters.accountId, requestParameters.status, requestParameters.assetId, requestParameters.networkId, requestParameters.address, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Get a single allowlist entry for a connected account + * @param {ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ConnectedAccountsBetaApi + */ + public getConnectedAccountAllowlistEntry(requestParameters: ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest) { + return ConnectedAccountsBetaApiFp(this.configuration).getConnectedAccountAllowlistEntry(requestParameters.accountId, requestParameters.allowlistId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Get balances for an account @@ -787,5 +1155,33 @@ export class ConnectedAccountsBetaApi extends BaseAPI { public renameConnectedAccount(requestParameters: ConnectedAccountsBetaApiRenameConnectedAccountRequest) { return ConnectedAccountsBetaApiFp(this.configuration).renameConnectedAccount(requestParameters.renameConnectedAccountRequest, requestParameters.accountId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + + /** + * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + * @summary Sync allowlist for connected account + * @param {ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ConnectedAccountsBetaApi + */ + public syncConnectedAccountAllowlist(requestParameters: ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest) { + return ConnectedAccountsBetaApiFp(this.configuration).syncConnectedAccountAllowlist(requestParameters.accountId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } } +/** + * @export + */ +export const GetConnectedAccountAllowlistSortByEnum = { + AddedAt: 'addedAt', + LastSyncedAt: 'lastSyncedAt' +} as const; +export type GetConnectedAccountAllowlistSortByEnum = typeof GetConnectedAccountAllowlistSortByEnum[keyof typeof GetConnectedAccountAllowlistSortByEnum]; +/** + * @export + */ +export const GetConnectedAccountAllowlistOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetConnectedAccountAllowlistOrderEnum = typeof GetConnectedAccountAllowlistOrderEnum[keyof typeof GetConnectedAccountAllowlistOrderEnum]; diff --git a/api/onchain-data-api.ts b/api/onchain-data-api.ts index 32e351b4..b6700b49 100644 --- a/api/onchain-data-api.ts +++ b/api/onchain-data-api.ts @@ -27,23 +27,23 @@ import { assertParamExistsAndNotEmpty } from '../utils/validation_utils'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore -import { AccessRegistryCurrentStateResponse } from '../models'; +import { AccessRegistryCurrentStateResponse2 } from '../models'; // @ts-ignore import { AccessRegistrySummaryResponse } from '../models'; // @ts-ignore -import { ActiveRolesResponse } from '../models'; +import { ActiveRolesResponse2 } from '../models'; // @ts-ignore -import { AddressBalancePagedResponse } from '../models'; +import { AddressBalancePagedResponse2 } from '../models'; // @ts-ignore -import { BalanceHistoryPagedResponse } from '../models'; +import { BalanceHistoryPagedResponse2 } from '../models'; // @ts-ignore import { ErrorSchema } from '../models'; // @ts-ignore -import { OnchainTransactionsPagedResponse } from '../models'; +import { OnchainTransactionsPagedResponse2 } from '../models'; // @ts-ignore import { TokenContractSummaryResponse } from '../models'; // @ts-ignore -import { TotalSupplyPagedResponse } from '../models'; +import { TotalSupplyPagedResponse2 } from '../models'; /** * OnchainDataApi - axios parameter creator * @export @@ -520,7 +520,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAccessRegistryCurrentState(baseAssetId: string, accessRegistryAddress: string, pageCursor?: string, pageSize?: number, sortBy?: GetAccessRegistryCurrentStateSortByEnum, order?: GetAccessRegistryCurrentStateOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAccessRegistryCurrentState(baseAssetId: string, accessRegistryAddress: string, pageCursor?: string, pageSize?: number, sortBy?: GetAccessRegistryCurrentStateSortByEnum, order?: GetAccessRegistryCurrentStateOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRegistryCurrentState(baseAssetId, accessRegistryAddress, pageCursor, pageSize, sortBy, order, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getAccessRegistryCurrentState']?.[index]?.url; @@ -548,7 +548,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getActiveRolesForContract(baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getActiveRolesForContract(baseAssetId: string, contractAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveRolesForContract(baseAssetId, contractAddress, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getActiveRolesForContract']?.[index]?.url; @@ -570,7 +570,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getContractBalanceHistory(baseAssetId: string, contractAddress: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetContractBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractBalanceHistorySortByEnum, order?: GetContractBalanceHistoryOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getContractBalanceHistory(baseAssetId: string, contractAddress: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetContractBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractBalanceHistorySortByEnum, order?: GetContractBalanceHistoryOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getContractBalanceHistory(baseAssetId, contractAddress, accountAddress, startDate, endDate, interval, pageCursor, pageSize, sortBy, order, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getContractBalanceHistory']?.[index]?.url; @@ -605,7 +605,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getContractTotalSupply(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, interval?: GetContractTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractTotalSupplySortByEnum, order?: GetContractTotalSupplyOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getContractTotalSupply(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, interval?: GetContractTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetContractTotalSupplySortByEnum, order?: GetContractTotalSupplyOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getContractTotalSupply(baseAssetId, contractAddress, startDate, endDate, interval, pageCursor, pageSize, sortBy, order, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getContractTotalSupply']?.[index]?.url; @@ -624,7 +624,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLatestBalancesForContract(baseAssetId: string, contractAddress: string, accountAddress?: string, pageCursor?: string, pageSize?: number, sortBy?: GetLatestBalancesForContractSortByEnum, order?: GetLatestBalancesForContractOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getLatestBalancesForContract(baseAssetId: string, contractAddress: string, accountAddress?: string, pageCursor?: string, pageSize?: number, sortBy?: GetLatestBalancesForContractSortByEnum, order?: GetLatestBalancesForContractOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestBalancesForContract(baseAssetId, contractAddress, accountAddress, pageCursor, pageSize, sortBy, order, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getLatestBalancesForContract']?.[index]?.url; @@ -644,7 +644,7 @@ export const OnchainDataApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getOnchainTransactions(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetOnchainTransactionsSortByEnum, order?: GetOnchainTransactionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getOnchainTransactions(baseAssetId: string, contractAddress: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetOnchainTransactionsSortByEnum, order?: GetOnchainTransactionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getOnchainTransactions(baseAssetId, contractAddress, startDate, endDate, pageCursor, pageSize, sortBy, order, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['OnchainDataApi.getOnchainTransactions']?.[index]?.url; @@ -667,7 +667,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAccessRegistryCurrentState(requestParameters: OnchainDataApiGetAccessRegistryCurrentStateRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getAccessRegistryCurrentState(requestParameters: OnchainDataApiGetAccessRegistryCurrentStateRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getAccessRegistryCurrentState(requestParameters.baseAssetId, requestParameters.accessRegistryAddress, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); }, /** @@ -687,7 +687,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getActiveRolesForContract(requestParameters: OnchainDataApiGetActiveRolesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getActiveRolesForContract(requestParameters: OnchainDataApiGetActiveRolesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getActiveRolesForContract(requestParameters.baseAssetId, requestParameters.contractAddress, options).then((request) => request(axios, basePath)); }, /** @@ -697,7 +697,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getContractBalanceHistory(requestParameters: OnchainDataApiGetContractBalanceHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getContractBalanceHistory(requestParameters: OnchainDataApiGetContractBalanceHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getContractBalanceHistory(requestParameters.baseAssetId, requestParameters.contractAddress, requestParameters.accountAddress, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); }, /** @@ -717,7 +717,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getContractTotalSupply(requestParameters: OnchainDataApiGetContractTotalSupplyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getContractTotalSupply(requestParameters: OnchainDataApiGetContractTotalSupplyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getContractTotalSupply(requestParameters.baseAssetId, requestParameters.contractAddress, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); }, /** @@ -727,7 +727,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLatestBalancesForContract(requestParameters: OnchainDataApiGetLatestBalancesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getLatestBalancesForContract(requestParameters: OnchainDataApiGetLatestBalancesForContractRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getLatestBalancesForContract(requestParameters.baseAssetId, requestParameters.contractAddress, requestParameters.accountAddress, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); }, /** @@ -737,7 +737,7 @@ export const OnchainDataApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOnchainTransactions(requestParameters: OnchainDataApiGetOnchainTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getOnchainTransactions(requestParameters: OnchainDataApiGetOnchainTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getOnchainTransactions(requestParameters.baseAssetId, requestParameters.contractAddress, requestParameters.startDate, requestParameters.endDate, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); }, }; diff --git a/api/staking-api.ts b/api/staking-api.ts index 5618acf5..4a77b879 100644 --- a/api/staking-api.ts +++ b/api/staking-api.ts @@ -61,6 +61,8 @@ import { StakingGetProvidersResponse } from '../models'; // @ts-ignore import { StakingGetSummaryByVaultResponse } from '../models'; // @ts-ignore +import { StakingPositionRelatedTransactionsPaginatedResponse } from '../models'; +// @ts-ignore import { StakingPositionsPaginatedResponse } from '../models'; // @ts-ignore import { StakingProvider } from '../models'; @@ -325,6 +327,55 @@ export const StakingApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. + * @summary List related transactions for a position + * @param {string} id Unique identifier of the staking position. + * @param {number} pageSize Number of results per page (minimum: 1, maximum: 100). + * @param {string} [pageCursor] Cursor for the next page of results. Use the value from the \'next\' field in the previous response. + * @param {GetPositionRelatedTransactionsOrderEnum} [order] ASC / DESC ordering for completed/failed history (default DESC). The in-flight transaction is always returned first. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPositionRelatedTransactions: async (id: string, pageSize: number, pageCursor?: string, order?: GetPositionRelatedTransactionsOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getPositionRelatedTransactions', 'id', id) + assertParamExists('getPositionRelatedTransactions', 'pageSize', pageSize) + const localVarPath = `/staking/positions/{id}/related_transactions` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -801,6 +852,22 @@ export const StakingApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['StakingApi.getDelegationById']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. + * @summary List related transactions for a position + * @param {string} id Unique identifier of the staking position. + * @param {number} pageSize Number of results per page (minimum: 1, maximum: 100). + * @param {string} [pageCursor] Cursor for the next page of results. Use the value from the \'next\' field in the previous response. + * @param {GetPositionRelatedTransactionsOrderEnum} [order] ASC / DESC ordering for completed/failed history (default DESC). The in-flight transaction is always returned first. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPositionRelatedTransactions(id: string, pageSize: number, pageCursor?: string, order?: GetPositionRelatedTransactionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPositionRelatedTransactions(id, pageSize, pageCursor, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['StakingApi.getPositionRelatedTransactions']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary List staking positions (Paginated) @@ -1008,6 +1075,16 @@ export const StakingApiFactory = function (configuration?: Configuration, basePa getDelegationById(requestParameters: StakingApiGetDelegationByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getDelegationById(requestParameters.id, options).then((request) => request(axios, basePath)); }, + /** + * Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. + * @summary List related transactions for a position + * @param {StakingApiGetPositionRelatedTransactionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPositionRelatedTransactions(requestParameters: StakingApiGetPositionRelatedTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPositionRelatedTransactions(requestParameters.id, requestParameters.pageSize, requestParameters.pageCursor, requestParameters.order, options).then((request) => request(axios, basePath)); + }, /** * Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary List staking positions (Paginated) @@ -1224,6 +1301,41 @@ export interface StakingApiGetDelegationByIdRequest { readonly id: string } +/** + * Request parameters for getPositionRelatedTransactions operation in StakingApi. + * @export + * @interface StakingApiGetPositionRelatedTransactionsRequest + */ +export interface StakingApiGetPositionRelatedTransactionsRequest { + /** + * Unique identifier of the staking position. + * @type {string} + * @memberof StakingApiGetPositionRelatedTransactions + */ + readonly id: string + + /** + * Number of results per page (minimum: 1, maximum: 100). + * @type {number} + * @memberof StakingApiGetPositionRelatedTransactions + */ + readonly pageSize: number + + /** + * Cursor for the next page of results. Use the value from the \'next\' field in the previous response. + * @type {string} + * @memberof StakingApiGetPositionRelatedTransactions + */ + readonly pageCursor?: string + + /** + * ASC / DESC ordering for completed/failed history (default DESC). The in-flight transaction is always returned first. + * @type {'ASC' | 'DESC'} + * @memberof StakingApiGetPositionRelatedTransactions + */ + readonly order?: GetPositionRelatedTransactionsOrderEnum +} + /** * Request parameters for getPositions operation in StakingApi. * @export @@ -1496,6 +1608,18 @@ export class StakingApi extends BaseAPI { return StakingApiFp(this.configuration).getDelegationById(requestParameters.id).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. + * @summary List related transactions for a position + * @param {StakingApiGetPositionRelatedTransactionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof StakingApi + */ + public getPositionRelatedTransactions(requestParameters: StakingApiGetPositionRelatedTransactionsRequest) { + return StakingApiFp(this.configuration).getPositionRelatedTransactions(requestParameters.id, requestParameters.pageSize, requestParameters.pageCursor, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary List staking positions (Paginated) @@ -1622,6 +1746,14 @@ export const ConsolidateChainDescriptorEnum = { EthTestHoodi: 'ETH_TEST_HOODI' } as const; export type ConsolidateChainDescriptorEnum = typeof ConsolidateChainDescriptorEnum[keyof typeof ConsolidateChainDescriptorEnum]; +/** + * @export + */ +export const GetPositionRelatedTransactionsOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetPositionRelatedTransactionsOrderEnum = typeof GetPositionRelatedTransactionsOrderEnum[keyof typeof GetPositionRelatedTransactionsOrderEnum]; /** * @export */ diff --git a/api/tokenization-api.ts b/api/tokenization-api.ts index 685e492c..6f412160 100644 --- a/api/tokenization-api.ts +++ b/api/tokenization-api.ts @@ -27,10 +27,22 @@ import { assertParamExistsAndNotEmpty } from '../utils/validation_utils'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore +import { AccessRegistryCurrentStateResponse } from '../models'; +// @ts-ignore +import { AccessRegistrySummaryResponse } from '../models'; +// @ts-ignore +import { ActiveRolesResponse } from '../models'; +// @ts-ignore +import { AddressBalanceItemDto } from '../models'; +// @ts-ignore +import { AddressBalancePagedResponse } from '../models'; +// @ts-ignore import { AddressNotAvailableError } from '../models'; // @ts-ignore import { AssetAlreadyExistHttpError } from '../models'; // @ts-ignore +import { BalanceHistoryPagedResponse } from '../models'; +// @ts-ignore import { CollectionBurnRequestDto } from '../models'; // @ts-ignore import { CollectionBurnResponseDto } from '../models'; @@ -75,6 +87,10 @@ import { LinkedTokensCount } from '../models'; // @ts-ignore import { NotFoundException } from '../models'; // @ts-ignore +import { OnchainTransactionsPagedResponse } from '../models'; +// @ts-ignore +import { OnchainTransfersPagedResponse } from '../models'; +// @ts-ignore import { ReissueMultichainTokenRequest } from '../models'; // @ts-ignore import { RemoveLayerZeroAdaptersRequest } from '../models'; @@ -93,6 +109,8 @@ import { SetLayerZeroPeersRequest } from '../models'; // @ts-ignore import { SetLayerZeroPeersResponse } from '../models'; // @ts-ignore +import { TokenContractSummaryResponse } from '../models'; +// @ts-ignore import { TokenLinkDto } from '../models'; // @ts-ignore import { TokenLinkExistsHttpError } from '../models'; @@ -103,6 +121,8 @@ import { TokenLinkRequestDto } from '../models'; // @ts-ignore import { TokensPaginatedResponse } from '../models'; // @ts-ignore +import { TotalSupplyPagedResponse } from '../models'; +// @ts-ignore import { ValidateLayerZeroChannelResponse } from '../models'; /** * TokenizationApi - axios parameter creator @@ -611,16 +631,20 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. - * @summary Issue a new token - * @param {CreateTokenRequestDto} createTokenRequestDto - * @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. + * Returns the currently active addresses in the access registry (added but not removed). + * @summary Get current state of addresses in an access registry + * @param {string} id The token link id + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenAccessRegistryAddressesSortByEnum} [sortBy] Sorting field (enum). + * @param {GetTokenAccessRegistryAddressesOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - issueNewToken: async (createTokenRequestDto: CreateTokenRequestDto, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('issueNewToken', 'createTokenRequestDto', createTokenRequestDto) - const localVarPath = `/tokenization/tokens`; + getTokenAccessRegistryAddresses: async (id: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenAccessRegistryAddressesSortByEnum, order?: GetTokenAccessRegistryAddressesOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenAccessRegistryAddresses', 'id', id) + const localVarPath = `/tokenization/access_registries/{id}/addresses` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -628,22 +652,31 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { - localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; } + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } - - localVarHeaderParameter['Content-Type'] = 'application/json'; + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createTokenRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -651,16 +684,16 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Facilitates the creation of a new token on one or more blockchains. - * @summary Issue a token on one or more blockchains - * @param {CreateMultichainTokenRequest} createMultichainTokenRequest - * @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. + * Returns a summary of the current state of the access registry. + * @summary Get summary of an access registry + * @param {string} id The token link id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - issueTokenMultiChain: async (createMultichainTokenRequest: CreateMultichainTokenRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('issueTokenMultiChain', 'createMultichainTokenRequest', createMultichainTokenRequest) - const localVarPath = `/tokenization/multichain/tokens`; + getTokenAccessRegistrySummary: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenAccessRegistrySummary', 'id', id) + const localVarPath = `/tokenization/access_registries/{id}/summary` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -668,22 +701,15 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...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(createMultichainTokenRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -691,16 +717,19 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Link an a contract - * @summary Link a contract - * @param {TokenLinkRequestDto} tokenLinkRequestDto - * @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. + * Returns the latest token balance for the specified account address. + * @summary Get the latest balance for a specific account + * @param {string} id The token link id + * @param {string} accountAddress The account address to get balance history for * @param {*} [options] Override http request option. * @throws {RequiredError} */ - link: async (tokenLinkRequestDto: TokenLinkRequestDto, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('link', 'tokenLinkRequestDto', tokenLinkRequestDto) - const localVarPath = `/tokenization/tokens/link`; + getTokenBalanceForAccount: async (id: string, accountAddress: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenBalanceForAccount', 'id', id) + assertParamExistsAndNotEmpty('getTokenBalanceForAccount', 'accountAddress', accountAddress) + const localVarPath = `/tokenization/tokens/{id}/balances/{accountAddress}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"accountAddress"}}`, encodeURIComponent(String(accountAddress))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -708,22 +737,15 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...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(tokenLinkRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -731,19 +753,26 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Mint tokens and upload metadata - * @summary Mint tokens - * @param {CollectionMintRequestDto} collectionMintRequestDto - * @param {string} id The collection link id - * @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. + * Returns paginated balance history for the specified account address with optional time-range filtering. + * @summary Get balance history for a specific account + * @param {string} id The token link id + * @param {string} accountAddress The account address to get balance history for + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {GetTokenBalanceHistoryIntervalEnum} [interval] Time interval for grouping data + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenBalanceHistorySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @param {GetTokenBalanceHistoryOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - mintCollectionToken: async (collectionMintRequestDto: CollectionMintRequestDto, id: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('mintCollectionToken', 'collectionMintRequestDto', collectionMintRequestDto) - assertParamExistsAndNotEmpty('mintCollectionToken', 'id', id) - const localVarPath = `/tokenization/collections/{id}/tokens/mint` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getTokenBalanceHistory: async (id: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetTokenBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetTokenBalanceHistorySortByEnum, order?: GetTokenBalanceHistoryOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenBalanceHistory', 'id', id) + assertParamExistsAndNotEmpty('getTokenBalanceHistory', 'accountAddress', accountAddress) + const localVarPath = `/tokenization/tokens/{id}/balances/{accountAddress}/history` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"accountAddress"}}`, encodeURIComponent(String(accountAddress))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -751,22 +780,47 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { - localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + if (startDate !== undefined) { + localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ? + (startDate as any).toISOString() : + startDate; } + if (endDate !== undefined) { + localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ? + (endDate as any).toISOString() : + endDate; + } - - localVarHeaderParameter['Content-Type'] = 'application/json'; + if (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(collectionMintRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -774,19 +828,20 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Reissue a multichain token. This endpoint allows you to reissue a token on one or more blockchains. The token must be initially issued using the issueTokenMultiChain endpoint. - * @summary Reissue a multichain token - * @param {ReissueMultichainTokenRequest} reissueMultichainTokenRequest - * @param {string} tokenLinkId The ID of the token link - * @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. + * Returns the latest balance for each unique address holding this token. + * @summary Get latest balances for all holders of a token + * @param {string} id The token link id + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenBalancesSortByEnum} [sortBy] Sorting field for balances + * @param {GetTokenBalancesOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - reIssueTokenMultiChain: async (reissueMultichainTokenRequest: ReissueMultichainTokenRequest, tokenLinkId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('reIssueTokenMultiChain', 'reissueMultichainTokenRequest', reissueMultichainTokenRequest) - assertParamExistsAndNotEmpty('reIssueTokenMultiChain', 'tokenLinkId', tokenLinkId) - const localVarPath = `/tokenization/multichain/reissue/token/{tokenLinkId}` - .replace(`{${"tokenLinkId"}}`, encodeURIComponent(String(tokenLinkId))); + getTokenBalances: async (id: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenBalancesSortByEnum, order?: GetTokenBalancesOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenBalances', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/balances` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -794,22 +849,31 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { - localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; } + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } - - localVarHeaderParameter['Content-Type'] = 'application/json'; + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reissueMultichainTokenRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -817,16 +881,16 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Remove LayerZero peers to disconnect adapter contracts. This endpoint removes peer relationships between LayerZero adapters. - * @summary Remove LayerZero peers - * @param {RemoveLayerZeroPeersRequest} removeLayerZeroPeersRequest - * @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. + * Returns the total number of unique holders and the total supply for the token contract. + * @summary Get onchain summary for a token + * @param {string} id The token link id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - removeLayerZeroPeers: async (removeLayerZeroPeersRequest: RemoveLayerZeroPeersRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('removeLayerZeroPeers', 'removeLayerZeroPeersRequest', removeLayerZeroPeersRequest) - const localVarPath = `/tokenization/multichain/bridge/layerzero/config/peers`; + getTokenContractSummary: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenContractSummary', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/summary` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -834,22 +898,15 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...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(removeLayerZeroPeersRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -857,16 +914,16 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Configure DVN settings for LayerZero adapters. This endpoint sets up the DVN configuration for message verification between source and destination adapters. - * @summary Set LayerZero DVN configuration - * @param {SetLayerZeroDvnConfigRequest} setLayerZeroDvnConfigRequest - * @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. + * Returns a list of currently active roles for the token contract. + * @summary Get active RBAC roles for a token + * @param {string} id The token link id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setLayerZeroDvnConfig: async (setLayerZeroDvnConfigRequest: SetLayerZeroDvnConfigRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('setLayerZeroDvnConfig', 'setLayerZeroDvnConfigRequest', setLayerZeroDvnConfigRequest) - const localVarPath = `/tokenization/multichain/bridge/layerzero/config/dvns`; + getTokenRbac: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenRbac', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/rbac` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -874,22 +931,15 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...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(setLayerZeroDvnConfigRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -897,16 +947,23 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Set LayerZero peers to establish connections between adapter contracts. This endpoint creates peer relationships that enable cross-chain communication. It sets the destination adapter as a peer of the source adapter. If `bidirectional` is true, it also sets the source adapter as a peer of the destination adapter(s). - * @summary Set LayerZero peers - * @param {SetLayerZeroPeersRequest} setLayerZeroPeersRequest - * @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. + * Returns paginated total supply history for the token contract with optional time-range filtering and binning. + * @summary Get historical total supply for a token + * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {GetTokenTotalSupplyIntervalEnum} [interval] Time interval for grouping data + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTotalSupplySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @param {GetTokenTotalSupplyOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setLayerZeroPeers: async (setLayerZeroPeersRequest: SetLayerZeroPeersRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('setLayerZeroPeers', 'setLayerZeroPeersRequest', setLayerZeroPeersRequest) - const localVarPath = `/tokenization/multichain/bridge/layerzero/config/peers`; + getTokenTotalSupply: async (id: string, startDate?: string, endDate?: string, interval?: GetTokenTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTotalSupplySortByEnum, order?: GetTokenTotalSupplyOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenTotalSupply', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/total_supply` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -914,22 +971,47 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { - localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + if (startDate !== undefined) { + localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ? + (startDate as any).toISOString() : + startDate; } + if (endDate !== undefined) { + localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ? + (endDate as any).toISOString() : + endDate; + } + + if (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } - - localVarHeaderParameter['Content-Type'] = 'application/json'; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(setLayerZeroPeersRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -937,15 +1019,21 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Unlink a token. The token will be unlinked from the workspace. The token will not be deleted on chain nor the refId, only the link to the workspace will be removed. - * @summary Unlink a token + * Returns a paginated list of onchain transactions for the token contract, optionally filtered by date range. + * @summary Get onchain transactions for a token * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTransactionsSortByEnum} [sortBy] Sorting field (enum). + * @param {GetTokenTransactionsOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unlink: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('unlink', 'id', id) - const localVarPath = `/tokenization/tokens/{id}` + getTokenTransactions: async (id: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTransactionsSortByEnum, order?: GetTokenTransactionsOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenTransactions', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/transactions` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -954,10 +1042,38 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (startDate !== undefined) { + localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ? + (startDate as any).toISOString() : + startDate; + } + + if (endDate !== undefined) { + localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ? + (endDate as any).toISOString() : + endDate; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -970,15 +1086,23 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Delete a collection link - * @summary Delete a collection link + * Returns a paginated list of ERC20 transfer events for the token contract, optionally filtered by date range. + * @summary Get onchain transfers for a token * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTransfersSortByEnum} [sortBy] Sorting field for transfers + * @param {GetTokenTransfersOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {string} [sender] Filter transfers by sender address + * @param {string} [receiver] Filter transfers by receiver address * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unlinkCollection: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('unlinkCollection', 'id', id) - const localVarPath = `/tokenization/collections/{id}` + getTokenTransfers: async (id: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTransfersSortByEnum, order?: GetTokenTransfersOrderEnum, sender?: string, receiver?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTokenTransfers', 'id', id) + const localVarPath = `/tokenization/tokens/{id}/transfers` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -987,33 +1111,68 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (startDate !== undefined) { + localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ? + (startDate as any).toISOString() : + startDate; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (endDate !== undefined) { + localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ? + (endDate as any).toISOString() : + endDate; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Validate the LayerZero channel configuration between adapters. This endpoint checks if the channel configuration is correct and returns any validation errors. - * @summary Validate LayerZero channel configuration - * @param {string} adapterTokenLinkId The token link ID of the adapter - * @param {string} peerAdapterTokenLinkId Peer adapter token link ID to validate against + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (sender !== undefined) { + localVarQueryParameter['sender'] = sender; + } + + if (receiver !== undefined) { + localVarQueryParameter['receiver'] = receiver; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. + * @summary Issue a new token + * @param {CreateTokenRequestDto} createTokenRequestDto + * @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} */ - validateLayerZeroChannelConfig: async (adapterTokenLinkId: string, peerAdapterTokenLinkId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('validateLayerZeroChannelConfig', 'adapterTokenLinkId', adapterTokenLinkId) - assertParamExistsAndNotEmpty('validateLayerZeroChannelConfig', 'peerAdapterTokenLinkId', peerAdapterTokenLinkId) - const localVarPath = `/tokenization/multichain/bridge/layerzero/validate`; + issueNewToken: async (createTokenRequestDto: CreateTokenRequestDto, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('issueNewToken', 'createTokenRequestDto', createTokenRequestDto) + const localVarPath = `/tokenization/tokens`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -1021,115 +1180,508 @@ export const TokenizationApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (adapterTokenLinkId !== undefined) { - localVarQueryParameter['adapterTokenLinkId'] = adapterTokenLinkId; - } - - if (peerAdapterTokenLinkId !== undefined) { - localVarQueryParameter['peerAdapterTokenLinkId'] = peerAdapterTokenLinkId; + 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(createTokenRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, - } -}; - -/** - * TokenizationApi - functional programming interface - * @export - */ -export const TokenizationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TokenizationApiAxiosParamCreator(configuration) - return { /** - * Burn tokens in a collection - * @summary Burn tokens - * @param {CollectionBurnRequestDto} collectionBurnRequestDto - * @param {string} id The collection link id + * Facilitates the creation of a new token on one or more blockchains. + * @summary Issue a token on one or more blockchains + * @param {CreateMultichainTokenRequest} createMultichainTokenRequest * @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 burnCollectionToken(collectionBurnRequestDto: CollectionBurnRequestDto, id: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.burnCollectionToken(collectionBurnRequestDto, id, idempotencyKey, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TokenizationApi.burnCollectionToken']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + issueTokenMultiChain: async (createMultichainTokenRequest: CreateMultichainTokenRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('issueTokenMultiChain', 'createMultichainTokenRequest', createMultichainTokenRequest) + const localVarPath = `/tokenization/multichain/tokens`; + // 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(createMultichainTokenRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; }, /** - * Create a new collection and link it as a token. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. - * @summary Create a new collection - * @param {CollectionDeployRequestDto} collectionDeployRequestDto + * Link an a contract + * @summary Link a contract + * @param {TokenLinkRequestDto} tokenLinkRequestDto * @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 createNewCollection(collectionDeployRequestDto: CollectionDeployRequestDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNewCollection(collectionDeployRequestDto, idempotencyKey, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TokenizationApi.createNewCollection']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + link: async (tokenLinkRequestDto: TokenLinkRequestDto, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('link', 'tokenLinkRequestDto', tokenLinkRequestDto) + const localVarPath = `/tokenization/tokens/link`; + // 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(tokenLinkRequestDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; }, /** - * Remove LayerZero adapters by deactivating and unlinking them. This endpoint revokes roles and deactivates the specified adapter contracts. - * @summary Remove LayerZero adapters - * @param {RemoveLayerZeroAdaptersRequest} removeLayerZeroAdaptersRequest + * Mint tokens and upload metadata + * @summary Mint tokens + * @param {CollectionMintRequestDto} collectionMintRequestDto + * @param {string} id The collection link id * @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 deactivateAndUnlinkAdapters(removeLayerZeroAdaptersRequest: RemoveLayerZeroAdaptersRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deactivateAndUnlinkAdapters(removeLayerZeroAdaptersRequest, idempotencyKey, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TokenizationApi.deactivateAndUnlinkAdapters']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + mintCollectionToken: async (collectionMintRequestDto: CollectionMintRequestDto, id: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('mintCollectionToken', 'collectionMintRequestDto', collectionMintRequestDto) + assertParamExistsAndNotEmpty('mintCollectionToken', 'id', id) + const localVarPath = `/tokenization/collections/{id}/tokens/mint` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // 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(collectionMintRequestDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; }, /** - * Deploy LayerZero adapters for multichain token bridging functionality. This endpoint creates adapter contracts that enable cross-chain token transfers. - * @summary Deploy LayerZero adapters - * @param {DeployLayerZeroAdaptersRequest} deployLayerZeroAdaptersRequest + * Reissue a multichain token. This endpoint allows you to reissue a token on one or more blockchains. The token must be initially issued using the issueTokenMultiChain endpoint. + * @summary Reissue a multichain token + * @param {ReissueMultichainTokenRequest} reissueMultichainTokenRequest + * @param {string} tokenLinkId The ID of the token link * @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 deployAndLinkAdapters(deployLayerZeroAdaptersRequest: DeployLayerZeroAdaptersRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deployAndLinkAdapters(deployLayerZeroAdaptersRequest, idempotencyKey, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TokenizationApi.deployAndLinkAdapters']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + reIssueTokenMultiChain: async (reissueMultichainTokenRequest: ReissueMultichainTokenRequest, tokenLinkId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('reIssueTokenMultiChain', 'reissueMultichainTokenRequest', reissueMultichainTokenRequest) + assertParamExistsAndNotEmpty('reIssueTokenMultiChain', 'tokenLinkId', tokenLinkId) + const localVarPath = `/tokenization/multichain/reissue/token/{tokenLinkId}` + .replace(`{${"tokenLinkId"}}`, encodeURIComponent(String(tokenLinkId))); + // 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(reissueMultichainTokenRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; }, /** - * Get collection token details by id - * @summary Get collection token details - * @param {string} id The collection link id - * @param {string} tokenId The tokenId as it appears on the blockchain + * Remove LayerZero peers to disconnect adapter contracts. This endpoint removes peer relationships between LayerZero adapters. + * @summary Remove LayerZero peers + * @param {RemoveLayerZeroPeersRequest} removeLayerZeroPeersRequest + * @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 fetchCollectionTokenDetails(id: string, tokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fetchCollectionTokenDetails(id, tokenId, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TokenizationApi.fetchCollectionTokenDetails']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a collection by id - * @summary Get a collection by id - * @param {string} id The token link id - * @param {*} [options] Override http request option. + removeLayerZeroPeers: async (removeLayerZeroPeersRequest: RemoveLayerZeroPeersRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('removeLayerZeroPeers', 'removeLayerZeroPeersRequest', removeLayerZeroPeersRequest) + const localVarPath = `/tokenization/multichain/bridge/layerzero/config/peers`; + // 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: 'DELETE', ...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(removeLayerZeroPeersRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Configure DVN settings for LayerZero adapters. This endpoint sets up the DVN configuration for message verification between source and destination adapters. + * @summary Set LayerZero DVN configuration + * @param {SetLayerZeroDvnConfigRequest} setLayerZeroDvnConfigRequest + * @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} + */ + setLayerZeroDvnConfig: async (setLayerZeroDvnConfigRequest: SetLayerZeroDvnConfigRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('setLayerZeroDvnConfig', 'setLayerZeroDvnConfigRequest', setLayerZeroDvnConfigRequest) + const localVarPath = `/tokenization/multichain/bridge/layerzero/config/dvns`; + // 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(setLayerZeroDvnConfigRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Set LayerZero peers to establish connections between adapter contracts. This endpoint creates peer relationships that enable cross-chain communication. It sets the destination adapter as a peer of the source adapter. If `bidirectional` is true, it also sets the source adapter as a peer of the destination adapter(s). + * @summary Set LayerZero peers + * @param {SetLayerZeroPeersRequest} setLayerZeroPeersRequest + * @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} + */ + setLayerZeroPeers: async (setLayerZeroPeersRequest: SetLayerZeroPeersRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('setLayerZeroPeers', 'setLayerZeroPeersRequest', setLayerZeroPeersRequest) + const localVarPath = `/tokenization/multichain/bridge/layerzero/config/peers`; + // 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(setLayerZeroPeersRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Unlink a token. The token will be unlinked from the workspace. The token will not be deleted on chain nor the refId, only the link to the workspace will be removed. + * @summary Unlink a token + * @param {string} id The token link id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + unlink: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('unlink', 'id', id) + const localVarPath = `/tokenization/tokens/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // 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: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete a collection link + * @summary Delete a collection link + * @param {string} id The token link id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + unlinkCollection: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('unlinkCollection', 'id', id) + const localVarPath = `/tokenization/collections/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // 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: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Validate the LayerZero channel configuration between adapters. This endpoint checks if the channel configuration is correct and returns any validation errors. + * @summary Validate LayerZero channel configuration + * @param {string} adapterTokenLinkId The token link ID of the adapter + * @param {string} peerAdapterTokenLinkId Peer adapter token link ID to validate against + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + validateLayerZeroChannelConfig: async (adapterTokenLinkId: string, peerAdapterTokenLinkId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('validateLayerZeroChannelConfig', 'adapterTokenLinkId', adapterTokenLinkId) + assertParamExistsAndNotEmpty('validateLayerZeroChannelConfig', 'peerAdapterTokenLinkId', peerAdapterTokenLinkId) + const localVarPath = `/tokenization/multichain/bridge/layerzero/validate`; + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (adapterTokenLinkId !== undefined) { + localVarQueryParameter['adapterTokenLinkId'] = adapterTokenLinkId; + } + + if (peerAdapterTokenLinkId !== undefined) { + localVarQueryParameter['peerAdapterTokenLinkId'] = peerAdapterTokenLinkId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TokenizationApi - functional programming interface + * @export + */ +export const TokenizationApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TokenizationApiAxiosParamCreator(configuration) + return { + /** + * Burn tokens in a collection + * @summary Burn tokens + * @param {CollectionBurnRequestDto} collectionBurnRequestDto + * @param {string} id The collection link id + * @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 burnCollectionToken(collectionBurnRequestDto: CollectionBurnRequestDto, id: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.burnCollectionToken(collectionBurnRequestDto, id, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.burnCollectionToken']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Create a new collection and link it as a token. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. + * @summary Create a new collection + * @param {CollectionDeployRequestDto} collectionDeployRequestDto + * @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 createNewCollection(collectionDeployRequestDto: CollectionDeployRequestDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNewCollection(collectionDeployRequestDto, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.createNewCollection']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Remove LayerZero adapters by deactivating and unlinking them. This endpoint revokes roles and deactivates the specified adapter contracts. + * @summary Remove LayerZero adapters + * @param {RemoveLayerZeroAdaptersRequest} removeLayerZeroAdaptersRequest + * @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 deactivateAndUnlinkAdapters(removeLayerZeroAdaptersRequest: RemoveLayerZeroAdaptersRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deactivateAndUnlinkAdapters(removeLayerZeroAdaptersRequest, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.deactivateAndUnlinkAdapters']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Deploy LayerZero adapters for multichain token bridging functionality. This endpoint creates adapter contracts that enable cross-chain token transfers. + * @summary Deploy LayerZero adapters + * @param {DeployLayerZeroAdaptersRequest} deployLayerZeroAdaptersRequest + * @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 deployAndLinkAdapters(deployLayerZeroAdaptersRequest: DeployLayerZeroAdaptersRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deployAndLinkAdapters(deployLayerZeroAdaptersRequest, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.deployAndLinkAdapters']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Get collection token details by id + * @summary Get collection token details + * @param {string} id The collection link id + * @param {string} tokenId The tokenId as it appears on the blockchain + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async fetchCollectionTokenDetails(id: string, tokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.fetchCollectionTokenDetails(id, tokenId, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.fetchCollectionTokenDetails']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Get a collection by id + * @summary Get a collection by id + * @param {string} id The token link id + * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getCollectionById(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { @@ -1234,6 +1786,174 @@ export const TokenizationApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['TokenizationApi.getLinkedTokensCount']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Returns the currently active addresses in the access registry (added but not removed). + * @summary Get current state of addresses in an access registry + * @param {string} id The token link id + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenAccessRegistryAddressesSortByEnum} [sortBy] Sorting field (enum). + * @param {GetTokenAccessRegistryAddressesOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenAccessRegistryAddresses(id: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenAccessRegistryAddressesSortByEnum, order?: GetTokenAccessRegistryAddressesOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenAccessRegistryAddresses(id, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenAccessRegistryAddresses']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns a summary of the current state of the access registry. + * @summary Get summary of an access registry + * @param {string} id The token link id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenAccessRegistrySummary(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenAccessRegistrySummary(id, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenAccessRegistrySummary']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns the latest token balance for the specified account address. + * @summary Get the latest balance for a specific account + * @param {string} id The token link id + * @param {string} accountAddress The account address to get balance history for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenBalanceForAccount(id: string, accountAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenBalanceForAccount(id, accountAddress, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenBalanceForAccount']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns paginated balance history for the specified account address with optional time-range filtering. + * @summary Get balance history for a specific account + * @param {string} id The token link id + * @param {string} accountAddress The account address to get balance history for + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {GetTokenBalanceHistoryIntervalEnum} [interval] Time interval for grouping data + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenBalanceHistorySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @param {GetTokenBalanceHistoryOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenBalanceHistory(id: string, accountAddress: string, startDate?: string, endDate?: string, interval?: GetTokenBalanceHistoryIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetTokenBalanceHistorySortByEnum, order?: GetTokenBalanceHistoryOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenBalanceHistory(id, accountAddress, startDate, endDate, interval, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenBalanceHistory']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns the latest balance for each unique address holding this token. + * @summary Get latest balances for all holders of a token + * @param {string} id The token link id + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenBalancesSortByEnum} [sortBy] Sorting field for balances + * @param {GetTokenBalancesOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenBalances(id: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenBalancesSortByEnum, order?: GetTokenBalancesOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenBalances(id, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenBalances']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns the total number of unique holders and the total supply for the token contract. + * @summary Get onchain summary for a token + * @param {string} id The token link id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenContractSummary(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenContractSummary(id, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenContractSummary']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns a list of currently active roles for the token contract. + * @summary Get active RBAC roles for a token + * @param {string} id The token link id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenRbac(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenRbac(id, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenRbac']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns paginated total supply history for the token contract with optional time-range filtering and binning. + * @summary Get historical total supply for a token + * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {GetTokenTotalSupplyIntervalEnum} [interval] Time interval for grouping data + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTotalSupplySortByEnum} [sortBy] Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @param {GetTokenTotalSupplyOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenTotalSupply(id: string, startDate?: string, endDate?: string, interval?: GetTokenTotalSupplyIntervalEnum, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTotalSupplySortByEnum, order?: GetTokenTotalSupplyOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenTotalSupply(id, startDate, endDate, interval, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenTotalSupply']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns a paginated list of onchain transactions for the token contract, optionally filtered by date range. + * @summary Get onchain transactions for a token + * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTransactionsSortByEnum} [sortBy] Sorting field (enum). + * @param {GetTokenTransactionsOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenTransactions(id: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTransactionsSortByEnum, order?: GetTokenTransactionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenTransactions(id, startDate, endDate, pageCursor, pageSize, sortBy, order, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenTransactions']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Returns a paginated list of ERC20 transfer events for the token contract, optionally filtered by date range. + * @summary Get onchain transfers for a token + * @param {string} id The token link id + * @param {string} [startDate] Start date of the time range in ISO 8601 format + * @param {string} [endDate] End date of the time range in ISO 8601 format + * @param {string} [pageCursor] Page cursor to get the next page + * @param {number} [pageSize] Number of items per page (max 100), requesting more than 100 will return 100 items + * @param {GetTokenTransfersSortByEnum} [sortBy] Sorting field for transfers + * @param {GetTokenTransfersOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {string} [sender] Filter transfers by sender address + * @param {string} [receiver] Filter transfers by receiver address + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTokenTransfers(id: string, startDate?: string, endDate?: string, pageCursor?: string, pageSize?: number, sortBy?: GetTokenTransfersSortByEnum, order?: GetTokenTransfersOrderEnum, sender?: string, receiver?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTokenTransfers(id, startDate, endDate, pageCursor, pageSize, sortBy, order, sender, receiver, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TokenizationApi.getTokenTransfers']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. * @summary Issue a new token @@ -1527,6 +2247,106 @@ export const TokenizationApiFactory = function (configuration?: Configuration, b getLinkedTokensCount(options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getLinkedTokensCount(options).then((request) => request(axios, basePath)); }, + /** + * Returns the currently active addresses in the access registry (added but not removed). + * @summary Get current state of addresses in an access registry + * @param {TokenizationApiGetTokenAccessRegistryAddressesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenAccessRegistryAddresses(requestParameters: TokenizationApiGetTokenAccessRegistryAddressesRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenAccessRegistryAddresses(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a summary of the current state of the access registry. + * @summary Get summary of an access registry + * @param {TokenizationApiGetTokenAccessRegistrySummaryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenAccessRegistrySummary(requestParameters: TokenizationApiGetTokenAccessRegistrySummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenAccessRegistrySummary(requestParameters.id, options).then((request) => request(axios, basePath)); + }, + /** + * Returns the latest token balance for the specified account address. + * @summary Get the latest balance for a specific account + * @param {TokenizationApiGetTokenBalanceForAccountRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenBalanceForAccount(requestParameters: TokenizationApiGetTokenBalanceForAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenBalanceForAccount(requestParameters.id, requestParameters.accountAddress, options).then((request) => request(axios, basePath)); + }, + /** + * Returns paginated balance history for the specified account address with optional time-range filtering. + * @summary Get balance history for a specific account + * @param {TokenizationApiGetTokenBalanceHistoryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenBalanceHistory(requestParameters: TokenizationApiGetTokenBalanceHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenBalanceHistory(requestParameters.id, requestParameters.accountAddress, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Returns the latest balance for each unique address holding this token. + * @summary Get latest balances for all holders of a token + * @param {TokenizationApiGetTokenBalancesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenBalances(requestParameters: TokenizationApiGetTokenBalancesRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenBalances(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Returns the total number of unique holders and the total supply for the token contract. + * @summary Get onchain summary for a token + * @param {TokenizationApiGetTokenContractSummaryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenContractSummary(requestParameters: TokenizationApiGetTokenContractSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenContractSummary(requestParameters.id, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of currently active roles for the token contract. + * @summary Get active RBAC roles for a token + * @param {TokenizationApiGetTokenRbacRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenRbac(requestParameters: TokenizationApiGetTokenRbacRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenRbac(requestParameters.id, options).then((request) => request(axios, basePath)); + }, + /** + * Returns paginated total supply history for the token contract with optional time-range filtering and binning. + * @summary Get historical total supply for a token + * @param {TokenizationApiGetTokenTotalSupplyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenTotalSupply(requestParameters: TokenizationApiGetTokenTotalSupplyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenTotalSupply(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a paginated list of onchain transactions for the token contract, optionally filtered by date range. + * @summary Get onchain transactions for a token + * @param {TokenizationApiGetTokenTransactionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenTransactions(requestParameters: TokenizationApiGetTokenTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenTransactions(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a paginated list of ERC20 transfer events for the token contract, optionally filtered by date range. + * @summary Get onchain transfers for a token + * @param {TokenizationApiGetTokenTransfersRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTokenTransfers(requestParameters: TokenizationApiGetTokenTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTokenTransfers(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.sender, requestParameters.receiver, options).then((request) => request(axios, basePath)); + }, /** * Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. * @summary Issue a new token @@ -1641,255 +2461,661 @@ export const TokenizationApiFactory = function (configuration?: Configuration, b }; /** - * Request parameters for burnCollectionToken operation in TokenizationApi. + * Request parameters for burnCollectionToken operation in TokenizationApi. + * @export + * @interface TokenizationApiBurnCollectionTokenRequest + */ +export interface TokenizationApiBurnCollectionTokenRequest { + /** + * + * @type {CollectionBurnRequestDto} + * @memberof TokenizationApiBurnCollectionToken + */ + readonly collectionBurnRequestDto: CollectionBurnRequestDto + + /** + * The collection link id + * @type {string} + * @memberof TokenizationApiBurnCollectionToken + */ + readonly id: 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 TokenizationApiBurnCollectionToken + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for createNewCollection operation in TokenizationApi. + * @export + * @interface TokenizationApiCreateNewCollectionRequest + */ +export interface TokenizationApiCreateNewCollectionRequest { + /** + * + * @type {CollectionDeployRequestDto} + * @memberof TokenizationApiCreateNewCollection + */ + readonly collectionDeployRequestDto: CollectionDeployRequestDto + + /** + * 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 TokenizationApiCreateNewCollection + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for deactivateAndUnlinkAdapters operation in TokenizationApi. + * @export + * @interface TokenizationApiDeactivateAndUnlinkAdaptersRequest + */ +export interface TokenizationApiDeactivateAndUnlinkAdaptersRequest { + /** + * + * @type {RemoveLayerZeroAdaptersRequest} + * @memberof TokenizationApiDeactivateAndUnlinkAdapters + */ + readonly removeLayerZeroAdaptersRequest: RemoveLayerZeroAdaptersRequest + + /** + * 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 TokenizationApiDeactivateAndUnlinkAdapters + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for deployAndLinkAdapters operation in TokenizationApi. + * @export + * @interface TokenizationApiDeployAndLinkAdaptersRequest + */ +export interface TokenizationApiDeployAndLinkAdaptersRequest { + /** + * + * @type {DeployLayerZeroAdaptersRequest} + * @memberof TokenizationApiDeployAndLinkAdapters + */ + readonly deployLayerZeroAdaptersRequest: DeployLayerZeroAdaptersRequest + + /** + * 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 TokenizationApiDeployAndLinkAdapters + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for fetchCollectionTokenDetails operation in TokenizationApi. + * @export + * @interface TokenizationApiFetchCollectionTokenDetailsRequest + */ +export interface TokenizationApiFetchCollectionTokenDetailsRequest { + /** + * The collection link id + * @type {string} + * @memberof TokenizationApiFetchCollectionTokenDetails + */ + readonly id: string + + /** + * The tokenId as it appears on the blockchain + * @type {string} + * @memberof TokenizationApiFetchCollectionTokenDetails + */ + readonly tokenId: string +} + +/** + * Request parameters for getCollectionById operation in TokenizationApi. * @export - * @interface TokenizationApiBurnCollectionTokenRequest + * @interface TokenizationApiGetCollectionByIdRequest */ -export interface TokenizationApiBurnCollectionTokenRequest { +export interface TokenizationApiGetCollectionByIdRequest { + /** + * The token link id + * @type {string} + * @memberof TokenizationApiGetCollectionById + */ + readonly id: string +} + +/** + * Request parameters for getDeployableAddress operation in TokenizationApi. + * @export + * @interface TokenizationApiGetDeployableAddressRequest + */ +export interface TokenizationApiGetDeployableAddressRequest { /** * - * @type {CollectionBurnRequestDto} - * @memberof TokenizationApiBurnCollectionToken + * @type {GetDeployableAddressRequest} + * @memberof TokenizationApiGetDeployableAddress */ - readonly collectionBurnRequestDto: CollectionBurnRequestDto + readonly getDeployableAddressRequest: GetDeployableAddressRequest /** - * The collection link id + * 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 TokenizationApiBurnCollectionToken + * @memberof TokenizationApiGetDeployableAddress + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for getLayerZeroDvnConfig operation in TokenizationApi. + * @export + * @interface TokenizationApiGetLayerZeroDvnConfigRequest + */ +export interface TokenizationApiGetLayerZeroDvnConfigRequest { + /** + * The token link id of the adapter token link + * @type {string} + * @memberof TokenizationApiGetLayerZeroDvnConfig + */ + readonly adapterTokenLinkId: string + + /** + * Optional peer adapter token link ID to filter results + * @type {string} + * @memberof TokenizationApiGetLayerZeroDvnConfig + */ + readonly peerAdapterTokenLinkId?: string +} + +/** + * Request parameters for getLayerZeroPeers operation in TokenizationApi. + * @export + * @interface TokenizationApiGetLayerZeroPeersRequest + */ +export interface TokenizationApiGetLayerZeroPeersRequest { + /** + * The token link id of the adapter token link + * @type {string} + * @memberof TokenizationApiGetLayerZeroPeers + */ + readonly adapterTokenLinkId: string +} + +/** + * Request parameters for getLinkedCollections operation in TokenizationApi. + * @export + * @interface TokenizationApiGetLinkedCollectionsRequest + */ +export interface TokenizationApiGetLinkedCollectionsRequest { + /** + * Page cursor to get the next page, for example - \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\" + * @type {string} + * @memberof TokenizationApiGetLinkedCollections + */ + readonly pageCursor?: string + + /** + * Number of items per page (max 100), requesting more then 100 will return 100 items + * @type {number} + * @memberof TokenizationApiGetLinkedCollections + */ + readonly pageSize?: number + + /** + * A comma separated list of statuses to filter. Default is \"COMPLETED\" + * @type {any} + * @memberof TokenizationApiGetLinkedCollections + */ + readonly status?: any +} + +/** + * Request parameters for getLinkedToken operation in TokenizationApi. + * @export + * @interface TokenizationApiGetLinkedTokenRequest + */ +export interface TokenizationApiGetLinkedTokenRequest { + /** + * The token link id + * @type {string} + * @memberof TokenizationApiGetLinkedToken */ readonly id: string +} +/** + * Request parameters for getLinkedTokens operation in TokenizationApi. + * @export + * @interface TokenizationApiGetLinkedTokensRequest + */ +export interface TokenizationApiGetLinkedTokensRequest { /** - * 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. + * Page cursor to get the next page * @type {string} - * @memberof TokenizationApiBurnCollectionToken + * @memberof TokenizationApiGetLinkedTokens */ - readonly idempotencyKey?: string + readonly pageCursor?: string + + /** + * Number of items per page, requesting more then max will return max items + * @type {number} + * @memberof TokenizationApiGetLinkedTokens + */ + readonly pageSize?: number + + /** + * A comma separated list of statuses to filter. Default is \"COMPLETED\" + * @type {any} + * @memberof TokenizationApiGetLinkedTokens + */ + readonly status?: any } /** - * Request parameters for createNewCollection operation in TokenizationApi. + * Request parameters for getTokenAccessRegistryAddresses operation in TokenizationApi. * @export - * @interface TokenizationApiCreateNewCollectionRequest + * @interface TokenizationApiGetTokenAccessRegistryAddressesRequest */ -export interface TokenizationApiCreateNewCollectionRequest { +export interface TokenizationApiGetTokenAccessRegistryAddressesRequest { /** - * - * @type {CollectionDeployRequestDto} - * @memberof TokenizationApiCreateNewCollection + * The token link id + * @type {string} + * @memberof TokenizationApiGetTokenAccessRegistryAddresses */ - readonly collectionDeployRequestDto: CollectionDeployRequestDto + readonly id: 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. + * Page cursor to get the next page * @type {string} - * @memberof TokenizationApiCreateNewCollection + * @memberof TokenizationApiGetTokenAccessRegistryAddresses */ - readonly idempotencyKey?: string + readonly pageCursor?: string + + /** + * Number of items per page (max 100), requesting more than 100 will return 100 items + * @type {number} + * @memberof TokenizationApiGetTokenAccessRegistryAddresses + */ + readonly pageSize?: number + + /** + * Sorting field (enum). + * @type {'dateAdded' | 'address'} + * @memberof TokenizationApiGetTokenAccessRegistryAddresses + */ + readonly sortBy?: GetTokenAccessRegistryAddressesSortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenAccessRegistryAddresses + */ + readonly order?: GetTokenAccessRegistryAddressesOrderEnum } /** - * Request parameters for deactivateAndUnlinkAdapters operation in TokenizationApi. + * Request parameters for getTokenAccessRegistrySummary operation in TokenizationApi. * @export - * @interface TokenizationApiDeactivateAndUnlinkAdaptersRequest + * @interface TokenizationApiGetTokenAccessRegistrySummaryRequest */ -export interface TokenizationApiDeactivateAndUnlinkAdaptersRequest { +export interface TokenizationApiGetTokenAccessRegistrySummaryRequest { /** - * - * @type {RemoveLayerZeroAdaptersRequest} - * @memberof TokenizationApiDeactivateAndUnlinkAdapters + * The token link id + * @type {string} + * @memberof TokenizationApiGetTokenAccessRegistrySummary */ - readonly removeLayerZeroAdaptersRequest: RemoveLayerZeroAdaptersRequest + readonly id: string +} +/** + * Request parameters for getTokenBalanceForAccount operation in TokenizationApi. + * @export + * @interface TokenizationApiGetTokenBalanceForAccountRequest + */ +export interface TokenizationApiGetTokenBalanceForAccountRequest { /** - * 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. + * The token link id * @type {string} - * @memberof TokenizationApiDeactivateAndUnlinkAdapters + * @memberof TokenizationApiGetTokenBalanceForAccount + */ + readonly id: string + + /** + * The account address to get balance history for + * @type {string} + * @memberof TokenizationApiGetTokenBalanceForAccount + */ + readonly accountAddress: string +} + +/** + * Request parameters for getTokenBalanceHistory operation in TokenizationApi. + * @export + * @interface TokenizationApiGetTokenBalanceHistoryRequest + */ +export interface TokenizationApiGetTokenBalanceHistoryRequest { + /** + * The token link id + * @type {string} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly id: string + + /** + * The account address to get balance history for + * @type {string} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly accountAddress: string + + /** + * Start date of the time range in ISO 8601 format + * @type {string} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly startDate?: string + + /** + * End date of the time range in ISO 8601 format + * @type {string} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly endDate?: string + + /** + * Time interval for grouping data + * @type {'HOUR' | 'DAY' | 'WEEK' | 'MONTH'} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly interval?: GetTokenBalanceHistoryIntervalEnum + + /** + * Page cursor to get the next page + * @type {string} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly pageCursor?: string + + /** + * Number of items per page (max 100), requesting more than 100 will return 100 items + * @type {number} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly pageSize?: number + + /** + * Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @type {'blockTimestamp'} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly sortBy?: GetTokenBalanceHistorySortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenBalanceHistory + */ + readonly order?: GetTokenBalanceHistoryOrderEnum +} + +/** + * Request parameters for getTokenBalances operation in TokenizationApi. + * @export + * @interface TokenizationApiGetTokenBalancesRequest + */ +export interface TokenizationApiGetTokenBalancesRequest { + /** + * The token link id + * @type {string} + * @memberof TokenizationApiGetTokenBalances + */ + readonly id: string + + /** + * Page cursor to get the next page + * @type {string} + * @memberof TokenizationApiGetTokenBalances + */ + readonly pageCursor?: string + + /** + * Number of items per page (max 100), requesting more than 100 will return 100 items + * @type {number} + * @memberof TokenizationApiGetTokenBalances + */ + readonly pageSize?: number + + /** + * Sorting field for balances + * @type {'accountAddress' | 'blockTimestamp'} + * @memberof TokenizationApiGetTokenBalances + */ + readonly sortBy?: GetTokenBalancesSortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenBalances */ - readonly idempotencyKey?: string + readonly order?: GetTokenBalancesOrderEnum } /** - * Request parameters for deployAndLinkAdapters operation in TokenizationApi. + * Request parameters for getTokenContractSummary operation in TokenizationApi. * @export - * @interface TokenizationApiDeployAndLinkAdaptersRequest + * @interface TokenizationApiGetTokenContractSummaryRequest */ -export interface TokenizationApiDeployAndLinkAdaptersRequest { +export interface TokenizationApiGetTokenContractSummaryRequest { /** - * - * @type {DeployLayerZeroAdaptersRequest} - * @memberof TokenizationApiDeployAndLinkAdapters + * The token link id + * @type {string} + * @memberof TokenizationApiGetTokenContractSummary */ - readonly deployLayerZeroAdaptersRequest: DeployLayerZeroAdaptersRequest + readonly id: string +} +/** + * Request parameters for getTokenRbac operation in TokenizationApi. + * @export + * @interface TokenizationApiGetTokenRbacRequest + */ +export interface TokenizationApiGetTokenRbacRequest { /** - * 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. + * The token link id * @type {string} - * @memberof TokenizationApiDeployAndLinkAdapters + * @memberof TokenizationApiGetTokenRbac */ - readonly idempotencyKey?: string + readonly id: string } /** - * Request parameters for fetchCollectionTokenDetails operation in TokenizationApi. + * Request parameters for getTokenTotalSupply operation in TokenizationApi. * @export - * @interface TokenizationApiFetchCollectionTokenDetailsRequest + * @interface TokenizationApiGetTokenTotalSupplyRequest */ -export interface TokenizationApiFetchCollectionTokenDetailsRequest { +export interface TokenizationApiGetTokenTotalSupplyRequest { /** - * The collection link id + * The token link id * @type {string} - * @memberof TokenizationApiFetchCollectionTokenDetails + * @memberof TokenizationApiGetTokenTotalSupply */ readonly id: string /** - * The tokenId as it appears on the blockchain + * Start date of the time range in ISO 8601 format * @type {string} - * @memberof TokenizationApiFetchCollectionTokenDetails + * @memberof TokenizationApiGetTokenTotalSupply */ - readonly tokenId: string -} + readonly startDate?: string -/** - * Request parameters for getCollectionById operation in TokenizationApi. - * @export - * @interface TokenizationApiGetCollectionByIdRequest - */ -export interface TokenizationApiGetCollectionByIdRequest { /** - * The token link id + * End date of the time range in ISO 8601 format * @type {string} - * @memberof TokenizationApiGetCollectionById + * @memberof TokenizationApiGetTokenTotalSupply */ - readonly id: string -} + readonly endDate?: string -/** - * Request parameters for getDeployableAddress operation in TokenizationApi. - * @export - * @interface TokenizationApiGetDeployableAddressRequest - */ -export interface TokenizationApiGetDeployableAddressRequest { /** - * - * @type {GetDeployableAddressRequest} - * @memberof TokenizationApiGetDeployableAddress + * Time interval for grouping data + * @type {'HOUR' | 'DAY' | 'WEEK' | 'MONTH'} + * @memberof TokenizationApiGetTokenTotalSupply */ - readonly getDeployableAddressRequest: GetDeployableAddressRequest + readonly interval?: GetTokenTotalSupplyIntervalEnum /** - * 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. + * Page cursor to get the next page * @type {string} - * @memberof TokenizationApiGetDeployableAddress + * @memberof TokenizationApiGetTokenTotalSupply */ - readonly idempotencyKey?: string + readonly pageCursor?: string + + /** + * Number of items per page (max 100), requesting more than 100 will return 100 items + * @type {number} + * @memberof TokenizationApiGetTokenTotalSupply + */ + readonly pageSize?: number + + /** + * Sorting field (enum). Sorting only supported by \'blockTimestamp\' + * @type {'blockTimestamp'} + * @memberof TokenizationApiGetTokenTotalSupply + */ + readonly sortBy?: GetTokenTotalSupplySortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenTotalSupply + */ + readonly order?: GetTokenTotalSupplyOrderEnum } /** - * Request parameters for getLayerZeroDvnConfig operation in TokenizationApi. + * Request parameters for getTokenTransactions operation in TokenizationApi. * @export - * @interface TokenizationApiGetLayerZeroDvnConfigRequest + * @interface TokenizationApiGetTokenTransactionsRequest */ -export interface TokenizationApiGetLayerZeroDvnConfigRequest { +export interface TokenizationApiGetTokenTransactionsRequest { /** - * The token link id of the adapter token link + * The token link id * @type {string} - * @memberof TokenizationApiGetLayerZeroDvnConfig + * @memberof TokenizationApiGetTokenTransactions */ - readonly adapterTokenLinkId: string + readonly id: string /** - * Optional peer adapter token link ID to filter results + * Start date of the time range in ISO 8601 format * @type {string} - * @memberof TokenizationApiGetLayerZeroDvnConfig + * @memberof TokenizationApiGetTokenTransactions */ - readonly peerAdapterTokenLinkId?: string -} + readonly startDate?: string -/** - * Request parameters for getLayerZeroPeers operation in TokenizationApi. - * @export - * @interface TokenizationApiGetLayerZeroPeersRequest - */ -export interface TokenizationApiGetLayerZeroPeersRequest { /** - * The token link id of the adapter token link + * End date of the time range in ISO 8601 format * @type {string} - * @memberof TokenizationApiGetLayerZeroPeers + * @memberof TokenizationApiGetTokenTransactions */ - readonly adapterTokenLinkId: string -} + readonly endDate?: string -/** - * Request parameters for getLinkedCollections operation in TokenizationApi. - * @export - * @interface TokenizationApiGetLinkedCollectionsRequest - */ -export interface TokenizationApiGetLinkedCollectionsRequest { /** - * Page cursor to get the next page, for example - \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\" + * Page cursor to get the next page * @type {string} - * @memberof TokenizationApiGetLinkedCollections + * @memberof TokenizationApiGetTokenTransactions */ readonly pageCursor?: string /** - * Number of items per page (max 100), requesting more then 100 will return 100 items + * Number of items per page (max 100), requesting more than 100 will return 100 items * @type {number} - * @memberof TokenizationApiGetLinkedCollections + * @memberof TokenizationApiGetTokenTransactions */ readonly pageSize?: number /** - * A comma separated list of statuses to filter. Default is \"COMPLETED\" - * @type {any} - * @memberof TokenizationApiGetLinkedCollections + * Sorting field (enum). + * @type {'blockTimestamp' | 'blockNumber' | 'transactionHash'} + * @memberof TokenizationApiGetTokenTransactions */ - readonly status?: any + readonly sortBy?: GetTokenTransactionsSortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenTransactions + */ + readonly order?: GetTokenTransactionsOrderEnum } /** - * Request parameters for getLinkedToken operation in TokenizationApi. + * Request parameters for getTokenTransfers operation in TokenizationApi. * @export - * @interface TokenizationApiGetLinkedTokenRequest + * @interface TokenizationApiGetTokenTransfersRequest */ -export interface TokenizationApiGetLinkedTokenRequest { +export interface TokenizationApiGetTokenTransfersRequest { /** * The token link id * @type {string} - * @memberof TokenizationApiGetLinkedToken + * @memberof TokenizationApiGetTokenTransfers */ readonly id: string -} -/** - * Request parameters for getLinkedTokens operation in TokenizationApi. - * @export - * @interface TokenizationApiGetLinkedTokensRequest - */ -export interface TokenizationApiGetLinkedTokensRequest { + /** + * Start date of the time range in ISO 8601 format + * @type {string} + * @memberof TokenizationApiGetTokenTransfers + */ + readonly startDate?: string + + /** + * End date of the time range in ISO 8601 format + * @type {string} + * @memberof TokenizationApiGetTokenTransfers + */ + readonly endDate?: string + /** * Page cursor to get the next page * @type {string} - * @memberof TokenizationApiGetLinkedTokens + * @memberof TokenizationApiGetTokenTransfers */ readonly pageCursor?: string /** - * Number of items per page, requesting more then max will return max items + * Number of items per page (max 100), requesting more than 100 will return 100 items * @type {number} - * @memberof TokenizationApiGetLinkedTokens + * @memberof TokenizationApiGetTokenTransfers */ readonly pageSize?: number /** - * A comma separated list of statuses to filter. Default is \"COMPLETED\" - * @type {any} - * @memberof TokenizationApiGetLinkedTokens + * Sorting field for transfers + * @type {'blockTimeStamp'} + * @memberof TokenizationApiGetTokenTransfers */ - readonly status?: any + readonly sortBy?: GetTokenTransfersSortByEnum + + /** + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof TokenizationApiGetTokenTransfers + */ + readonly order?: GetTokenTransfersOrderEnum + + /** + * Filter transfers by sender address + * @type {string} + * @memberof TokenizationApiGetTokenTransfers + */ + readonly sender?: string + + /** + * Filter transfers by receiver address + * @type {string} + * @memberof TokenizationApiGetTokenTransfers + */ + readonly receiver?: string } /** @@ -2285,6 +3511,126 @@ export class TokenizationApi extends BaseAPI { return TokenizationApiFp(this.configuration).getLinkedTokensCount().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Returns the currently active addresses in the access registry (added but not removed). + * @summary Get current state of addresses in an access registry + * @param {TokenizationApiGetTokenAccessRegistryAddressesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenAccessRegistryAddresses(requestParameters: TokenizationApiGetTokenAccessRegistryAddressesRequest) { + return TokenizationApiFp(this.configuration).getTokenAccessRegistryAddresses(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns a summary of the current state of the access registry. + * @summary Get summary of an access registry + * @param {TokenizationApiGetTokenAccessRegistrySummaryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenAccessRegistrySummary(requestParameters: TokenizationApiGetTokenAccessRegistrySummaryRequest) { + return TokenizationApiFp(this.configuration).getTokenAccessRegistrySummary(requestParameters.id).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns the latest token balance for the specified account address. + * @summary Get the latest balance for a specific account + * @param {TokenizationApiGetTokenBalanceForAccountRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenBalanceForAccount(requestParameters: TokenizationApiGetTokenBalanceForAccountRequest) { + return TokenizationApiFp(this.configuration).getTokenBalanceForAccount(requestParameters.id, requestParameters.accountAddress).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns paginated balance history for the specified account address with optional time-range filtering. + * @summary Get balance history for a specific account + * @param {TokenizationApiGetTokenBalanceHistoryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenBalanceHistory(requestParameters: TokenizationApiGetTokenBalanceHistoryRequest) { + return TokenizationApiFp(this.configuration).getTokenBalanceHistory(requestParameters.id, requestParameters.accountAddress, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns the latest balance for each unique address holding this token. + * @summary Get latest balances for all holders of a token + * @param {TokenizationApiGetTokenBalancesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenBalances(requestParameters: TokenizationApiGetTokenBalancesRequest) { + return TokenizationApiFp(this.configuration).getTokenBalances(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns the total number of unique holders and the total supply for the token contract. + * @summary Get onchain summary for a token + * @param {TokenizationApiGetTokenContractSummaryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenContractSummary(requestParameters: TokenizationApiGetTokenContractSummaryRequest) { + return TokenizationApiFp(this.configuration).getTokenContractSummary(requestParameters.id).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns a list of currently active roles for the token contract. + * @summary Get active RBAC roles for a token + * @param {TokenizationApiGetTokenRbacRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenRbac(requestParameters: TokenizationApiGetTokenRbacRequest) { + return TokenizationApiFp(this.configuration).getTokenRbac(requestParameters.id).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns paginated total supply history for the token contract with optional time-range filtering and binning. + * @summary Get historical total supply for a token + * @param {TokenizationApiGetTokenTotalSupplyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenTotalSupply(requestParameters: TokenizationApiGetTokenTotalSupplyRequest) { + return TokenizationApiFp(this.configuration).getTokenTotalSupply(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.interval, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns a paginated list of onchain transactions for the token contract, optionally filtered by date range. + * @summary Get onchain transactions for a token + * @param {TokenizationApiGetTokenTransactionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenTransactions(requestParameters: TokenizationApiGetTokenTransactionsRequest) { + return TokenizationApiFp(this.configuration).getTokenTransactions(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Returns a paginated list of ERC20 transfer events for the token contract, optionally filtered by date range. + * @summary Get onchain transfers for a token + * @param {TokenizationApiGetTokenTransfersRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TokenizationApi + */ + public getTokenTransfers(requestParameters: TokenizationApiGetTokenTransfersRequest) { + return TokenizationApiFp(this.configuration).getTokenTransfers(requestParameters.id, requestParameters.startDate, requestParameters.endDate, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.sender, requestParameters.receiver).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status \"PENDING\" until the token is deployed or \"SUCCESS\" if no deployment is needed. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor. * @summary Issue a new token @@ -2418,3 +3764,117 @@ export class TokenizationApi extends BaseAPI { } } +/** + * @export + */ +export const GetTokenAccessRegistryAddressesSortByEnum = { + DateAdded: 'dateAdded', + Address: 'address' +} as const; +export type GetTokenAccessRegistryAddressesSortByEnum = typeof GetTokenAccessRegistryAddressesSortByEnum[keyof typeof GetTokenAccessRegistryAddressesSortByEnum]; +/** + * @export + */ +export const GetTokenAccessRegistryAddressesOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenAccessRegistryAddressesOrderEnum = typeof GetTokenAccessRegistryAddressesOrderEnum[keyof typeof GetTokenAccessRegistryAddressesOrderEnum]; +/** + * @export + */ +export const GetTokenBalanceHistoryIntervalEnum = { + Hour: 'HOUR', + Day: 'DAY', + Week: 'WEEK', + Month: 'MONTH' +} as const; +export type GetTokenBalanceHistoryIntervalEnum = typeof GetTokenBalanceHistoryIntervalEnum[keyof typeof GetTokenBalanceHistoryIntervalEnum]; +/** + * @export + */ +export const GetTokenBalanceHistorySortByEnum = { + BlockTimestamp: 'blockTimestamp' +} as const; +export type GetTokenBalanceHistorySortByEnum = typeof GetTokenBalanceHistorySortByEnum[keyof typeof GetTokenBalanceHistorySortByEnum]; +/** + * @export + */ +export const GetTokenBalanceHistoryOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenBalanceHistoryOrderEnum = typeof GetTokenBalanceHistoryOrderEnum[keyof typeof GetTokenBalanceHistoryOrderEnum]; +/** + * @export + */ +export const GetTokenBalancesSortByEnum = { + AccountAddress: 'accountAddress', + BlockTimestamp: 'blockTimestamp' +} as const; +export type GetTokenBalancesSortByEnum = typeof GetTokenBalancesSortByEnum[keyof typeof GetTokenBalancesSortByEnum]; +/** + * @export + */ +export const GetTokenBalancesOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenBalancesOrderEnum = typeof GetTokenBalancesOrderEnum[keyof typeof GetTokenBalancesOrderEnum]; +/** + * @export + */ +export const GetTokenTotalSupplyIntervalEnum = { + Hour: 'HOUR', + Day: 'DAY', + Week: 'WEEK', + Month: 'MONTH' +} as const; +export type GetTokenTotalSupplyIntervalEnum = typeof GetTokenTotalSupplyIntervalEnum[keyof typeof GetTokenTotalSupplyIntervalEnum]; +/** + * @export + */ +export const GetTokenTotalSupplySortByEnum = { + BlockTimestamp: 'blockTimestamp' +} as const; +export type GetTokenTotalSupplySortByEnum = typeof GetTokenTotalSupplySortByEnum[keyof typeof GetTokenTotalSupplySortByEnum]; +/** + * @export + */ +export const GetTokenTotalSupplyOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenTotalSupplyOrderEnum = typeof GetTokenTotalSupplyOrderEnum[keyof typeof GetTokenTotalSupplyOrderEnum]; +/** + * @export + */ +export const GetTokenTransactionsSortByEnum = { + BlockTimestamp: 'blockTimestamp', + BlockNumber: 'blockNumber', + TransactionHash: 'transactionHash' +} as const; +export type GetTokenTransactionsSortByEnum = typeof GetTokenTransactionsSortByEnum[keyof typeof GetTokenTransactionsSortByEnum]; +/** + * @export + */ +export const GetTokenTransactionsOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenTransactionsOrderEnum = typeof GetTokenTransactionsOrderEnum[keyof typeof GetTokenTransactionsOrderEnum]; +/** + * @export + */ +export const GetTokenTransfersSortByEnum = { + BlockTimeStamp: 'blockTimeStamp' +} as const; +export type GetTokenTransfersSortByEnum = typeof GetTokenTransfersSortByEnum[keyof typeof GetTokenTransfersSortByEnum]; +/** + * @export + */ +export const GetTokenTransfersOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetTokenTransfersOrderEnum = typeof GetTokenTransfersOrderEnum[keyof typeof GetTokenTransfersOrderEnum]; diff --git a/api/trading-beta-api.ts b/api/trading-beta-api.ts index d3ec1952..1504676c 100644 --- a/api/trading-beta-api.ts +++ b/api/trading-beta-api.ts @@ -41,6 +41,8 @@ import { OffersResponse } from '../models'; // @ts-ignore import { OrderDetails } from '../models'; // @ts-ignore +import { OrderRequirementDetails } from '../models'; +// @ts-ignore import { OrderStatus } from '../models'; // @ts-ignore import { ProvidersListResponse } from '../models'; @@ -51,6 +53,8 @@ import { RatesRequest } from '../models'; // @ts-ignore import { RatesResponse } from '../models'; // @ts-ignore +import { SubmitOrderRequirementRequest } from '../models'; +// @ts-ignore import { TradingErrorSchema } from '../models'; // @ts-ignore import { TradingProvider } from '../models'; @@ -244,6 +248,39 @@ export const TradingBetaApiAxiosParamCreator = function (configuration?: Configu + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Get order requirement details for an order + * @param {string} orderId The ID of the order for which the order requirement is issued. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrderRequirements: async (orderId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getOrderRequirements', 'orderId', orderId) + const localVarPath = `/trading/orders/{orderId}/requirement` + .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId))); + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -397,6 +434,103 @@ export const TradingBetaApiAxiosParamCreator = function (configuration?: Configu let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Submit the user\'s textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Submit a response to an order requirement + * @param {SubmitOrderRequirementRequest} submitOrderRequirementRequest + * @param {string} orderId The ID of the order to submit the order requirement response for. + * @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} + */ + submitOrderRequirements: async (submitOrderRequirementRequest: SubmitOrderRequirementRequest, orderId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('submitOrderRequirements', 'submitOrderRequirementRequest', submitOrderRequirementRequest) + assertParamExistsAndNotEmpty('submitOrderRequirements', 'orderId', orderId) + const localVarPath = `/trading/orders/{orderId}/requirement/data` + .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId))); + // 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(submitOrderRequirementRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. Send `fileKey` (matching a `fileKey` from `requiredFiles` on the GET response) and the binary `file`. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via `POST /trading/orders/{orderId}/requirement/data`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Upload a file for an order requirement + * @param {string} fileKey Identifier of the required file this upload satisfies. Must match a `fileKey` from `requiredFiles` on the GET response. + * @param {File} file The binary file content. The file\\\'s type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part. + * @param {string} orderId The ID of the order to upload the order requirement file for. + * @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} + */ + uploadOrderRequirementFile: async (fileKey: string, file: File, orderId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('uploadOrderRequirementFile', 'fileKey', fileKey) + assertParamExists('uploadOrderRequirementFile', 'file', file) + assertParamExistsAndNotEmpty('uploadOrderRequirementFile', 'orderId', orderId) + const localVarPath = `/trading/orders/{orderId}/requirement/file` + .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId))); + // 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; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + if (idempotencyKey != null) { + localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + } + + + if (fileKey !== undefined) { + localVarFormParams.append('fileKey', fileKey as any); + } + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = localVarFormParams; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -481,6 +615,19 @@ export const TradingBetaApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['TradingBetaApi.getOrder']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Get order requirement details for an order + * @param {string} orderId The ID of the order for which the order requirement is issued. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getOrderRequirements(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderRequirements(orderId, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TradingBetaApi.getOrderRequirements']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range. Note:These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get orders @@ -529,6 +676,37 @@ export const TradingBetaApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['TradingBetaApi.getTradingProviders']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Submit the user\'s textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Submit a response to an order requirement + * @param {SubmitOrderRequirementRequest} submitOrderRequirementRequest + * @param {string} orderId The ID of the order to submit the order requirement response for. + * @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 submitOrderRequirements(submitOrderRequirementRequest: SubmitOrderRequirementRequest, orderId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitOrderRequirements(submitOrderRequirementRequest, orderId, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TradingBetaApi.submitOrderRequirements']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. Send `fileKey` (matching a `fileKey` from `requiredFiles` on the GET response) and the binary `file`. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via `POST /trading/orders/{orderId}/requirement/data`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Upload a file for an order requirement + * @param {string} fileKey Identifier of the required file this upload satisfies. Must match a `fileKey` from `requiredFiles` on the GET response. + * @param {File} file The binary file content. The file\\\'s type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part. + * @param {string} orderId The ID of the order to upload the order requirement file for. + * @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 uploadOrderRequirementFile(fileKey: string, file: File, orderId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.uploadOrderRequirementFile(fileKey, file, orderId, idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TradingBetaApi.uploadOrderRequirementFile']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, } }; @@ -589,6 +767,16 @@ export const TradingBetaApiFactory = function (configuration?: Configuration, ba getOrder(requestParameters: TradingBetaApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath)); }, + /** + * Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Get order requirement details for an order + * @param {TradingBetaApiGetOrderRequirementsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrderRequirements(requestParameters: TradingBetaApiGetOrderRequirementsRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getOrderRequirements(requestParameters.orderId, options).then((request) => request(axios, basePath)); + }, /** * Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range. Note:These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get orders @@ -619,6 +807,26 @@ export const TradingBetaApiFactory = function (configuration?: Configuration, ba getTradingProviders(requestParameters: TradingBetaApiGetTradingProvidersRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getTradingProviders(requestParameters.pageSize, requestParameters.pageCursor, options).then((request) => request(axios, basePath)); }, + /** + * Submit the user\'s textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Submit a response to an order requirement + * @param {TradingBetaApiSubmitOrderRequirementsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitOrderRequirements(requestParameters: TradingBetaApiSubmitOrderRequirementsRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitOrderRequirements(requestParameters.submitOrderRequirementRequest, requestParameters.orderId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, + /** + * Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. Send `fileKey` (matching a `fileKey` from `requiredFiles` on the GET response) and the binary `file`. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via `POST /trading/orders/{orderId}/requirement/data`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Upload a file for an order requirement + * @param {TradingBetaApiUploadOrderRequirementFileRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + uploadOrderRequirementFile(requestParameters: TradingBetaApiUploadOrderRequirementFileRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.uploadOrderRequirementFile(requestParameters.fileKey, requestParameters.file, requestParameters.orderId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, }; }; @@ -720,6 +928,20 @@ export interface TradingBetaApiGetOrderRequest { readonly orderId: string } +/** + * Request parameters for getOrderRequirements operation in TradingBetaApi. + * @export + * @interface TradingBetaApiGetOrderRequirementsRequest + */ +export interface TradingBetaApiGetOrderRequirementsRequest { + /** + * The ID of the order for which the order requirement is issued. + * @type {string} + * @memberof TradingBetaApiGetOrderRequirements + */ + readonly orderId: string +} + /** * Request parameters for getOrders operation in TradingBetaApi. * @export @@ -825,6 +1047,69 @@ export interface TradingBetaApiGetTradingProvidersRequest { readonly pageCursor?: string } +/** + * Request parameters for submitOrderRequirements operation in TradingBetaApi. + * @export + * @interface TradingBetaApiSubmitOrderRequirementsRequest + */ +export interface TradingBetaApiSubmitOrderRequirementsRequest { + /** + * + * @type {SubmitOrderRequirementRequest} + * @memberof TradingBetaApiSubmitOrderRequirements + */ + readonly submitOrderRequirementRequest: SubmitOrderRequirementRequest + + /** + * The ID of the order to submit the order requirement response for. + * @type {string} + * @memberof TradingBetaApiSubmitOrderRequirements + */ + readonly orderId: 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 TradingBetaApiSubmitOrderRequirements + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for uploadOrderRequirementFile operation in TradingBetaApi. + * @export + * @interface TradingBetaApiUploadOrderRequirementFileRequest + */ +export interface TradingBetaApiUploadOrderRequirementFileRequest { + /** + * Identifier of the required file this upload satisfies. Must match a `fileKey` from `requiredFiles` on the GET response. + * @type {string} + * @memberof TradingBetaApiUploadOrderRequirementFile + */ + readonly fileKey: string + + /** + * The binary file content. The file\\\'s type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part. + * @type {File} + * @memberof TradingBetaApiUploadOrderRequirementFile + */ + readonly file: File + + /** + * The ID of the order to upload the order requirement file for. + * @type {string} + * @memberof TradingBetaApiUploadOrderRequirementFile + */ + readonly orderId: 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 TradingBetaApiUploadOrderRequirementFile + */ + readonly idempotencyKey?: string +} + /** * TradingBetaApi - object-oriented interface * @export @@ -892,6 +1177,18 @@ export class TradingBetaApi extends BaseAPI { return TradingBetaApiFp(this.configuration).getOrder(requestParameters.orderId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Get order requirement details for an order + * @param {TradingBetaApiGetOrderRequirementsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradingBetaApi + */ + public getOrderRequirements(requestParameters: TradingBetaApiGetOrderRequirementsRequest) { + return TradingBetaApiFp(this.configuration).getOrderRequirements(requestParameters.orderId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range. Note:These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get orders @@ -927,6 +1224,30 @@ export class TradingBetaApi extends BaseAPI { public getTradingProviders(requestParameters: TradingBetaApiGetTradingProvidersRequest = {}) { return TradingBetaApiFp(this.configuration).getTradingProviders(requestParameters.pageSize, requestParameters.pageCursor).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + + /** + * Submit the user\'s textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Submit a response to an order requirement + * @param {TradingBetaApiSubmitOrderRequirementsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradingBetaApi + */ + public submitOrderRequirements(requestParameters: TradingBetaApiSubmitOrderRequirementsRequest) { + return TradingBetaApiFp(this.configuration).submitOrderRequirements(requestParameters.submitOrderRequirementRequest, requestParameters.orderId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. Send `fileKey` (matching a `fileKey` from `requiredFiles` on the GET response) and the binary `file`. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via `POST /trading/orders/{orderId}/requirement/data`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * @summary Upload a file for an order requirement + * @param {TradingBetaApiUploadOrderRequirementFileRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradingBetaApi + */ + public uploadOrderRequirementFile(requestParameters: TradingBetaApiUploadOrderRequirementFileRequest) { + return TradingBetaApiFp(this.configuration).uploadOrderRequirementFile(requestParameters.fileKey, requestParameters.file, requestParameters.orderId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } } /** diff --git a/api/transactions-api.ts b/api/transactions-api.ts index 15d39f52..52703484 100644 --- a/api/transactions-api.ts +++ b/api/transactions-api.ts @@ -1253,7 +1253,7 @@ export interface TransactionsApiGetTransactionsRequest { /** * The source type of the transaction - * @type {'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET'} + * @type {'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET' | 'WALLET_POOL'} * @memberof TransactionsApiGetTransactions */ readonly sourceType?: GetTransactionsSourceTypeEnum @@ -1607,7 +1607,8 @@ export const GetTransactionsSourceTypeEnum = { Compound: 'COMPOUND', Unknown: 'UNKNOWN', GasStation: 'GAS_STATION', - EndUserWallet: 'END_USER_WALLET' + EndUserWallet: 'END_USER_WALLET', + WalletPool: 'WALLET_POOL' } as const; export type GetTransactionsSourceTypeEnum = typeof GetTransactionsSourceTypeEnum[keyof typeof GetTransactionsSourceTypeEnum]; /** diff --git a/api/webhooks-v2-api.ts b/api/webhooks-v2-api.ts index 63481ed0..174bafdd 100644 --- a/api/webhooks-v2-api.ts +++ b/api/webhooks-v2-api.ts @@ -59,6 +59,8 @@ import { WebhookEvent } from '../models'; // @ts-ignore import { WebhookMetric } from '../models'; // @ts-ignore +import { WebhookMtlsCsrResponse } from '../models'; +// @ts-ignore import { WebhookPaginatedResponse } from '../models'; /** * WebhooksV2Api - axios parameter creator @@ -166,6 +168,36 @@ export const WebhooksV2ApiAxiosParamCreator = function (configuration?: Configur + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns the Fireblocks Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. + * @summary Get mTLS CSR + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getMtlsCsr: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/webhooks/mtls/csr`; + // 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: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -749,6 +781,18 @@ export const WebhooksV2ApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['WebhooksV2Api.getMetrics']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Returns the Fireblocks Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. + * @summary Get mTLS CSR + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getMtlsCsr(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMtlsCsr(options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['WebhooksV2Api.getMtlsCsr']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Get notification by id * @summary Get notification by id @@ -972,6 +1016,15 @@ export const WebhooksV2ApiFactory = function (configuration?: Configuration, bas getMetrics(requestParameters: WebhooksV2ApiGetMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getMetrics(requestParameters.webhookId, requestParameters.metricName, options).then((request) => request(axios, basePath)); }, + /** + * Returns the Fireblocks Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. + * @summary Get mTLS CSR + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getMtlsCsr(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMtlsCsr(options).then((request) => request(axios, basePath)); + }, /** * Get notification by id * @summary Get notification by id @@ -1551,6 +1604,17 @@ export class WebhooksV2Api extends BaseAPI { return WebhooksV2ApiFp(this.configuration).getMetrics(requestParameters.webhookId, requestParameters.metricName).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Returns the Fireblocks Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. + * @summary Get mTLS CSR + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksV2Api + */ + public getMtlsCsr() { + return WebhooksV2ApiFp(this.configuration).getMtlsCsr().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Get notification by id * @summary Get notification by id diff --git a/docs/apis/ConnectedAccountsBetaApi.md b/docs/apis/ConnectedAccountsBetaApi.md index 744fd0d2..e08bde55 100644 --- a/docs/apis/ConnectedAccountsBetaApi.md +++ b/docs/apis/ConnectedAccountsBetaApi.md @@ -6,11 +6,14 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**disconnectConnectedAccount**](#disconnectConnectedAccount) | **DELETE** /connected_accounts/{accountId} | Disconnect connected account [**getConnectedAccount**](#getConnectedAccount) | **GET** /connected_accounts/{accountId} | Get connected account +[**getConnectedAccountAllowlist**](#getConnectedAccountAllowlist) | **GET** /connected_accounts/{accountId}/allowlist | Get allowlist for connected account +[**getConnectedAccountAllowlistEntry**](#getConnectedAccountAllowlistEntry) | **GET** /connected_accounts/{accountId}/allowlist/{allowlistId} | Get a single allowlist entry for a connected account [**getConnectedAccountBalances**](#getConnectedAccountBalances) | **GET** /connected_accounts/{accountId}/balances | Get balances for an account [**getConnectedAccountRates**](#getConnectedAccountRates) | **GET** /connected_accounts/{accountId}/rates | Get exchange rates for an account [**getConnectedAccountTradingPairs**](#getConnectedAccountTradingPairs) | **GET** /connected_accounts/{accountId}/manifest/capabilities/trading/pairs | Get supported trading pairs for an account [**getConnectedAccounts**](#getConnectedAccounts) | **GET** /connected_accounts | Get connected accounts [**renameConnectedAccount**](#renameConnectedAccount) | **POST** /connected_accounts/{accountId}/rename | Rename Connected Account +[**syncConnectedAccountAllowlist**](#syncConnectedAccountAllowlist) | **POST** /connected_accounts/{accountId}/allowlist/sync | Sync allowlist for connected account # **disconnectConnectedAccount** @@ -133,6 +136,155 @@ 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) +# **getConnectedAccountAllowlist** +> AllowlistResponse getConnectedAccountAllowlist() + +Retrieves the address allowlist for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest, AllowlistResponse } 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: ConnectedAccountsBetaApiGetConnectedAccountAllowlistRequest = { + // string | The connected account identifier + accountId: accountId_example, + // AllowlistEntryStatus | Filter by allowlist entry status (optional) + status: param_value, + // string | Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. (optional) + assetId: assetId_example, + // string | Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. (optional) + networkId: networkId_example, + // string | Filter by specific address (optional) + address: address_example, + // string | Pagination cursor for next page (optional) + pageCursor: pageCursor_example, + // number | Maximum number of entries to return (optional) + pageSize: 56, + // 'addedAt' | 'lastSyncedAt' | Field to sort results by. (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | Sort order (ASC or DESC). (optional) + order: ASC, +}; + +fireblocks.connectedAccountsBeta.getConnectedAccountAllowlist(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 +------------- | ------------- | ------------- | ------------- + **accountId** | [**string**] | The connected account identifier | defaults to undefined + **status** | **AllowlistEntryStatus** | Filter by allowlist entry status | (optional) defaults to undefined + **assetId** | [**string**] | Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. | (optional) defaults to undefined + **networkId** | [**string**] | Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. | (optional) defaults to undefined + **address** | [**string**] | Filter by specific address | (optional) defaults to undefined + **pageCursor** | [**string**] | Pagination cursor for next page | (optional) defaults to undefined + **pageSize** | [**number**] | Maximum number of entries to return | (optional) defaults to undefined + **sortBy** | [**'addedAt' | 'lastSyncedAt'**]**Array<'addedAt' | 'lastSyncedAt'>** | Field to sort results by. | (optional) defaults to 'addedAt' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | Sort order (ASC or DESC). | (optional) defaults to 'DESC' + + +### Return type + +**[AllowlistResponse](../models/AllowlistResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Allowlist entries response | * X-Request-ID -
| +**404** | Connected account not found | * 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) + +# **getConnectedAccountAllowlistEntry** +> AllowlistEntry getConnectedAccountAllowlistEntry() + +Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest, AllowlistEntry } 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: ConnectedAccountsBetaApiGetConnectedAccountAllowlistEntryRequest = { + // string | The connected account identifier + accountId: accountId_example, + // string | The Fireblocks allowlist entry identifier + allowlistId: allowlistId_example, +}; + +fireblocks.connectedAccountsBeta.getConnectedAccountAllowlistEntry(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 +------------- | ------------- | ------------- | ------------- + **accountId** | [**string**] | The connected account identifier | defaults to undefined + **allowlistId** | [**string**] | The Fireblocks allowlist entry identifier | defaults to undefined + + +### Return type + +**[AllowlistEntry](../models/AllowlistEntry.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Allowlist entry response | * X-Request-ID -
| +**404** | Connected account or allowlist entry not found | * 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) + # **getConnectedAccountBalances** > ConnectedAccountBalancesResponse getConnectedAccountBalances() @@ -468,4 +620,67 @@ 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) +# **syncConnectedAccountAllowlist** +> syncConnectedAccountAllowlist() + +Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** This endpoint is currently in beta and might be subject to changes. Currently supports CoinbaseExchange accounts only. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest } 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: ConnectedAccountsBetaApiSyncConnectedAccountAllowlistRequest = { + // string | The connected account identifier + accountId: accountId_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.connectedAccountsBeta.syncConnectedAccountAllowlist(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 +------------- | ------------- | ------------- | ------------- + **accountId** | [**string**] | The connected account identifier | 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 + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Sync request accepted and processing | * 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/OnchainDataApi.md b/docs/apis/OnchainDataApi.md index 5066c768..67b77e15 100644 --- a/docs/apis/OnchainDataApi.md +++ b/docs/apis/OnchainDataApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description # **getAccessRegistryCurrentState** -> AccessRegistryCurrentStateResponse getAccessRegistryCurrentState() +> AccessRegistryCurrentStateResponse2 getAccessRegistryCurrentState() Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. @@ -25,7 +25,7 @@ Returns the current state of addresses in the specified access registry. Only ad ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetAccessRegistryCurrentStateRequest, AccessRegistryCurrentStateResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetAccessRegistryCurrentStateRequest, AccessRegistryCurrentStateResponse2 } 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" @@ -49,7 +49,7 @@ let body: OnchainDataApiGetAccessRegistryCurrentStateRequest = { order: order_example, }; -fireblocks.onchainData.getAccessRegistryCurrentState(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getAccessRegistryCurrentState(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -69,7 +69,7 @@ Name | Type | Description | Notes ### Return type -**[AccessRegistryCurrentStateResponse](../models/AccessRegistryCurrentStateResponse.md)** +**[AccessRegistryCurrentStateResponse2](../models/AccessRegistryCurrentStateResponse2.md)** ### Authorization @@ -153,7 +153,7 @@ 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) # **getActiveRolesForContract** -> ActiveRolesResponse getActiveRolesForContract() +> ActiveRolesResponse2 getActiveRolesForContract() Returns a list of currently active roles for the specified baseAssetId and contractAddress. @@ -163,7 +163,7 @@ Returns a list of currently active roles for the specified baseAssetId and contr ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetActiveRolesForContractRequest, ActiveRolesResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetActiveRolesForContractRequest, ActiveRolesResponse2 } 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" @@ -179,7 +179,7 @@ let body: OnchainDataApiGetActiveRolesForContractRequest = { contractAddress: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66, }; -fireblocks.onchainData.getActiveRolesForContract(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getActiveRolesForContract(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -195,7 +195,7 @@ Name | Type | Description | Notes ### Return type -**[ActiveRolesResponse](../models/ActiveRolesResponse.md)** +**[ActiveRolesResponse2](../models/ActiveRolesResponse2.md)** ### Authorization @@ -216,7 +216,7 @@ 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) # **getContractBalanceHistory** -> BalanceHistoryPagedResponse getContractBalanceHistory() +> BalanceHistoryPagedResponse2 getContractBalanceHistory() Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. @@ -226,7 +226,7 @@ Returns the paginated balance history of the specified account in a contract wit ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetContractBalanceHistoryRequest, BalanceHistoryPagedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetContractBalanceHistoryRequest, BalanceHistoryPagedResponse2 } 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" @@ -258,7 +258,7 @@ let body: OnchainDataApiGetContractBalanceHistoryRequest = { order: order_example, }; -fireblocks.onchainData.getContractBalanceHistory(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getContractBalanceHistory(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -282,7 +282,7 @@ Name | Type | Description | Notes ### Return type -**[BalanceHistoryPagedResponse](../models/BalanceHistoryPagedResponse.md)** +**[BalanceHistoryPagedResponse2](../models/BalanceHistoryPagedResponse2.md)** ### Authorization @@ -366,7 +366,7 @@ 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) # **getContractTotalSupply** -> TotalSupplyPagedResponse getContractTotalSupply() +> TotalSupplyPagedResponse2 getContractTotalSupply() Returns the paginated total supply history of the specified contract with optional date range and interval filtering. @@ -376,7 +376,7 @@ Returns the paginated total supply history of the specified contract with option ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetContractTotalSupplyRequest, TotalSupplyPagedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetContractTotalSupplyRequest, TotalSupplyPagedResponse2 } 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" @@ -406,7 +406,7 @@ let body: OnchainDataApiGetContractTotalSupplyRequest = { order: order_example, }; -fireblocks.onchainData.getContractTotalSupply(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getContractTotalSupply(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -429,7 +429,7 @@ Name | Type | Description | Notes ### Return type -**[TotalSupplyPagedResponse](../models/TotalSupplyPagedResponse.md)** +**[TotalSupplyPagedResponse2](../models/TotalSupplyPagedResponse2.md)** ### Authorization @@ -450,7 +450,7 @@ 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) # **getLatestBalancesForContract** -> AddressBalancePagedResponse getLatestBalancesForContract() +> AddressBalancePagedResponse2 getLatestBalancesForContract() Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. @@ -460,7 +460,7 @@ Returns the latest balance for each unique address with support for numeric bala ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetLatestBalancesForContractRequest, AddressBalancePagedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetLatestBalancesForContractRequest, AddressBalancePagedResponse2 } 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" @@ -486,7 +486,7 @@ let body: OnchainDataApiGetLatestBalancesForContractRequest = { order: order_example, }; -fireblocks.onchainData.getLatestBalancesForContract(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getLatestBalancesForContract(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -507,7 +507,7 @@ Name | Type | Description | Notes ### Return type -**[AddressBalancePagedResponse](../models/AddressBalancePagedResponse.md)** +**[AddressBalancePagedResponse2](../models/AddressBalancePagedResponse2.md)** ### Authorization @@ -528,7 +528,7 @@ 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) # **getOnchainTransactions** -> OnchainTransactionsPagedResponse getOnchainTransactions() +> OnchainTransactionsPagedResponse2 getOnchainTransactions() Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. @@ -538,7 +538,7 @@ Returns a paginated list of onchain transactions for the specified contract addr ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, OnchainDataApiGetOnchainTransactionsRequest, OnchainTransactionsPagedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, OnchainDataApiGetOnchainTransactionsRequest, OnchainTransactionsPagedResponse2 } 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" @@ -566,7 +566,7 @@ let body: OnchainDataApiGetOnchainTransactionsRequest = { order: order_example, }; -fireblocks.onchainData.getOnchainTransactions(body).then((res: FireblocksResponse) => { +fireblocks.onchainData.getOnchainTransactions(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -588,7 +588,7 @@ Name | Type | Description | Notes ### Return type -**[OnchainTransactionsPagedResponse](../models/OnchainTransactionsPagedResponse.md)** +**[OnchainTransactionsPagedResponse2](../models/OnchainTransactionsPagedResponse2.md)** ### Authorization diff --git a/docs/apis/StakingApi.md b/docs/apis/StakingApi.md index 05cdc8f1..52dbdd05 100644 --- a/docs/apis/StakingApi.md +++ b/docs/apis/StakingApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description [**getChainInfo**](#getChainInfo) | **GET** /staking/chains/{chainDescriptor}/chainInfo | Get chain-level staking parameters [**getChains**](#getChains) | **GET** /staking/chains | List supported staking chains [**getDelegationById**](#getDelegationById) | **GET** /staking/positions/{id} | Get position details +[**getPositionRelatedTransactions**](#getPositionRelatedTransactions) | **GET** /staking/positions/{id}/related_transactions | List related transactions for a position [**getPositions**](#getPositions) | **GET** /staking/positions_paginated | List staking positions (Paginated) [**getProviders**](#getProviders) | **GET** /staking/providers | List staking providers [**getSummary**](#getSummary) | **GET** /staking/positions/summary | Get positions summary @@ -488,6 +489,80 @@ 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) +# **getPositionRelatedTransactions** +> StakingPositionRelatedTransactionsPaginatedResponse getPositionRelatedTransactions() + +Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, StakingApiGetPositionRelatedTransactionsRequest, StakingPositionRelatedTransactionsPaginatedResponse } 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: StakingApiGetPositionRelatedTransactionsRequest = { + // string | Unique identifier of the staking position. + id: id_example, + // number | Number of results per page (minimum: 1, maximum: 100). + pageSize: 10, + // string | Cursor for the next page of results. Use the value from the \'next\' field in the previous response. (optional) + pageCursor: eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9, + // 'ASC' | 'DESC' | ASC / DESC ordering for completed/failed history (default DESC). The in-flight transaction is always returned first. (optional) + order: ASC, +}; + +fireblocks.staking.getPositionRelatedTransactions(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Unique identifier of the staking position. | defaults to undefined + **pageSize** | [**number**] | Number of results per page (minimum: 1, maximum: 100). | defaults to undefined + **pageCursor** | [**string**] | Cursor for the next page of results. Use the value from the \'next\' field in the previous response. | (optional) defaults to undefined + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering for completed/failed history (default DESC). The in-flight transaction is always returned first. | (optional) defaults to 'DESC' + + +### Return type + +**[StakingPositionRelatedTransactionsPaginatedResponse](../models/StakingPositionRelatedTransactionsPaginatedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Paginated list of related transactions for the position returned successfully. | * X-Request-ID -
| +**400** | Bad request: missing/invalid fields, unsupported amount, or malformed payload. | * X-Request-ID -
| +**403** | Forbidden: insufficient permissions, disabled feature, or restricted provider/validator. | * X-Request-ID -
| +**404** | Not found: requested resource does not exist (e.g., position, validator, provider, or wallet). | * X-Request-ID -
| +**429** | Rate limit exceeded: slow down and retry later. | * X-Request-ID -
| +**500** | Internal error while processing the request. | * 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) + # **getPositions** > StakingPositionsPaginatedResponse getPositions() diff --git a/docs/apis/TokenizationApi.md b/docs/apis/TokenizationApi.md index a2ad59b3..8804153b 100644 --- a/docs/apis/TokenizationApi.md +++ b/docs/apis/TokenizationApi.md @@ -17,6 +17,16 @@ Method | HTTP request | Description [**getLinkedToken**](#getLinkedToken) | **GET** /tokenization/tokens/{id} | Return a linked token [**getLinkedTokens**](#getLinkedTokens) | **GET** /tokenization/tokens | List all linked tokens [**getLinkedTokensCount**](#getLinkedTokensCount) | **GET** /tokenization/tokens/count | Get the total count of linked tokens +[**getTokenAccessRegistryAddresses**](#getTokenAccessRegistryAddresses) | **GET** /tokenization/access_registries/{id}/addresses | Get current state of addresses in an access registry +[**getTokenAccessRegistrySummary**](#getTokenAccessRegistrySummary) | **GET** /tokenization/access_registries/{id}/summary | Get summary of an access registry +[**getTokenBalanceForAccount**](#getTokenBalanceForAccount) | **GET** /tokenization/tokens/{id}/balances/{accountAddress} | Get the latest balance for a specific account +[**getTokenBalanceHistory**](#getTokenBalanceHistory) | **GET** /tokenization/tokens/{id}/balances/{accountAddress}/history | Get balance history for a specific account +[**getTokenBalances**](#getTokenBalances) | **GET** /tokenization/tokens/{id}/balances | Get latest balances for all holders of a token +[**getTokenContractSummary**](#getTokenContractSummary) | **GET** /tokenization/tokens/{id}/summary | Get onchain summary for a token +[**getTokenRbac**](#getTokenRbac) | **GET** /tokenization/tokens/{id}/rbac | Get active RBAC roles for a token +[**getTokenTotalSupply**](#getTokenTotalSupply) | **GET** /tokenization/tokens/{id}/total_supply | Get historical total supply for a token +[**getTokenTransactions**](#getTokenTransactions) | **GET** /tokenization/tokens/{id}/transactions | Get onchain transactions for a token +[**getTokenTransfers**](#getTokenTransfers) | **GET** /tokenization/tokens/{id}/transfers | Get onchain transfers for a token [**issueNewToken**](#issueNewToken) | **POST** /tokenization/tokens | Issue a new token [**issueTokenMultiChain**](#issueTokenMultiChain) | **POST** /tokenization/multichain/tokens | Issue a token on one or more blockchains [**link**](#link) | **POST** /tokenization/tokens/link | Link a contract @@ -853,6 +863,728 @@ 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) +# **getTokenAccessRegistryAddresses** +> AccessRegistryCurrentStateResponse getTokenAccessRegistryAddresses() + +Returns the currently active addresses in the access registry (added but not removed). + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenAccessRegistryAddressesRequest, AccessRegistryCurrentStateResponse } 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: TokenizationApiGetTokenAccessRegistryAddressesRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'dateAdded' | 'address' | Sorting field (enum). (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, +}; + +fireblocks.tokenization.getTokenAccessRegistryAddresses(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'dateAdded' | 'address'**]**Array<'dateAdded' | 'address'>** | Sorting field (enum). | (optional) defaults to 'dateAdded' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + + +### Return type + +**[AccessRegistryCurrentStateResponse](../models/AccessRegistryCurrentStateResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Access registry addresses retrieved successfully | - | +**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) + +# **getTokenAccessRegistrySummary** +> AccessRegistrySummaryResponse getTokenAccessRegistrySummary() + +Returns a summary of the current state of the access registry. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenAccessRegistrySummaryRequest, AccessRegistrySummaryResponse } 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: TokenizationApiGetTokenAccessRegistrySummaryRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, +}; + +fireblocks.tokenization.getTokenAccessRegistrySummary(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + + +### Return type + +**[AccessRegistrySummaryResponse](../models/AccessRegistrySummaryResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Access registry summary retrieved successfully | - | +**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) + +# **getTokenBalanceForAccount** +> AddressBalanceItemDto getTokenBalanceForAccount() + +Returns the latest token balance for the specified account address. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenBalanceForAccountRequest, AddressBalanceItemDto } 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: TokenizationApiGetTokenBalanceForAccountRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | The account address to get balance history for + accountAddress: 0x1234567890abcdef1234567890abcdef12345678, +}; + +fireblocks.tokenization.getTokenBalanceForAccount(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **accountAddress** | [**string**] | The account address to get balance history for | defaults to undefined + + +### Return type + +**[AddressBalanceItemDto](../models/AddressBalanceItemDto.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the balance for the account | - | +**404** | Token not found | - | +**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) + +# **getTokenBalanceHistory** +> BalanceHistoryPagedResponse getTokenBalanceHistory() + +Returns paginated balance history for the specified account address with optional time-range filtering. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenBalanceHistoryRequest, BalanceHistoryPagedResponse } 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: TokenizationApiGetTokenBalanceHistoryRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | The account address to get balance history for + accountAddress: 0x1234567890abcdef1234567890abcdef12345678, + // string | Start date of the time range in ISO 8601 format (optional) + startDate: 2025-01-16T15:45:00Z, + // string | End date of the time range in ISO 8601 format (optional) + endDate: 2025-01-16T15:45:00Z, + // 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | Time interval for grouping data (optional) + interval: DAY, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'blockTimestamp' | Sorting field (enum). Sorting only supported by \'blockTimestamp\' (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, +}; + +fireblocks.tokenization.getTokenBalanceHistory(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **accountAddress** | [**string**] | The account address to get balance history for | defaults to undefined + **startDate** | [**string**] | Start date of the time range in ISO 8601 format | (optional) defaults to undefined + **endDate** | [**string**] | End date of the time range in ISO 8601 format | (optional) defaults to undefined + **interval** | [**'HOUR' | 'DAY' | 'WEEK' | 'MONTH'**]**Array<'HOUR' | 'DAY' | 'WEEK' | 'MONTH'>** | Time interval for grouping data | (optional) defaults to 'DAY' + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'blockTimestamp'**]**Array<'blockTimestamp'>** | Sorting field (enum). Sorting only supported by \'blockTimestamp\' | (optional) defaults to 'blockTimestamp' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + + +### Return type + +**[BalanceHistoryPagedResponse](../models/BalanceHistoryPagedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the balance history | - | +**404** | Token not found | - | +**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) + +# **getTokenBalances** +> AddressBalancePagedResponse getTokenBalances() + +Returns the latest balance for each unique address holding this token. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenBalancesRequest, AddressBalancePagedResponse } 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: TokenizationApiGetTokenBalancesRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'accountAddress' | 'blockTimestamp' | Sorting field for balances (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, +}; + +fireblocks.tokenization.getTokenBalances(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'accountAddress' | 'blockTimestamp'**]**Array<'accountAddress' | 'blockTimestamp'>** | Sorting field for balances | (optional) defaults to 'blockTimestamp' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + + +### Return type + +**[AddressBalancePagedResponse](../models/AddressBalancePagedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the latest balances for the token | - | +**404** | Token not found | - | +**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) + +# **getTokenContractSummary** +> TokenContractSummaryResponse getTokenContractSummary() + +Returns the total number of unique holders and the total supply for the token contract. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenContractSummaryRequest, TokenContractSummaryResponse } 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: TokenizationApiGetTokenContractSummaryRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, +}; + +fireblocks.tokenization.getTokenContractSummary(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + + +### Return type + +**[TokenContractSummaryResponse](../models/TokenContractSummaryResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the summary for the token contract | - | +**404** | Token not found | - | +**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) + +# **getTokenRbac** +> ActiveRolesResponse getTokenRbac() + +Returns a list of currently active roles for the token contract. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenRbacRequest, ActiveRolesResponse } 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: TokenizationApiGetTokenRbacRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, +}; + +fireblocks.tokenization.getTokenRbac(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + + +### Return type + +**[ActiveRolesResponse](../models/ActiveRolesResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the list of active roles | - | +**404** | Token not found | - | +**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) + +# **getTokenTotalSupply** +> TotalSupplyPagedResponse getTokenTotalSupply() + +Returns paginated total supply history for the token contract with optional time-range filtering and binning. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenTotalSupplyRequest, TotalSupplyPagedResponse } 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: TokenizationApiGetTokenTotalSupplyRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | Start date of the time range in ISO 8601 format (optional) + startDate: 2025-01-16T15:45:00Z, + // string | End date of the time range in ISO 8601 format (optional) + endDate: 2025-01-16T15:45:00Z, + // 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | Time interval for grouping data (optional) + interval: DAY, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'blockTimestamp' | Sorting field (enum). Sorting only supported by \'blockTimestamp\' (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, +}; + +fireblocks.tokenization.getTokenTotalSupply(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **startDate** | [**string**] | Start date of the time range in ISO 8601 format | (optional) defaults to undefined + **endDate** | [**string**] | End date of the time range in ISO 8601 format | (optional) defaults to undefined + **interval** | [**'HOUR' | 'DAY' | 'WEEK' | 'MONTH'**]**Array<'HOUR' | 'DAY' | 'WEEK' | 'MONTH'>** | Time interval for grouping data | (optional) defaults to 'DAY' + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'blockTimestamp'**]**Array<'blockTimestamp'>** | Sorting field (enum). Sorting only supported by \'blockTimestamp\' | (optional) defaults to 'blockTimestamp' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + + +### Return type + +**[TotalSupplyPagedResponse](../models/TotalSupplyPagedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved the token total supply history | - | +**404** | Token not found | - | +**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) + +# **getTokenTransactions** +> OnchainTransactionsPagedResponse getTokenTransactions() + +Returns a paginated list of onchain transactions for the token contract, optionally filtered by date range. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenTransactionsRequest, OnchainTransactionsPagedResponse } 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: TokenizationApiGetTokenTransactionsRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | Start date of the time range in ISO 8601 format (optional) + startDate: 2025-01-16T15:45:00Z, + // string | End date of the time range in ISO 8601 format (optional) + endDate: 2025-01-16T15:45:00Z, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'blockTimestamp' | 'blockNumber' | 'transactionHash' | Sorting field (enum). (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, +}; + +fireblocks.tokenization.getTokenTransactions(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **startDate** | [**string**] | Start date of the time range in ISO 8601 format | (optional) defaults to undefined + **endDate** | [**string**] | End date of the time range in ISO 8601 format | (optional) defaults to undefined + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'blockTimestamp' | 'blockNumber' | 'transactionHash'**]**Array<'blockTimestamp' | 'blockNumber' | 'transactionHash'>** | Sorting field (enum). | (optional) defaults to 'blockTimestamp' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + + +### Return type + +**[OnchainTransactionsPagedResponse](../models/OnchainTransactionsPagedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Onchain transactions fetched successfully | - | +**404** | Token not found | - | +**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) + +# **getTokenTransfers** +> OnchainTransfersPagedResponse getTokenTransfers() + +Returns a paginated list of ERC20 transfer events for the token contract, optionally filtered by date range. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TokenizationApiGetTokenTransfersRequest, OnchainTransfersPagedResponse } 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: TokenizationApiGetTokenTransfersRequest = { + // string | The token link id + id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb, + // string | Start date of the time range in ISO 8601 format (optional) + startDate: 2025-01-16T15:45:00Z, + // string | End date of the time range in ISO 8601 format (optional) + endDate: 2025-01-16T15:45:00Z, + // string | Page cursor to get the next page (optional) + pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, + // number | Number of items per page (max 100), requesting more than 100 will return 100 items (optional) + pageSize: 10, + // 'blockTimeStamp' | Sorting field for transfers (optional) + sortBy: sortBy_example, + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: order_example, + // string | Filter transfers by sender address (optional) + sender: 0xabcdef1234567890abcdef1234567890abcdef12, + // string | Filter transfers by receiver address (optional) + receiver: 0x1234567890abcdef1234567890abcdef12345678, +}; + +fireblocks.tokenization.getTokenTransfers(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 +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | The token link id | defaults to undefined + **startDate** | [**string**] | Start date of the time range in ISO 8601 format | (optional) defaults to undefined + **endDate** | [**string**] | End date of the time range in ISO 8601 format | (optional) defaults to undefined + **pageCursor** | [**string**] | Page cursor to get the next page | (optional) defaults to undefined + **pageSize** | [**number**] | Number of items per page (max 100), requesting more than 100 will return 100 items | (optional) defaults to undefined + **sortBy** | [**'blockTimeStamp'**]**Array<'blockTimeStamp'>** | Sorting field for transfers | (optional) defaults to 'blockTimeStamp' + **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + **sender** | [**string**] | Filter transfers by sender address | (optional) defaults to undefined + **receiver** | [**string**] | Filter transfers by receiver address | (optional) defaults to undefined + + +### Return type + +**[OnchainTransfersPagedResponse](../models/OnchainTransfersPagedResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Onchain transfers fetched successfully | - | +**404** | Token not found | - | +**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) + # **issueNewToken** > TokenLinkDto issueNewToken(createTokenRequestDto) diff --git a/docs/apis/TradingBetaApi.md b/docs/apis/TradingBetaApi.md index 27227028..5a51b2cd 100644 --- a/docs/apis/TradingBetaApi.md +++ b/docs/apis/TradingBetaApi.md @@ -9,9 +9,12 @@ Method | HTTP request | Description [**fetchAllOffers**](#fetchAllOffers) | **POST** /trading/offers | Get all offers [**fetchRates**](#fetchRates) | **POST** /trading/rates | Get rates [**getOrder**](#getOrder) | **GET** /trading/orders/{orderId} | Get order details +[**getOrderRequirements**](#getOrderRequirements) | **GET** /trading/orders/{orderId}/requirement | Get order requirement details for an order [**getOrders**](#getOrders) | **GET** /trading/orders | Get orders [**getTradingProviderById**](#getTradingProviderById) | **GET** /trading/providers/{providerId} | Get trading provider by ID [**getTradingProviders**](#getTradingProviders) | **GET** /trading/providers | Get providers +[**submitOrderRequirements**](#submitOrderRequirements) | **POST** /trading/orders/{orderId}/requirement/data | Submit a response to an order requirement +[**uploadOrderRequirementFile**](#uploadOrderRequirementFile) | **POST** /trading/orders/{orderId}/requirement/file | Upload a file for an order requirement # **createOrder** @@ -351,6 +354,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) +# **getOrderRequirements** +> OrderRequirementDetails getOrderRequirements() + +Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TradingBetaApiGetOrderRequirementsRequest, OrderRequirementDetails } 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: TradingBetaApiGetOrderRequirementsRequest = { + // string | The ID of the order for which the order requirement is issued. + orderId: orderId_example, +}; + +fireblocks.tradingBeta.getOrderRequirements(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 +------------- | ------------- | ------------- | ------------- + **orderId** | [**string**] | The ID of the order for which the order requirement is issued. | defaults to undefined + + +### Return type + +**[OrderRequirementDetails](../models/OrderRequirementDetails.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Order requirement details | * X-Request-ID -
| +**401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID -
| +**403** | Forbidden: insufficient permissions, disabled feature, or restricted access. | * X-Request-ID -
| +**404** | Not found: the order does not exist. | * X-Request-ID -
| +**409** | Conflict: the order exists but does not have an active order requirement (e.g., the order is not in `AWAITING_INFORMATION`). | * X-Request-ID -
| +**429** | Rate limit exceeded: slow down and retry later. | * X-Request-ID -
| +**5XX** | Internal error while processing the request. | * 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) + # **getOrders** > GetOrdersResponse getOrders() @@ -571,4 +640,153 @@ 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) +# **submitOrderRequirements** +> submitOrderRequirements(submitOrderRequirementRequest, ) + +Submit the user\'s textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TradingBetaApiSubmitOrderRequirementsRequest } 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: TradingBetaApiSubmitOrderRequirementsRequest = { + // SubmitOrderRequirementRequest + submitOrderRequirementRequest: param_value, + // string | The ID of the order to submit the order requirement response for. + orderId: orderId_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.tradingBeta.submitOrderRequirements(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 +------------- | ------------- | ------------- | ------------- + **submitOrderRequirementRequest** | **[SubmitOrderRequirementRequest](../models/SubmitOrderRequirementRequest.md)**| | + **orderId** | [**string**] | The ID of the order to submit the order requirement response for. | 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 + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Order requirement submission accepted for processing. | * X-Request-ID -
| +**400** | Bad request: invalid input parameters, malformed request body, or validation failure. | * X-Request-ID -
| +**401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID -
| +**403** | Forbidden: insufficient permissions, disabled feature, or restricted access. | * X-Request-ID -
| +**404** | Not found: the order does not exist. | * X-Request-ID -
| +**409** | Conflict: the order exists but does not have an active order requirement (e.g., the order is not in `AWAITING_INFORMATION`). | * X-Request-ID -
| +**429** | Rate limit exceeded: slow down and retry later. | * X-Request-ID -
| +**5XX** | Internal error while processing the request. | * 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) + +# **uploadOrderRequirementFile** +> uploadOrderRequirementFile() + +Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. Send `fileKey` (matching a `fileKey` from `requiredFiles` on the GET response) and the binary `file`. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via `POST /trading/orders/{orderId}/requirement/data`. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TradingBetaApiUploadOrderRequirementFileRequest } 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: TradingBetaApiUploadOrderRequirementFileRequest = { + // string | Identifier of the required file this upload satisfies. Must match a `fileKey` from `requiredFiles` on the GET response. + fileKey: fileKey_example, + // File | The binary file content. The file\\\'s type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part. + file: BINARY_DATA_HERE, + // string | The ID of the order to upload the order requirement file for. + orderId: orderId_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.tradingBeta.uploadOrderRequirementFile(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 +------------- | ------------- | ------------- | ------------- + **fileKey** | [**string**] | Identifier of the required file this upload satisfies. Must match a `fileKey` from `requiredFiles` on the GET response. | defaults to undefined + **file** | [**File**] | The binary file content. The file\\\'s type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part. | defaults to undefined + **orderId** | [**string**] | The ID of the order to upload the order requirement file for. | 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 + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | File accepted for processing. | * X-Request-ID -
| +**400** | Bad request: unsupported file type, missing fileKey, malformed request, or validation failure. | * X-Request-ID -
| +**401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID -
| +**403** | Forbidden: insufficient permissions, disabled feature, or restricted access. | * X-Request-ID -
| +**404** | Not found: the order does not exist. | * X-Request-ID -
| +**409** | Conflict: the order exists but does not have an active order requirement (e.g., the order is not in `AWAITING_INFORMATION`). | * X-Request-ID -
| +**429** | Rate limit exceeded: slow down and retry later. | * X-Request-ID -
| +**5XX** | Internal error while processing the request. | * 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/TransactionsApi.md b/docs/apis/TransactionsApi.md index b1b7e0c7..6df27381 100644 --- a/docs/apis/TransactionsApi.md +++ b/docs/apis/TransactionsApi.md @@ -566,7 +566,7 @@ let body: TransactionsApiGetTransactionsRequest = { sort: sort_example, // number | Limits the number of results. If not provided, a limit of 200 will be used. The maximum allowed limit is 500 (optional) limit: 56, - // 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET' | The source type of the transaction (optional) + // 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET' | 'WALLET_POOL' | The source type of the transaction (optional) sourceType: sourceType_example, // string | The source ID of the transaction (optional) sourceId: sourceId_example, @@ -602,7 +602,7 @@ Name | Type | Description | Notes **orderBy** | [**'createdAt' | 'lastUpdated'**]**Array<'createdAt' | 'lastUpdated'>** | The field to order the results by. **Note:** Ordering by a field that is not `createdAt` may result in transactions that receive updates as you request the next or previous pages of results, resulting in missing those transactions. | (optional) defaults to undefined **sort** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | The direction to order the results by | (optional) defaults to undefined **limit** | [**number**] | Limits the number of results. If not provided, a limit of 200 will be used. The maximum allowed limit is 500 | (optional) defaults to 200 - **sourceType** | [**'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET'**]**Array<'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET'>** | The source type of the transaction | (optional) defaults to undefined + **sourceType** | [**'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET' | 'WALLET_POOL'**]**Array<'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'UNKNOWN' | 'GAS_STATION' | 'END_USER_WALLET' | 'WALLET_POOL'>** | The source type of the transaction | (optional) defaults to undefined **sourceId** | [**string**] | The source ID of the transaction | (optional) defaults to undefined **destType** | [**'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'ONE_TIME_ADDRESS' | 'END_USER_WALLET'**]**Array<'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'FIAT_ACCOUNT' | 'NETWORK_CONNECTION' | 'COMPOUND' | 'ONE_TIME_ADDRESS' | 'END_USER_WALLET'>** | The destination type of the transaction | (optional) defaults to undefined **destId** | [**string**] | The destination ID of the transaction | (optional) defaults to undefined diff --git a/docs/apis/WebhooksV2Api.md b/docs/apis/WebhooksV2Api.md index f25ae3db..f605849d 100644 --- a/docs/apis/WebhooksV2Api.md +++ b/docs/apis/WebhooksV2Api.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**createWebhook**](#createWebhook) | **POST** /webhooks | Create a new webhook [**deleteWebhook**](#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook [**getMetrics**](#getMetrics) | **GET** /webhooks/{webhookId}/metrics/{metricName} | Get webhook metrics +[**getMtlsCsr**](#getMtlsCsr) | **GET** /webhooks/mtls/csr | Get mTLS CSR [**getNotification**](#getNotification) | **GET** /webhooks/{webhookId}/notifications/{notificationId} | Get notification by id [**getNotificationAttempts**](#getNotificationAttempts) | **GET** /webhooks/{webhookId}/notifications/{notificationId}/attempts | Get notification attempts [**getNotifications**](#getNotifications) | **GET** /webhooks/{webhookId}/notifications | Get all notifications by webhook id @@ -207,6 +208,60 @@ 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) +# **getMtlsCsr** +> WebhookMtlsCsrResponse getMtlsCsr() + +Returns the Fireblocks Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, WebhookMtlsCsrResponse } 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:any = {}; + +fireblocks.webhooksV2.getMtlsCsr(body).then((res: FireblocksResponse) => { + console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); +}).catch((error:any) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**[WebhookMtlsCsrResponse](../models/WebhookMtlsCsrResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The mTLS CSR PEM | * 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) + # **getNotification** > NotificationWithData getNotification() diff --git a/docs/models/AccessRegistryCurrentStateResponse2.md b/docs/models/AccessRegistryCurrentStateResponse2.md new file mode 100644 index 00000000..555da7fb --- /dev/null +++ b/docs/models/AccessRegistryCurrentStateResponse2.md @@ -0,0 +1,15 @@ +# AccessRegistryCurrentStateResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<AccessRegistryAddressItem>**](AccessRegistryAddressItem.md) | Array of active addresses in the access registry | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page | [optional] [default to undefined]| +|**total** | **number** | Total count of active addresses in the access registry | [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/ActiveRolesMap.md b/docs/models/ActiveRolesMap.md new file mode 100644 index 00000000..78d05f89 --- /dev/null +++ b/docs/models/ActiveRolesMap.md @@ -0,0 +1,11 @@ +# ActiveRolesMap + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| + + + + +[[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/ActiveRolesResponse.md b/docs/models/ActiveRolesResponse.md index 93668736..c7aa10ea 100644 --- a/docs/models/ActiveRolesResponse.md +++ b/docs/models/ActiveRolesResponse.md @@ -4,6 +4,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| +|**activeRoles** | [**ActiveRolesMap**](ActiveRolesMap.md) | | [default to undefined]| diff --git a/docs/models/ActiveRolesResponse2.md b/docs/models/ActiveRolesResponse2.md new file mode 100644 index 00000000..4853e871 --- /dev/null +++ b/docs/models/ActiveRolesResponse2.md @@ -0,0 +1,11 @@ +# ActiveRolesResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| + + + + +[[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/AddressBalancePagedResponse2.md b/docs/models/AddressBalancePagedResponse2.md new file mode 100644 index 00000000..15f2e6fc --- /dev/null +++ b/docs/models/AddressBalancePagedResponse2.md @@ -0,0 +1,15 @@ +# AddressBalancePagedResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<AddressBalanceItemDto>**](AddressBalanceItemDto.md) | Array of address balance data | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page (reserved for future support) | [optional] [default to undefined]| +|**total** | **number** | Total count of items | [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/AllowlistEntry.md b/docs/models/AllowlistEntry.md new file mode 100644 index 00000000..4f5feb5a --- /dev/null +++ b/docs/models/AllowlistEntry.md @@ -0,0 +1,21 @@ +# AllowlistEntry + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**id** | **string** | Unique identifier for the allowlist entry | [default to undefined]| +|**address** | **string** | The blockchain address | [default to undefined]| +|**assets** | **Array<string>** | Assets approved for this address. Each value is either a Fireblocks asset ID (when the provider\'s asset maps to a Fireblocks-supported asset) or the raw provider asset symbol (when no mapping exists). Treat values as opaque strings. Possible combinations: - One or more specific asset values (e.g., `[\"BTC\", \"ETH\"]`) See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. | [default to undefined]| +|**networks** | **Array<string>** | Networks approved for this address. Each value is either a Fireblocks network ID (when the provider\'s network maps to a Fireblocks-supported blockchain) or the raw provider blockchain identifier (when no mapping exists). Treat values as opaque strings. Possible combinations: - One or more specific network values (e.g., `[\"ETHEREUM\", \"POLYGON\"]`) See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. | [default to undefined]| +|**status** | [**AllowlistEntryStatus**](AllowlistEntryStatus.md) | | [default to undefined]| +|**addedAt** | **string** | ISO 8601 timestamp when entry was added | [default to undefined]| +|**label** | **string** | Human-readable label for the address | [optional] [default to undefined]| +|**addressIdentifier** | **string** | Additional identifier (e.g., memo, destination tag) | [optional] [default to undefined]| +|**providerReferenceId** | **string** | Provider\'s internal reference ID | [optional] [default to undefined]| +|**providerMetadata** | [**AllowlistEntryProviderMetadata**](AllowlistEntryProviderMetadata.md) | | [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/AllowlistEntryProviderMetadata.md b/docs/models/AllowlistEntryProviderMetadata.md new file mode 100644 index 00000000..5e58928b --- /dev/null +++ b/docs/models/AllowlistEntryProviderMetadata.md @@ -0,0 +1,11 @@ +# AllowlistEntryProviderMetadata + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| + + + + +[[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/AllowlistEntryStatus.md b/docs/models/AllowlistEntryStatus.md new file mode 100644 index 00000000..7ed92c8b --- /dev/null +++ b/docs/models/AllowlistEntryStatus.md @@ -0,0 +1,20 @@ +# AllowlistEntryStatus + +## Enum + + +* `Active` (value: `'ACTIVE'`) + +* `PendingProviderCooldown` (value: `'PENDING_PROVIDER_COOLDOWN'`) + +* `PendingProviderReview` (value: `'PENDING_PROVIDER_REVIEW'`) + +* `PendingApproval` (value: `'PENDING_APPROVAL'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Removed` (value: `'REMOVED'`) + + + +[[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/AllowlistMetadata.md b/docs/models/AllowlistMetadata.md new file mode 100644 index 00000000..25b624dc --- /dev/null +++ b/docs/models/AllowlistMetadata.md @@ -0,0 +1,26 @@ +# AllowlistMetadata + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**lastSyncedAt** | **string** | ISO 8601 timestamp of last sync with provider | [optional] [default to undefined]| +|**syncStatus** | **string** | Status of last sync operation | [optional] [default to undefined]| + + +## Enum: AllowlistMetadataSyncStatusEnum + + +* `Success` (value: `'SUCCESS'`) + +* `Failed` (value: `'FAILED'`) + +* `InProgress` (value: `'IN_PROGRESS'`) + +* `NeverSynced` (value: `'NEVER_SYNCED'`) + + + + + +[[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/AllowlistResponse.md b/docs/models/AllowlistResponse.md new file mode 100644 index 00000000..6c452fa4 --- /dev/null +++ b/docs/models/AllowlistResponse.md @@ -0,0 +1,15 @@ +# AllowlistResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<AllowlistEntry>**](AllowlistEntry.md) | Array of allowlist entries | [default to undefined]| +|**total** | **number** | Total number of allowlist entries | [default to undefined]| +|**metadata** | [**AllowlistMetadata**](AllowlistMetadata.md) | | [optional] [default to undefined]| +|**next** | **string** | Cursor for the next page of results, if available | [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/BalanceHistoryPagedResponse2.md b/docs/models/BalanceHistoryPagedResponse2.md new file mode 100644 index 00000000..ad9603c9 --- /dev/null +++ b/docs/models/BalanceHistoryPagedResponse2.md @@ -0,0 +1,15 @@ +# BalanceHistoryPagedResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<BalanceHistoryItemDto>**](BalanceHistoryItemDto.md) | Array of balance history data points | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page | [optional] [default to undefined]| +|**total** | **number** | Total count of items | [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/BusinessIdentification.md b/docs/models/BusinessIdentification.md index e9c6c231..050edb98 100644 --- a/docs/models/BusinessIdentification.md +++ b/docs/models/BusinessIdentification.md @@ -12,6 +12,8 @@ |**postalAddress** | [**PostalAddress**](PostalAddress.md) | | [default to undefined]| |**email** | **string** | | [optional] [default to undefined]| |**phone** | **string** | Mobile phone number in E.164 format | [optional] [default to undefined]| +|**dateOfRegistration** | **string** | The date the business was registered. | [optional] [default to undefined]| +|**countryOfRegistration** | **string** | The ISO-3166 Alpha-2 country code where the business is registered. | [optional] [default to undefined]| diff --git a/docs/models/ConnectedAccount.md b/docs/models/ConnectedAccount.md index b392dd11..60d91467 100644 --- a/docs/models/ConnectedAccount.md +++ b/docs/models/ConnectedAccount.md @@ -10,7 +10,10 @@ |**status** | [**ConnectedAccountApprovalStatus**](ConnectedAccountApprovalStatus.md) | | [default to undefined]| |**totalBalance** | [**ConnectedAccountTotalBalance**](ConnectedAccountTotalBalance.md) | | [default to undefined]| |**manifest** | [**ConnectedAccountManifest**](ConnectedAccountManifest.md) | | [default to undefined]| +|**accountType** | [**ConnectedAccountType**](ConnectedAccountType.md) | | [default to undefined]| |**parentId** | **string** | The ID of the parent main account, if this is a sub account. | [optional] [default to undefined]| +|**apiKey** | **string** | The API key identifier used to connect this account. | [optional] [default to undefined]| +|**providerAccountName** | **string** | The account name provided by the provider. | [optional] [default to undefined]| diff --git a/docs/models/ConnectedAccountType.md b/docs/models/ConnectedAccountType.md new file mode 100644 index 00000000..acc64523 --- /dev/null +++ b/docs/models/ConnectedAccountType.md @@ -0,0 +1,14 @@ +# ConnectedAccountType + +## Enum + + +* `Exchange` (value: `'EXCHANGE'`) + +* `Fiat` (value: `'FIAT'`) + +* `ConnectedAccount` (value: `'CONNECTED_ACCOUNT'`) + + + +[[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/ConnectedSingleAccountResponse.md b/docs/models/ConnectedSingleAccountResponse.md index 5c3bb4b5..e03a14bb 100644 --- a/docs/models/ConnectedSingleAccountResponse.md +++ b/docs/models/ConnectedSingleAccountResponse.md @@ -10,7 +10,10 @@ |**status** | [**ConnectedAccountApprovalStatus**](ConnectedAccountApprovalStatus.md) | | [default to undefined]| |**totalBalance** | [**ConnectedAccountTotalBalance**](ConnectedAccountTotalBalance.md) | | [default to undefined]| |**manifest** | [**ConnectedAccountManifest**](ConnectedAccountManifest.md) | | [default to undefined]| +|**accountType** | [**ConnectedAccountType**](ConnectedAccountType.md) | | [default to undefined]| |**parentId** | **string** | The ID of the parent main account, if this is a sub account. | [optional] [default to undefined]| +|**apiKey** | **string** | The API key identifier used to connect this account. | [optional] [default to undefined]| +|**providerAccountName** | **string** | The account name provided by the provider. | [optional] [default to undefined]| |**subAccountsIds** | **Array<string>** | IDs of sub-accounts associated with this connected account. | [optional] [default to undefined]| diff --git a/docs/models/CreateWebhookRequest.md b/docs/models/CreateWebhookRequest.md index 977b237f..ea81bc96 100644 --- a/docs/models/CreateWebhookRequest.md +++ b/docs/models/CreateWebhookRequest.md @@ -8,6 +8,7 @@ |**events** | [**Array<WebhookEvent>**](WebhookEvent.md) | event types the webhook will subscribe to | [default to undefined]| |**description** | **string** | description of the webhook. should not contain special characters. | [optional] [default to undefined]| |**enabled** | **boolean** | The status of the webhook. If false, the webhook will not receive notifications. | [optional] [default to true]| +|**mtls** | [**WebhookMtls**](WebhookMtls.md) | | [optional] [default to undefined]| diff --git a/docs/models/Identification.md b/docs/models/Identification.md index b1fbd8cc..05a14974 100644 --- a/docs/models/Identification.md +++ b/docs/models/Identification.md @@ -14,10 +14,14 @@ |**registrationNumber** | **string** | | [default to undefined]| |**email** | **string** | | [optional] [default to undefined]| |**phone** | **string** | Mobile phone number in E.164 format | [optional] [default to undefined]| -|**idNumber** | **string** | The identification number corresponding to the primary identification document type specified in idType | [optional] [default to undefined]| -|**idType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | | [optional] [default to undefined]| -|**additionalIdNumber** | **string** | The identification number corresponding to the additional identification document type specified in additionalIdType | [optional] [default to undefined]| -|**additionalIdType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | | [optional] [default to undefined]| +|**idNumber** | **string** | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**idType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**additionalIdNumber** | **string** | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**additionalIdType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**nationality** | **string** | The ISO-3166 Alpha-2 country code representing the individual\'s nationality. | [optional] [default to undefined]| +|**identificationDocuments** | [**Array<PersonalIdentificationDocument>**](PersonalIdentificationDocument.md) | List of identification documents for the individual. | [optional] [default to undefined]| +|**dateOfRegistration** | **string** | The date the business was registered. | [optional] [default to undefined]| +|**countryOfRegistration** | **string** | The ISO-3166 Alpha-2 country code where the business is registered. | [optional] [default to undefined]| diff --git a/docs/models/Offer.md b/docs/models/Offer.md index 5c55cf1b..b0a47a07 100644 --- a/docs/models/Offer.md +++ b/docs/models/Offer.md @@ -22,7 +22,7 @@ |**isSlippageApplied** | **boolean** | Indicates if slippage was applied to the quote. | [optional] [default to false]| |**executionSteps** | [**Array<QuoteExecutionStep>**](QuoteExecutionStep.md) | Ordered list of execution steps for the quote. | [optional] [default to undefined]| |**generalFees** | [**Array<Fee>**](Fee.md) | General fees associated with the quote. | [optional] [default to undefined]| -|**orderCreationRequirements** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| +|**requiredParticipantsIdentificationOnOrder** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| ## Enum: OfferOfferTypeEnum diff --git a/docs/models/OnchainTransactionsPagedResponse2.md b/docs/models/OnchainTransactionsPagedResponse2.md new file mode 100644 index 00000000..b22a09a1 --- /dev/null +++ b/docs/models/OnchainTransactionsPagedResponse2.md @@ -0,0 +1,15 @@ +# OnchainTransactionsPagedResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<OnchainTransaction>**](OnchainTransaction.md) | Array of onchain transactions | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page | [optional] [default to undefined]| +|**total** | **number** | Total count of items | [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/OnchainTransferEvent.md b/docs/models/OnchainTransferEvent.md new file mode 100644 index 00000000..89708d63 --- /dev/null +++ b/docs/models/OnchainTransferEvent.md @@ -0,0 +1,24 @@ +# OnchainTransferEvent + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**id** | **string** | Unique identifier for the transfer event | [default to undefined]| +|**transactionHash** | **string** | Hash of the transaction containing this transfer | [default to undefined]| +|**logIndex** | **string** | Index of the log within the transaction | [default to undefined]| +|**contractAddress** | **string** | Address of the token contract | [default to undefined]| +|**fromAddress** | **string** | Address that sent the tokens | [default to undefined]| +|**toAddress** | **string** | Address that received the tokens | [default to undefined]| +|**value** | **string** | Amount of tokens transferred (in smallest unit) | [default to undefined]| +|**chainId** | **number** | Chain ID of the blockchain | [default to undefined]| +|**baseAssetId** | **string** | The blockchain base asset identifier | [default to undefined]| +|**blockNumber** | **number** | Block number containing this transfer | [default to undefined]| +|**blockHash** | **string** | Hash of the block containing this transfer | [default to undefined]| +|**blockTimestamp** | **string** | Timestamp when the block was mined | [default to undefined]| +|**eventName** | **string** | Name of the event (typically \"Transfer\") | [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/OnchainTransfersPagedResponse.md b/docs/models/OnchainTransfersPagedResponse.md new file mode 100644 index 00000000..1b95b4fa --- /dev/null +++ b/docs/models/OnchainTransfersPagedResponse.md @@ -0,0 +1,15 @@ +# OnchainTransfersPagedResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<OnchainTransferEvent>**](OnchainTransferEvent.md) | Array of ERC20 transfer events | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page | [optional] [default to undefined]| +|**total** | **number** | Total count of items | [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/OrderRequirementAllowedFileType.md b/docs/models/OrderRequirementAllowedFileType.md new file mode 100644 index 00000000..d2bde050 --- /dev/null +++ b/docs/models/OrderRequirementAllowedFileType.md @@ -0,0 +1,28 @@ +# OrderRequirementAllowedFileType + +## Enum + + +* `Pdf` (value: `'PDF'`) + +* `Jpeg` (value: `'JPEG'`) + +* `Png` (value: `'PNG'`) + +* `Heic` (value: `'HEIC'`) + +* `Heif` (value: `'HEIF'`) + +* `Doc` (value: `'DOC'`) + +* `Docx` (value: `'DOCX'`) + +* `Xls` (value: `'XLS'`) + +* `Xlsx` (value: `'XLSX'`) + +* `Csv` (value: `'CSV'`) + + + +[[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/OrderRequirementDetails.md b/docs/models/OrderRequirementDetails.md new file mode 100644 index 00000000..7d90e816 --- /dev/null +++ b/docs/models/OrderRequirementDetails.md @@ -0,0 +1,15 @@ +# OrderRequirementDetails + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**requirementId** | **string** | Unique identifier of the order requirement request as issued by the provider. | [default to undefined]| +|**requiredData** | **string** | A JSON Schema (Draft-7) in string format describing the shape of the `data` object expected on the corresponding POST /trading/orders/{orderId}/requirement/data request. The schema is the contract: the client builds the `data` payload to match it, and SDKs can validate before sending. The string content is expected to be valid JSON (application/json). | [default to undefined]| +|**requiredFiles** | [**Array<OrderRequirementFile>**](OrderRequirementFile.md) | Descriptors for files the provider requires as part of the order requirement response. Empty when no files are required. Each entry\'s `fileKey` is used to correlate uploads on the corresponding upload request. | [default to undefined]| +|**dueBy** | **string** | ISO-8601 timestamp indicating when the order requirement submission is due. | [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/OrderRequirementFile.md b/docs/models/OrderRequirementFile.md new file mode 100644 index 00000000..bba44e01 --- /dev/null +++ b/docs/models/OrderRequirementFile.md @@ -0,0 +1,14 @@ +# OrderRequirementFile + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**fileKey** | **string** | Stable identifier for this required file. Used to correlate uploads on submission. | [default to undefined]| +|**description** | **string** | Human-readable description of what the file should contain. | [default to undefined]| +|**allowedFileTypes** | [**Array<OrderRequirementAllowedFileType>**](OrderRequirementAllowedFileType.md) | File formats the provider accepts for this entry. | [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/OrderStatus.md b/docs/models/OrderStatus.md index 9c7d65f0..f59a6272 100644 --- a/docs/models/OrderStatus.md +++ b/docs/models/OrderStatus.md @@ -7,6 +7,8 @@ * `AwaitingPayment` (value: `'AWAITING_PAYMENT'`) +* `AwaitingInformation` (value: `'AWAITING_INFORMATION'`) + * `PendingUserAction` (value: `'PENDING_USER_ACTION'`) * `Processing` (value: `'PROCESSING'`) diff --git a/docs/models/PersonalIdentification.md b/docs/models/PersonalIdentification.md index 95199056..e4562bab 100644 --- a/docs/models/PersonalIdentification.md +++ b/docs/models/PersonalIdentification.md @@ -12,10 +12,12 @@ |**postalAddress** | [**PostalAddress**](PostalAddress.md) | | [default to undefined]| |**email** | **string** | | [optional] [default to undefined]| |**phone** | **string** | Mobile phone number in E.164 format | [optional] [default to undefined]| -|**idNumber** | **string** | The identification number corresponding to the primary identification document type specified in idType | [optional] [default to undefined]| -|**idType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | | [optional] [default to undefined]| -|**additionalIdNumber** | **string** | The identification number corresponding to the additional identification document type specified in additionalIdType | [optional] [default to undefined]| -|**additionalIdType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | | [optional] [default to undefined]| +|**idNumber** | **string** | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**idType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**additionalIdNumber** | **string** | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**additionalIdType** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | Deprecated. Use identificationDocuments instead. | [optional] [default to undefined]| +|**nationality** | **string** | The ISO-3166 Alpha-2 country code representing the individual\'s nationality. | [optional] [default to undefined]| +|**identificationDocuments** | [**Array<PersonalIdentificationDocument>**](PersonalIdentificationDocument.md) | List of identification documents for the individual. | [optional] [default to undefined]| diff --git a/docs/models/PersonalIdentificationDocument.md b/docs/models/PersonalIdentificationDocument.md new file mode 100644 index 00000000..00c77fd0 --- /dev/null +++ b/docs/models/PersonalIdentificationDocument.md @@ -0,0 +1,14 @@ +# PersonalIdentificationDocument + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**id** | **string** | The identification document number. | [optional] [default to undefined]| +|**type** | [**PersonalIdentificationType**](PersonalIdentificationType.md) | | [optional] [default to undefined]| +|**expirationDate** | **string** | The expiration date of the identification document. | [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/PositionRelatedTransaction.md b/docs/models/PositionRelatedTransaction.md new file mode 100644 index 00000000..a751d5e9 --- /dev/null +++ b/docs/models/PositionRelatedTransaction.md @@ -0,0 +1,56 @@ +# PositionRelatedTransaction + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**txId** | **string** | The transaction ID. | [default to undefined]| +|**timestamp** | **string** | ISO timestamp when the transaction was initiated (send time). | [default to undefined]| +|**status** | **string** | Transaction outcome. | [default to undefined]| +|**txHash** | **string** | On-chain transaction hash. Absent while the transaction is pending. | [optional] [default to undefined]| +|**stakingOperation** | **string** | Staking operation type. One of APPROVE, STAKE, UNSTAKE, WITHDRAW, CLAIM_REWARDS, SPLIT, CONSOLIDATE, MERGE, TRANSFER, AUTHORIZE, ADD_TO_STAKE. Absent on legacy persisted rows. | [optional] [default to undefined]| +|**amount** | **string** | Portion of position amount this transaction moved (native units). Absent on legacy rows. | [optional] [default to undefined]| +|**txNote** | **string** | User-provided note from the transfer request. Omitted when not set. | [optional] [default to undefined]| + + +## Enum: PositionRelatedTransactionStatusEnum + + +* `Pending` (value: `'PENDING'`) + +* `Completed` (value: `'COMPLETED'`) + +* `Failed` (value: `'FAILED'`) + + + +## Enum: PositionRelatedTransactionStakingOperationEnum + + +* `Approve` (value: `'APPROVE'`) + +* `Stake` (value: `'STAKE'`) + +* `Unstake` (value: `'UNSTAKE'`) + +* `Withdraw` (value: `'WITHDRAW'`) + +* `ClaimRewards` (value: `'CLAIM_REWARDS'`) + +* `Split` (value: `'SPLIT'`) + +* `Consolidate` (value: `'CONSOLIDATE'`) + +* `Merge` (value: `'MERGE'`) + +* `Transfer` (value: `'TRANSFER'`) + +* `Authorize` (value: `'AUTHORIZE'`) + +* `AddToStake` (value: `'ADD_TO_STAKE'`) + + + + + +[[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/Quote.md b/docs/models/Quote.md index b3099d59..e34ea640 100644 --- a/docs/models/Quote.md +++ b/docs/models/Quote.md @@ -20,7 +20,7 @@ |**isSlippageApplied** | **boolean** | Indicates if slippage was applied to the quote. | [optional] [default to false]| |**executionSteps** | [**Array<QuoteExecutionStep>**](QuoteExecutionStep.md) | Ordered list of execution steps for the quote. | [optional] [default to undefined]| |**generalFees** | [**Array<Fee>**](Fee.md) | General fees associated with the quote. | [optional] [default to undefined]| -|**orderCreationRequirements** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| +|**requiredParticipantsIdentificationOnOrder** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| ## Enum: QuoteTypeEnum diff --git a/docs/models/QuoteOffer.md b/docs/models/QuoteOffer.md index 854a8178..ee19eb5a 100644 --- a/docs/models/QuoteOffer.md +++ b/docs/models/QuoteOffer.md @@ -21,7 +21,7 @@ |**isSlippageApplied** | **boolean** | Indicates if slippage was applied to the quote. | [optional] [default to false]| |**executionSteps** | [**Array<QuoteExecutionStep>**](QuoteExecutionStep.md) | Ordered list of execution steps for the quote. | [optional] [default to undefined]| |**generalFees** | [**Array<Fee>**](Fee.md) | General fees associated with the quote. | [optional] [default to undefined]| -|**orderCreationRequirements** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| +|**requiredParticipantsIdentificationOnOrder** | **string** | A JSON Schema Draft-7 document in string format describing the fields required when creating an order so clients can validate their order payload before sending. | [optional] [default to undefined]| ## Enum: QuoteOfferTypeEnum diff --git a/docs/models/RoleDetails2.md b/docs/models/RoleDetails2.md new file mode 100644 index 00000000..ec0eb0db --- /dev/null +++ b/docs/models/RoleDetails2.md @@ -0,0 +1,14 @@ +# RoleDetails2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**roleHash** | **string** | The role hash identifier | [default to undefined]| +|**description** | **string** | Human-readable description of the role | [default to undefined]| +|**accounts** | [**Array<RoleGrantee>**](RoleGrantee.md) | List of accounts that have been granted this role | [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/ScreeningTRLinkMissingTrmDecision.md b/docs/models/ScreeningTRLinkMissingTrmDecision.md index db86cf5a..9eefb363 100644 --- a/docs/models/ScreeningTRLinkMissingTrmDecision.md +++ b/docs/models/ScreeningTRLinkMissingTrmDecision.md @@ -8,10 +8,10 @@ |**source** | **string** | TRLink missing TRM source | [default to undefined]| |**customerId** | **string** | Reference to TRLinkCustomer.id | [optional] [default to undefined]| |**direction** | [**TravelRuleDirectionEnum**](TravelRuleDirectionEnum.md) | | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**sourceAddress** | **string** | Source address | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/ScreeningTRLinkMissingTrmRule.md b/docs/models/ScreeningTRLinkMissingTrmRule.md index 2edf9301..9513932a 100644 --- a/docs/models/ScreeningTRLinkMissingTrmRule.md +++ b/docs/models/ScreeningTRLinkMissingTrmRule.md @@ -7,10 +7,10 @@ |**action** | [**TRLinkMissingTrmActionEnum**](TRLinkMissingTrmActionEnum.md) | | [default to undefined]| |**customerId** | **string** | Reference to TRLinkCustomer.id | [optional] [default to undefined]| |**direction** | [**TravelRuleDirectionEnum**](TravelRuleDirectionEnum.md) | | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**sourceAddress** | **string** | Source address | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/ScreeningTRLinkPostScreeningRule.md b/docs/models/ScreeningTRLinkPostScreeningRule.md index 4b32f96b..075ca997 100644 --- a/docs/models/ScreeningTRLinkPostScreeningRule.md +++ b/docs/models/ScreeningTRLinkPostScreeningRule.md @@ -7,10 +7,10 @@ |**action** | [**TRLinkVerdictEnum**](TRLinkVerdictEnum.md) | | [default to undefined]| |**customerId** | **string** | Reference to TRLinkCustomer.id | [optional] [default to undefined]| |**direction** | [**TravelRuleDirectionEnum**](TravelRuleDirectionEnum.md) | | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**sourceAddress** | **string** | Source address | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/ScreeningTRLinkPrescreeningRule.md b/docs/models/ScreeningTRLinkPrescreeningRule.md index d5c85150..49e0416d 100644 --- a/docs/models/ScreeningTRLinkPrescreeningRule.md +++ b/docs/models/ScreeningTRLinkPrescreeningRule.md @@ -7,10 +7,10 @@ |**action** | [**TRLinkPreScreeningActionEnum**](TRLinkPreScreeningActionEnum.md) | | [default to undefined]| |**customerId** | **string** | Reference to TRLinkCustomer.id | [optional] [default to undefined]| |**direction** | [**TravelRuleDirectionEnum**](TravelRuleDirectionEnum.md) | | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**sourceAddress** | **string** | Source address | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/ScreeningTRLinkRuleBase.md b/docs/models/ScreeningTRLinkRuleBase.md index 29d556ec..1e074196 100644 --- a/docs/models/ScreeningTRLinkRuleBase.md +++ b/docs/models/ScreeningTRLinkRuleBase.md @@ -6,10 +6,10 @@ |------------ | ------------- | ------------- | -------------| |**customerId** | **string** | Reference to TRLinkCustomer.id | [optional] [default to undefined]| |**direction** | [**TravelRuleDirectionEnum**](TravelRuleDirectionEnum.md) | | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**sourceAddress** | **string** | Source address | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/ScreeningTravelRulePrescreeningRule.md b/docs/models/ScreeningTravelRulePrescreeningRule.md index 47c64e37..9cabdc7d 100644 --- a/docs/models/ScreeningTravelRulePrescreeningRule.md +++ b/docs/models/ScreeningTravelRulePrescreeningRule.md @@ -5,11 +5,11 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| |**bypassReason** | **string** | Reason for bypass if prescreening rule triggered a bypass | [optional] [default to undefined]| -|**sourceType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**sourceType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**sourceSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| -|**destType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**destType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**destSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| -|**transferPeerType** | [**TransferPeerTypeEnum**](TransferPeerTypeEnum.md) | | [optional] [default to undefined]| +|**transferPeerType** | [**TransferPeerTypeEnum2**](TransferPeerTypeEnum2.md) | | [optional] [default to undefined]| |**transferPeerSubType** | [**TransferPeerSubTypeEnum**](TransferPeerSubTypeEnum.md) | | [optional] [default to undefined]| |**destAddress** | **string** | Destination address | [optional] [default to undefined]| |**sourceId** | **string** | Source ID | [optional] [default to undefined]| diff --git a/docs/models/StakingPositionRelatedTransactionsPaginatedResponse.md b/docs/models/StakingPositionRelatedTransactionsPaginatedResponse.md new file mode 100644 index 00000000..cb8bff19 --- /dev/null +++ b/docs/models/StakingPositionRelatedTransactionsPaginatedResponse.md @@ -0,0 +1,13 @@ +# StakingPositionRelatedTransactionsPaginatedResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<PositionRelatedTransaction>**](PositionRelatedTransaction.md) | The related transactions for the current page. | [default to undefined]| +|**next** | **string** | Cursor for the next page. Use this value in the pageCursor parameter to fetch the next page. Null if no more pages. | [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/SubmitOrderRequirementRequest.md b/docs/models/SubmitOrderRequirementRequest.md new file mode 100644 index 00000000..f6872576 --- /dev/null +++ b/docs/models/SubmitOrderRequirementRequest.md @@ -0,0 +1,12 @@ +# SubmitOrderRequirementRequest + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | **{ [key: string]: any; }** | Free-form object that MUST conform to the `requiredData` JSON Schema returned by the GET endpoint. Carries text/select fields. | [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/TotalSupplyPagedResponse2.md b/docs/models/TotalSupplyPagedResponse2.md new file mode 100644 index 00000000..1c280d5e --- /dev/null +++ b/docs/models/TotalSupplyPagedResponse2.md @@ -0,0 +1,15 @@ +# TotalSupplyPagedResponse2 + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**data** | [**Array<TotalSupplyItemDto>**](TotalSupplyItemDto.md) | Array of total supply data points | [default to undefined]| +|**next** | **string** | Cursor for next page | [optional] [default to undefined]| +|**prev** | **string** | Cursor for previous page | [optional] [default to undefined]| +|**total** | **number** | Total count of items | [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/TransactionConfigurations.md b/docs/models/TransactionConfigurations.md new file mode 100644 index 00000000..f501941a --- /dev/null +++ b/docs/models/TransactionConfigurations.md @@ -0,0 +1,12 @@ +# TransactionConfigurations + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**expiresAfterSeconds** | **number** | The number of seconds the transaction is valid for before it expires. After the specified duration, the transaction will expire if it has not been broadcasted. | [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/TransactionRequest.md b/docs/models/TransactionRequest.md index f0bc48f2..88914f97 100644 --- a/docs/models/TransactionRequest.md +++ b/docs/models/TransactionRequest.md @@ -33,7 +33,7 @@ |**networkStaking** | [**TransactionRequestNetworkStaking**](TransactionRequestNetworkStaking.md) | | [optional] [default to undefined]| |**cpuStaking** | [**TransactionRequestNetworkStaking**](TransactionRequestNetworkStaking.md) | | [optional] [default to undefined]| |**useGasless** | **boolean** | - Override the default gasless configuration by sending true\\false | [optional] [default to undefined]| -|**expiresAfterSeconds** | **number** | The number of seconds the transaction is valid for before it expires. After the specified duration, the transaction will expire if it has not been broadcasted. | [optional] [default to undefined]| +|**configurations** | [**TransactionConfigurations**](TransactionConfigurations.md) | | [optional] [default to undefined]| ## Enum: TransactionRequestFeeLevelEnum diff --git a/docs/models/TransferPeerPathType.md b/docs/models/TransferPeerPathType.md index 6a2e36ff..8b04b3b7 100644 --- a/docs/models/TransferPeerPathType.md +++ b/docs/models/TransferPeerPathType.md @@ -35,6 +35,8 @@ * `OecPartner` (value: `'OEC_PARTNER'`) +* `WalletPool` (value: `'WALLET_POOL'`) + [[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/TransferPeerTypeEnum.md b/docs/models/TransferPeerTypeEnum.md index 21157049..2778e5a8 100644 --- a/docs/models/TransferPeerTypeEnum.md +++ b/docs/models/TransferPeerTypeEnum.md @@ -31,6 +31,8 @@ * `MultiDestination` (value: `'MULTI_DESTINATION'`) +* `WalletPool` (value: `'WALLET_POOL'`) + [[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/TransferPeerTypeEnum2.md b/docs/models/TransferPeerTypeEnum2.md new file mode 100644 index 00000000..cb0f4d5c --- /dev/null +++ b/docs/models/TransferPeerTypeEnum2.md @@ -0,0 +1,36 @@ +# TransferPeerTypeEnum2 + +## Enum + + +* `VaultAccount` (value: `'VAULT_ACCOUNT'`) + +* `ExchangeAccount` (value: `'EXCHANGE_ACCOUNT'`) + +* `InternalWallet` (value: `'INTERNAL_WALLET'`) + +* `ExternalWallet` (value: `'EXTERNAL_WALLET'`) + +* `Contract` (value: `'CONTRACT'`) + +* `NetworkConnection` (value: `'NETWORK_CONNECTION'`) + +* `FiatAccount` (value: `'FIAT_ACCOUNT'`) + +* `Compound` (value: `'COMPOUND'`) + +* `GasStation` (value: `'GAS_STATION'`) + +* `OneTimeAddress` (value: `'ONE_TIME_ADDRESS'`) + +* `Unknown` (value: `'UNKNOWN'`) + +* `EndUserWallet` (value: `'END_USER_WALLET'`) + +* `ProgramCall` (value: `'PROGRAM_CALL'`) + +* `MultiDestination` (value: `'MULTI_DESTINATION'`) + + + +[[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/UpdateWebhookRequest.md b/docs/models/UpdateWebhookRequest.md index a3c466ff..71418d46 100644 --- a/docs/models/UpdateWebhookRequest.md +++ b/docs/models/UpdateWebhookRequest.md @@ -8,6 +8,7 @@ |**description** | **string** | description of the webhook of what it is used for.should not contain special characters. | [optional] [default to undefined]| |**events** | [**Array<WebhookEvent>**](WebhookEvent.md) | The events that the webhook will be subscribed to | [optional] [default to undefined]| |**enabled** | **boolean** | The status of the webhook | [optional] [default to undefined]| +|**mtls** | [**WebhookMtls**](WebhookMtls.md) | | [optional] [default to undefined]| diff --git a/docs/models/Webhook.md b/docs/models/Webhook.md index b5cf7e6e..a900455b 100644 --- a/docs/models/Webhook.md +++ b/docs/models/Webhook.md @@ -11,6 +11,7 @@ |**createdAt** | **number** | The date and time the webhook was created in milliseconds | [default to undefined]| |**updatedAt** | **number** | The date and time the webhook was last updated in milliseconds | [default to undefined]| |**description** | **string** | description of the webhook of what it is used for | [optional] [default to undefined]| +|**mtls** | [**WebhookMtls**](WebhookMtls.md) | | [optional] [default to undefined]| ## Enum: WebhookStatusEnum diff --git a/docs/models/WebhookMtls.md b/docs/models/WebhookMtls.md new file mode 100644 index 00000000..9b3f638a --- /dev/null +++ b/docs/models/WebhookMtls.md @@ -0,0 +1,12 @@ +# WebhookMtls + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**clientSignedCert** | **string** | Signed client certificate PEM used for mTLS when delivering notifications. | [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/WebhookMtlsCsrResponse.md b/docs/models/WebhookMtlsCsrResponse.md new file mode 100644 index 00000000..16be6193 --- /dev/null +++ b/docs/models/WebhookMtlsCsrResponse.md @@ -0,0 +1,12 @@ +# WebhookMtlsCsrResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**csr** | **string** | The Fireblocks PEM-encoded Certificate Signing Request (CSR). | [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/models/access-registry-current-state-response2.ts b/models/access-registry-current-state-response2.ts new file mode 100644 index 00000000..6f94ade2 --- /dev/null +++ b/models/access-registry-current-state-response2.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 { AccessRegistryAddressItem } from './access-registry-address-item'; + +/** + * + * @export + * @interface AccessRegistryCurrentStateResponse2 + */ +export interface AccessRegistryCurrentStateResponse2 { + /** + * Array of active addresses in the access registry + * @type {Array} + * @memberof AccessRegistryCurrentStateResponse2 + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof AccessRegistryCurrentStateResponse2 + */ + 'next'?: string; + /** + * Cursor for previous page + * @type {string} + * @memberof AccessRegistryCurrentStateResponse2 + */ + 'prev'?: string; + /** + * Total count of active addresses in the access registry + * @type {number} + * @memberof AccessRegistryCurrentStateResponse2 + */ + 'total'?: number; +} + diff --git a/models/active-roles-map.ts b/models/active-roles-map.ts new file mode 100644 index 00000000..46f2fb49 --- /dev/null +++ b/models/active-roles-map.ts @@ -0,0 +1,29 @@ +/* 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 { RoleDetails } from './role-details'; + +/** + * Active RBAC roles on the contract, keyed by role name (e.g. DEFAULT_ADMIN_ROLE, MINTER_ROLE). Each entry contains the on-chain role hash, a human-readable description, and the list of accounts currently granted that role. + * @export + * @interface ActiveRolesMap + */ +export interface ActiveRolesMap { + [key: string]: RoleDetails; + +} + diff --git a/models/active-roles-response.ts b/models/active-roles-response.ts index 4dcafdf6..7297af28 100644 --- a/models/active-roles-response.ts +++ b/models/active-roles-response.ts @@ -15,15 +15,19 @@ // May contain unused imports in some cases // @ts-ignore -import { RoleDetails } from './role-details'; +import { ActiveRolesMap } from './active-roles-map'; /** - * A map of role names to their details + * * @export * @interface ActiveRolesResponse */ export interface ActiveRolesResponse { - [key: string]: RoleDetails; - + /** + * + * @type {ActiveRolesMap} + * @memberof ActiveRolesResponse + */ + 'activeRoles': ActiveRolesMap; } diff --git a/models/active-roles-response2.ts b/models/active-roles-response2.ts new file mode 100644 index 00000000..e1ae01c6 --- /dev/null +++ b/models/active-roles-response2.ts @@ -0,0 +1,29 @@ +/* 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 { RoleDetails2 } from './role-details2'; + +/** + * A map of role names to their details + * @export + * @interface ActiveRolesResponse2 + */ +export interface ActiveRolesResponse2 { + [key: string]: RoleDetails2; + +} + diff --git a/models/address-balance-paged-response2.ts b/models/address-balance-paged-response2.ts new file mode 100644 index 00000000..3503c5ce --- /dev/null +++ b/models/address-balance-paged-response2.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 { AddressBalanceItemDto } from './address-balance-item-dto'; + +/** + * + * @export + * @interface AddressBalancePagedResponse2 + */ +export interface AddressBalancePagedResponse2 { + /** + * Array of address balance data + * @type {Array} + * @memberof AddressBalancePagedResponse2 + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof AddressBalancePagedResponse2 + */ + 'next'?: string; + /** + * Cursor for previous page (reserved for future support) + * @type {string} + * @memberof AddressBalancePagedResponse2 + */ + 'prev'?: string; + /** + * Total count of items + * @type {number} + * @memberof AddressBalancePagedResponse2 + */ + 'total'?: number; +} + diff --git a/models/allowlist-entry-provider-metadata.ts b/models/allowlist-entry-provider-metadata.ts new file mode 100644 index 00000000..35b16074 --- /dev/null +++ b/models/allowlist-entry-provider-metadata.ts @@ -0,0 +1,26 @@ +/* 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. + */ + + + +/** + * Provider-specific pass-through data for this address. Treat as an opaque blob: the shape, set of keys, and value types vary by provider, by entry, and over time. Keys may be added, renamed, or removed without notice as providers evolve their integrations or as new providers are added. The example below illustrates one possible shape and is not a contract — do not program against specific keys. + * @export + * @interface AllowlistEntryProviderMetadata + */ +export interface AllowlistEntryProviderMetadata { + [key: string]: any; + +} + diff --git a/models/allowlist-entry-status.ts b/models/allowlist-entry-status.ts new file mode 100644 index 00000000..15febb29 --- /dev/null +++ b/models/allowlist-entry-status.ts @@ -0,0 +1,35 @@ +/* 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. + */ + + + +/** + * Current status of the allowlist entry. - `ACTIVE` — Entry is approved and usable. - `PENDING_PROVIDER_COOLDOWN` — Entry was recently added or modified and is in the provider-enforced cooldown window before becoming active. - `PENDING_PROVIDER_REVIEW` — Entry is awaiting provider-side review. - `PENDING_APPROVAL` — Entry is awaiting customer/admin approval on the Fireblocks side. - `REJECTED` — Entry was rejected at submission time and will not become active. - `REMOVED` — Entry was deactivated after previously being active. May still appear in results for audit purposes. + * @export + * @enum {string} + */ + +export const AllowlistEntryStatus = { + Active: 'ACTIVE', + PendingProviderCooldown: 'PENDING_PROVIDER_COOLDOWN', + PendingProviderReview: 'PENDING_PROVIDER_REVIEW', + PendingApproval: 'PENDING_APPROVAL', + Rejected: 'REJECTED', + Removed: 'REMOVED' +} as const; + +export type AllowlistEntryStatus = typeof AllowlistEntryStatus[keyof typeof AllowlistEntryStatus]; + + + diff --git a/models/allowlist-entry.ts b/models/allowlist-entry.ts new file mode 100644 index 00000000..71395f68 --- /dev/null +++ b/models/allowlist-entry.ts @@ -0,0 +1,92 @@ +/* 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 { AllowlistEntryProviderMetadata } from './allowlist-entry-provider-metadata'; +// May contain unused imports in some cases +// @ts-ignore +import { AllowlistEntryStatus } from './allowlist-entry-status'; + +/** + * + * @export + * @interface AllowlistEntry + */ +export interface AllowlistEntry { + /** + * Unique identifier for the allowlist entry + * @type {string} + * @memberof AllowlistEntry + */ + 'id': string; + /** + * The blockchain address + * @type {string} + * @memberof AllowlistEntry + */ + 'address': string; + /** + * Assets approved for this address. Each value is either a Fireblocks asset ID (when the provider\'s asset maps to a Fireblocks-supported asset) or the raw provider asset symbol (when no mapping exists). Treat values as opaque strings. Possible combinations: - One or more specific asset values (e.g., `[\"BTC\", \"ETH\"]`) See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. + * @type {Array} + * @memberof AllowlistEntry + */ + 'assets': Array; + /** + * Networks approved for this address. Each value is either a Fireblocks network ID (when the provider\'s network maps to a Fireblocks-supported blockchain) or the raw provider blockchain identifier (when no mapping exists). Treat values as opaque strings. Possible combinations: - One or more specific network values (e.g., `[\"ETHEREUM\", \"POLYGON\"]`) See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. + * @type {Array} + * @memberof AllowlistEntry + */ + 'networks': Array; + /** + * + * @type {AllowlistEntryStatus} + * @memberof AllowlistEntry + */ + 'status': AllowlistEntryStatus; + /** + * ISO 8601 timestamp when entry was added + * @type {string} + * @memberof AllowlistEntry + */ + 'addedAt': string; + /** + * Human-readable label for the address + * @type {string} + * @memberof AllowlistEntry + */ + 'label'?: string | null; + /** + * Additional identifier (e.g., memo, destination tag) + * @type {string} + * @memberof AllowlistEntry + */ + 'addressIdentifier'?: string | null; + /** + * Provider\'s internal reference ID + * @type {string} + * @memberof AllowlistEntry + */ + 'providerReferenceId'?: string | null; + /** + * + * @type {AllowlistEntryProviderMetadata} + * @memberof AllowlistEntry + */ + 'providerMetadata'?: AllowlistEntryProviderMetadata | null; +} + + + diff --git a/models/allowlist-metadata.ts b/models/allowlist-metadata.ts new file mode 100644 index 00000000..b639d8de --- /dev/null +++ b/models/allowlist-metadata.ts @@ -0,0 +1,46 @@ +/* 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. + */ + + + +/** + * Allowlist-specific metadata + * @export + * @interface AllowlistMetadata + */ +export interface AllowlistMetadata { + /** + * ISO 8601 timestamp of last sync with provider + * @type {string} + * @memberof AllowlistMetadata + */ + 'lastSyncedAt'?: string; + /** + * Status of last sync operation + * @type {string} + * @memberof AllowlistMetadata + */ + 'syncStatus'?: AllowlistMetadataSyncStatusEnum; +} + +export const AllowlistMetadataSyncStatusEnum = { + Success: 'SUCCESS', + Failed: 'FAILED', + InProgress: 'IN_PROGRESS', + NeverSynced: 'NEVER_SYNCED' +} as const; + +export type AllowlistMetadataSyncStatusEnum = typeof AllowlistMetadataSyncStatusEnum[keyof typeof AllowlistMetadataSyncStatusEnum]; + + diff --git a/models/allowlist-response.ts b/models/allowlist-response.ts new file mode 100644 index 00000000..63d46258 --- /dev/null +++ b/models/allowlist-response.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 { AllowlistEntry } from './allowlist-entry'; +// May contain unused imports in some cases +// @ts-ignore +import { AllowlistMetadata } from './allowlist-metadata'; + +/** + * + * @export + * @interface AllowlistResponse + */ +export interface AllowlistResponse { + /** + * Array of allowlist entries + * @type {Array} + * @memberof AllowlistResponse + */ + 'data': Array; + /** + * Total number of allowlist entries + * @type {number} + * @memberof AllowlistResponse + */ + 'total': number; + /** + * + * @type {AllowlistMetadata} + * @memberof AllowlistResponse + */ + 'metadata'?: AllowlistMetadata; + /** + * Cursor for the next page of results, if available + * @type {string} + * @memberof AllowlistResponse + */ + 'next'?: string; +} + diff --git a/models/balance-history-paged-response2.ts b/models/balance-history-paged-response2.ts new file mode 100644 index 00000000..f7f29bdb --- /dev/null +++ b/models/balance-history-paged-response2.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 { BalanceHistoryItemDto } from './balance-history-item-dto'; + +/** + * + * @export + * @interface BalanceHistoryPagedResponse2 + */ +export interface BalanceHistoryPagedResponse2 { + /** + * Array of balance history data points + * @type {Array} + * @memberof BalanceHistoryPagedResponse2 + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof BalanceHistoryPagedResponse2 + */ + 'next'?: string; + /** + * Cursor for previous page + * @type {string} + * @memberof BalanceHistoryPagedResponse2 + */ + 'prev'?: string; + /** + * Total count of items + * @type {number} + * @memberof BalanceHistoryPagedResponse2 + */ + 'total'?: number; +} + diff --git a/models/business-identification.ts b/models/business-identification.ts index ae4cc17f..ce6e9ac5 100644 --- a/models/business-identification.ts +++ b/models/business-identification.ts @@ -77,6 +77,18 @@ export interface BusinessIdentification { * @memberof BusinessIdentification */ 'phone'?: string; + /** + * The date the business was registered. + * @type {string} + * @memberof BusinessIdentification + */ + 'dateOfRegistration'?: string; + /** + * The ISO-3166 Alpha-2 country code where the business is registered. + * @type {string} + * @memberof BusinessIdentification + */ + 'countryOfRegistration'?: string; } diff --git a/models/connected-account-type.ts b/models/connected-account-type.ts new file mode 100644 index 00000000..160bfe0d --- /dev/null +++ b/models/connected-account-type.ts @@ -0,0 +1,32 @@ +/* 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. + */ + + + +/** + * + * @export + * @enum {string} + */ + +export const ConnectedAccountType = { + Exchange: 'EXCHANGE', + Fiat: 'FIAT', + ConnectedAccount: 'CONNECTED_ACCOUNT' +} as const; + +export type ConnectedAccountType = typeof ConnectedAccountType[keyof typeof ConnectedAccountType]; + + + diff --git a/models/connected-account.ts b/models/connected-account.ts index 78aebced..3a1bbd11 100644 --- a/models/connected-account.ts +++ b/models/connected-account.ts @@ -22,6 +22,9 @@ import { ConnectedAccountManifest } from './connected-account-manifest'; // May contain unused imports in some cases // @ts-ignore import { ConnectedAccountTotalBalance } from './connected-account-total-balance'; +// May contain unused imports in some cases +// @ts-ignore +import { ConnectedAccountType } from './connected-account-type'; /** * @@ -65,12 +68,30 @@ export interface ConnectedAccount { * @memberof ConnectedAccount */ 'manifest': ConnectedAccountManifest; + /** + * + * @type {ConnectedAccountType} + * @memberof ConnectedAccount + */ + 'accountType': ConnectedAccountType; /** * The ID of the parent main account, if this is a sub account. * @type {string} * @memberof ConnectedAccount */ 'parentId'?: string; + /** + * The API key identifier used to connect this account. + * @type {string} + * @memberof ConnectedAccount + */ + 'apiKey'?: string; + /** + * The account name provided by the provider. + * @type {string} + * @memberof ConnectedAccount + */ + 'providerAccountName'?: string; } diff --git a/models/connected-single-account-response.ts b/models/connected-single-account-response.ts index 5f7e751a..0371b5e3 100644 --- a/models/connected-single-account-response.ts +++ b/models/connected-single-account-response.ts @@ -27,6 +27,9 @@ import { ConnectedAccountManifest } from './connected-account-manifest'; import { ConnectedAccountTotalBalance } from './connected-account-total-balance'; // May contain unused imports in some cases // @ts-ignore +import { ConnectedAccountType } from './connected-account-type'; +// May contain unused imports in some cases +// @ts-ignore import { ConnectedSingleAccount } from './connected-single-account'; /** diff --git a/models/create-webhook-request.ts b/models/create-webhook-request.ts index 53387704..dd5082db 100644 --- a/models/create-webhook-request.ts +++ b/models/create-webhook-request.ts @@ -16,6 +16,9 @@ // May contain unused imports in some cases // @ts-ignore import { WebhookEvent } from './webhook-event'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookMtls } from './webhook-mtls'; /** * @@ -47,5 +50,11 @@ export interface CreateWebhookRequest { * @memberof CreateWebhookRequest */ 'enabled'?: boolean; + /** + * + * @type {WebhookMtls} + * @memberof CreateWebhookRequest + */ + 'mtls'?: WebhookMtls | null; } diff --git a/models/identification.ts b/models/identification.ts index 2f0277db..c93d0402 100644 --- a/models/identification.ts +++ b/models/identification.ts @@ -27,6 +27,9 @@ import { ParticipantRelationshipType } from './participant-relationship-type'; import { PersonalIdentification } from './personal-identification'; // May contain unused imports in some cases // @ts-ignore +import { PersonalIdentificationDocument } from './personal-identification-document'; +// May contain unused imports in some cases +// @ts-ignore import { PersonalIdentificationFullName } from './personal-identification-full-name'; // May contain unused imports in some cases // @ts-ignore diff --git a/models/index.ts b/models/index.ts index bbcf6c97..570567e0 100644 --- a/models/index.ts +++ b/models/index.ts @@ -4,6 +4,7 @@ export * from './aba-payment-info'; export * from './abi-function'; export * from './access-registry-address-item'; export * from './access-registry-current-state-response'; +export * from './access-registry-current-state-response2'; export * from './access-registry-summary-response'; export * from './access-type'; export * from './account'; @@ -22,7 +23,9 @@ export * from './ach-address'; export * from './ach-destination'; export * from './ach-payment-info'; export * from './action-record'; +export * from './active-roles-map'; export * from './active-roles-response'; +export * from './active-roles-response2'; export * from './adapter-processing-result'; export * from './add-abi-request-dto'; export * from './add-asset-to-external-wallet-request'; @@ -37,6 +40,7 @@ export * from './additional-info-request'; export * from './additional-info-request-additional-info'; export * from './address-balance-item-dto'; export * from './address-balance-paged-response'; +export * from './address-balance-paged-response2'; export * from './address-not-available-error'; export * from './address-registry-add-vault-opt-outs-request'; export * from './address-registry-add-vault-opt-outs-request-vault-account-ids-inner'; @@ -54,6 +58,11 @@ export * from './address-registry-vault-opt-out-item'; export * from './address-reverse-lookup-response'; export * from './alert-exposure-type-enum'; export * from './alert-level-enum'; +export * from './allowlist-entry'; +export * from './allowlist-entry-provider-metadata'; +export * from './allowlist-entry-status'; +export * from './allowlist-metadata'; +export * from './allowlist-response'; export * from './aml-alert'; export * from './aml-matched-rule'; export * from './aml-registration-result'; @@ -119,6 +128,7 @@ export * from './authorization-groups'; export * from './authorization-info'; export * from './balance-history-item-dto'; export * from './balance-history-paged-response'; +export * from './balance-history-paged-response2'; export * from './bank-address'; export * from './base-provider'; export * from './basic-address-request'; @@ -191,6 +201,7 @@ export * from './connected-account-total-balance'; export * from './connected-account-trading-pair'; export * from './connected-account-trading-pair-supported-type'; export * from './connected-account-trading-pairs-response'; +export * from './connected-account-type'; export * from './connected-accounts-response'; export * from './connected-single-account'; export * from './connected-single-account-response'; @@ -581,6 +592,9 @@ export * from './offer'; export * from './offers-response'; export * from './onchain-transaction'; export * from './onchain-transactions-paged-response'; +export * from './onchain-transactions-paged-response2'; +export * from './onchain-transfer-event'; +export * from './onchain-transfers-paged-response'; export * from './one-time-address'; export * from './one-time-address-account'; export * from './one-time-address-peer-type'; @@ -589,6 +603,9 @@ export * from './operation-execution-failure'; export * from './opportunity'; export * from './order-details'; export * from './order-execution-step'; +export * from './order-requirement-allowed-file-type'; +export * from './order-requirement-details'; +export * from './order-requirement-file'; export * from './order-side'; export * from './order-status'; export * from './order-summary'; @@ -630,6 +647,7 @@ export * from './peer-adapter-info'; export * from './peer-type'; export * from './personal-entity-type-enum'; export * from './personal-identification'; +export * from './personal-identification-document'; export * from './personal-identification-full-name'; export * from './personal-identification-type'; export * from './pix-address'; @@ -657,6 +675,7 @@ export * from './policy-verdict-action-enum'; export * from './policy-verdict-action-enum2'; export * from './position'; export * from './position2'; +export * from './position-related-transaction'; export * from './postal-address'; export * from './pre-screening'; export * from './prefunded-settlement'; @@ -720,6 +739,7 @@ export * from './retry-requote-type-enum'; export * from './reward-info'; export * from './rewards-info'; export * from './role-details'; +export * from './role-details2'; export * from './role-grantee'; export * from './sepaaddress'; export * from './sepadestination'; @@ -844,10 +864,12 @@ export * from './staking-get-all-delegations-response'; export * from './staking-get-chains-response'; export * from './staking-get-providers-response'; export * from './staking-get-summary-by-vault-response'; +export * from './staking-position-related-transactions-paginated-response'; export * from './staking-positions-paginated-response'; export * from './staking-provider'; export * from './status'; export * from './stellar-ripple-create-params-dto'; +export * from './submit-order-requirement-request'; export * from './supported-block-chains-response'; export * from './supported-blockchain'; export * from './swift-address'; @@ -971,10 +993,12 @@ export * from './token-response'; export * from './tokens-paginated-response'; export * from './total-supply-item-dto'; export * from './total-supply-paged-response'; +export * from './total-supply-paged-response2'; export * from './trading-account-type'; export * from './trading-error-schema'; export * from './trading-provider'; export * from './transaction'; +export * from './transaction-configurations'; export * from './transaction-direction'; export * from './transaction-fee'; export * from './transaction-operation'; @@ -1007,6 +1031,7 @@ export * from './transfer-peer-path-sub-type'; export * from './transfer-peer-path-type'; export * from './transfer-peer-sub-type-enum'; export * from './transfer-peer-type-enum'; +export * from './transfer-peer-type-enum2'; export * from './transfer-rail'; export * from './transfer-receipt'; export * from './transfer-validation-failure'; @@ -1122,6 +1147,8 @@ export * from './wallet-asset-additional-info'; export * from './webhook'; export * from './webhook-event'; export * from './webhook-metric'; +export * from './webhook-mtls'; +export * from './webhook-mtls-csr-response'; export * from './webhook-paginated-response'; export * from './withdraw-request'; export * from './workflow-config-status'; diff --git a/models/onchain-transactions-paged-response2.ts b/models/onchain-transactions-paged-response2.ts new file mode 100644 index 00000000..e74a5594 --- /dev/null +++ b/models/onchain-transactions-paged-response2.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 { OnchainTransaction } from './onchain-transaction'; + +/** + * + * @export + * @interface OnchainTransactionsPagedResponse2 + */ +export interface OnchainTransactionsPagedResponse2 { + /** + * Array of onchain transactions + * @type {Array} + * @memberof OnchainTransactionsPagedResponse2 + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof OnchainTransactionsPagedResponse2 + */ + 'next'?: string; + /** + * Cursor for previous page + * @type {string} + * @memberof OnchainTransactionsPagedResponse2 + */ + 'prev'?: string; + /** + * Total count of items + * @type {number} + * @memberof OnchainTransactionsPagedResponse2 + */ + 'total'?: number; +} + diff --git a/models/onchain-transfer-event.ts b/models/onchain-transfer-event.ts new file mode 100644 index 00000000..d2efed3d --- /dev/null +++ b/models/onchain-transfer-event.ts @@ -0,0 +1,102 @@ +/* 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. + */ + + + +/** + * + * @export + * @interface OnchainTransferEvent + */ +export interface OnchainTransferEvent { + /** + * Unique identifier for the transfer event + * @type {string} + * @memberof OnchainTransferEvent + */ + 'id': string; + /** + * Hash of the transaction containing this transfer + * @type {string} + * @memberof OnchainTransferEvent + */ + 'transactionHash': string; + /** + * Index of the log within the transaction + * @type {string} + * @memberof OnchainTransferEvent + */ + 'logIndex': string; + /** + * Address of the token contract + * @type {string} + * @memberof OnchainTransferEvent + */ + 'contractAddress': string; + /** + * Address that sent the tokens + * @type {string} + * @memberof OnchainTransferEvent + */ + 'fromAddress': string; + /** + * Address that received the tokens + * @type {string} + * @memberof OnchainTransferEvent + */ + 'toAddress': string; + /** + * Amount of tokens transferred (in smallest unit) + * @type {string} + * @memberof OnchainTransferEvent + */ + 'value': string; + /** + * Chain ID of the blockchain + * @type {number} + * @memberof OnchainTransferEvent + */ + 'chainId': number; + /** + * The blockchain base asset identifier + * @type {string} + * @memberof OnchainTransferEvent + */ + 'baseAssetId': string; + /** + * Block number containing this transfer + * @type {number} + * @memberof OnchainTransferEvent + */ + 'blockNumber': number; + /** + * Hash of the block containing this transfer + * @type {string} + * @memberof OnchainTransferEvent + */ + 'blockHash': string; + /** + * Timestamp when the block was mined + * @type {string} + * @memberof OnchainTransferEvent + */ + 'blockTimestamp': string; + /** + * Name of the event (typically \"Transfer\") + * @type {string} + * @memberof OnchainTransferEvent + */ + 'eventName': string; +} + diff --git a/models/onchain-transfers-paged-response.ts b/models/onchain-transfers-paged-response.ts new file mode 100644 index 00000000..49a5bc9c --- /dev/null +++ b/models/onchain-transfers-paged-response.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 { OnchainTransferEvent } from './onchain-transfer-event'; + +/** + * + * @export + * @interface OnchainTransfersPagedResponse + */ +export interface OnchainTransfersPagedResponse { + /** + * Array of ERC20 transfer events + * @type {Array} + * @memberof OnchainTransfersPagedResponse + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof OnchainTransfersPagedResponse + */ + 'next'?: string; + /** + * Cursor for previous page + * @type {string} + * @memberof OnchainTransfersPagedResponse + */ + 'prev'?: string; + /** + * Total count of items + * @type {number} + * @memberof OnchainTransfersPagedResponse + */ + 'total'?: number; +} + diff --git a/models/order-requirement-allowed-file-type.ts b/models/order-requirement-allowed-file-type.ts new file mode 100644 index 00000000..224eea4d --- /dev/null +++ b/models/order-requirement-allowed-file-type.ts @@ -0,0 +1,39 @@ +/* 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. + */ + + + +/** + * Supported file formats for order requirement file uploads. + * @export + * @enum {string} + */ + +export const OrderRequirementAllowedFileType = { + Pdf: 'PDF', + Jpeg: 'JPEG', + Png: 'PNG', + Heic: 'HEIC', + Heif: 'HEIF', + Doc: 'DOC', + Docx: 'DOCX', + Xls: 'XLS', + Xlsx: 'XLSX', + Csv: 'CSV' +} as const; + +export type OrderRequirementAllowedFileType = typeof OrderRequirementAllowedFileType[keyof typeof OrderRequirementAllowedFileType]; + + + diff --git a/models/order-requirement-details.ts b/models/order-requirement-details.ts new file mode 100644 index 00000000..17b592b5 --- /dev/null +++ b/models/order-requirement-details.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 { OrderRequirementFile } from './order-requirement-file'; + +/** + * Order requirement details for an order that is awaiting compliance requirements. Returned by GET /trading/orders/{orderId}/requirement. + * @export + * @interface OrderRequirementDetails + */ +export interface OrderRequirementDetails { + /** + * Unique identifier of the order requirement request as issued by the provider. + * @type {string} + * @memberof OrderRequirementDetails + */ + 'requirementId': string; + /** + * A JSON Schema (Draft-7) in string format describing the shape of the `data` object expected on the corresponding POST /trading/orders/{orderId}/requirement/data request. The schema is the contract: the client builds the `data` payload to match it, and SDKs can validate before sending. The string content is expected to be valid JSON (application/json). + * @type {string} + * @memberof OrderRequirementDetails + */ + 'requiredData': string; + /** + * Descriptors for files the provider requires as part of the order requirement response. Empty when no files are required. Each entry\'s `fileKey` is used to correlate uploads on the corresponding upload request. + * @type {Array} + * @memberof OrderRequirementDetails + */ + 'requiredFiles': Array; + /** + * ISO-8601 timestamp indicating when the order requirement submission is due. + * @type {string} + * @memberof OrderRequirementDetails + */ + 'dueBy'?: string; +} + diff --git a/models/order-requirement-file.ts b/models/order-requirement-file.ts new file mode 100644 index 00000000..f3793d50 --- /dev/null +++ b/models/order-requirement-file.ts @@ -0,0 +1,45 @@ +/* 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 { OrderRequirementAllowedFileType } from './order-requirement-allowed-file-type'; + +/** + * A file the provider requires as part of the order requirement response. + * @export + * @interface OrderRequirementFile + */ +export interface OrderRequirementFile { + /** + * Stable identifier for this required file. Used to correlate uploads on submission. + * @type {string} + * @memberof OrderRequirementFile + */ + 'fileKey': string; + /** + * Human-readable description of what the file should contain. + * @type {string} + * @memberof OrderRequirementFile + */ + 'description': string; + /** + * File formats the provider accepts for this entry. + * @type {Array} + * @memberof OrderRequirementFile + */ + 'allowedFileTypes': Array; +} + diff --git a/models/order-status.ts b/models/order-status.ts index eb0d2421..dcf23dc2 100644 --- a/models/order-status.ts +++ b/models/order-status.ts @@ -23,6 +23,7 @@ export const OrderStatus = { Created: 'CREATED', AwaitingPayment: 'AWAITING_PAYMENT', + AwaitingInformation: 'AWAITING_INFORMATION', PendingUserAction: 'PENDING_USER_ACTION', Processing: 'PROCESSING', Canceled: 'CANCELED', diff --git a/models/personal-identification-document.ts b/models/personal-identification-document.ts new file mode 100644 index 00000000..3e9f56b9 --- /dev/null +++ b/models/personal-identification-document.ts @@ -0,0 +1,47 @@ +/* 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 { PersonalIdentificationType } from './personal-identification-type'; + +/** + * + * @export + * @interface PersonalIdentificationDocument + */ +export interface PersonalIdentificationDocument { + /** + * The identification document number. + * @type {string} + * @memberof PersonalIdentificationDocument + */ + 'id'?: string; + /** + * + * @type {PersonalIdentificationType} + * @memberof PersonalIdentificationDocument + */ + 'type'?: PersonalIdentificationType; + /** + * The expiration date of the identification document. + * @type {string} + * @memberof PersonalIdentificationDocument + */ + 'expirationDate'?: string; +} + + + diff --git a/models/personal-identification.ts b/models/personal-identification.ts index 545f10c4..61f9e43e 100644 --- a/models/personal-identification.ts +++ b/models/personal-identification.ts @@ -21,6 +21,9 @@ import { ParticipantRelationshipType } from './participant-relationship-type'; import { PersonalEntityTypeEnum } from './personal-entity-type-enum'; // May contain unused imports in some cases // @ts-ignore +import { PersonalIdentificationDocument } from './personal-identification-document'; +// May contain unused imports in some cases +// @ts-ignore import { PersonalIdentificationFullName } from './personal-identification-full-name'; // May contain unused imports in some cases // @ts-ignore @@ -84,29 +87,45 @@ export interface PersonalIdentification { */ 'phone'?: string; /** - * The identification number corresponding to the primary identification document type specified in idType + * Deprecated. Use identificationDocuments instead. * @type {string} * @memberof PersonalIdentification + * @deprecated */ 'idNumber'?: string; /** - * + * Deprecated. Use identificationDocuments instead. * @type {PersonalIdentificationType} * @memberof PersonalIdentification + * @deprecated */ 'idType'?: PersonalIdentificationType; /** - * The identification number corresponding to the additional identification document type specified in additionalIdType + * Deprecated. Use identificationDocuments instead. * @type {string} * @memberof PersonalIdentification + * @deprecated */ 'additionalIdNumber'?: string; /** - * + * Deprecated. Use identificationDocuments instead. * @type {PersonalIdentificationType} * @memberof PersonalIdentification + * @deprecated */ 'additionalIdType'?: PersonalIdentificationType; + /** + * The ISO-3166 Alpha-2 country code representing the individual\'s nationality. + * @type {string} + * @memberof PersonalIdentification + */ + 'nationality'?: string; + /** + * List of identification documents for the individual. + * @type {Array} + * @memberof PersonalIdentification + */ + 'identificationDocuments'?: Array; } diff --git a/models/position-related-transaction.ts b/models/position-related-transaction.ts new file mode 100644 index 00000000..20ff200c --- /dev/null +++ b/models/position-related-transaction.ts @@ -0,0 +1,90 @@ +/* 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. + */ + + + +/** + * + * @export + * @interface PositionRelatedTransaction + */ +export interface PositionRelatedTransaction { + /** + * The transaction ID. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'txId': string; + /** + * ISO timestamp when the transaction was initiated (send time). + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'timestamp': string; + /** + * Transaction outcome. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'status': PositionRelatedTransactionStatusEnum; + /** + * On-chain transaction hash. Absent while the transaction is pending. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'txHash'?: string; + /** + * Staking operation type. One of APPROVE, STAKE, UNSTAKE, WITHDRAW, CLAIM_REWARDS, SPLIT, CONSOLIDATE, MERGE, TRANSFER, AUTHORIZE, ADD_TO_STAKE. Absent on legacy persisted rows. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'stakingOperation'?: PositionRelatedTransactionStakingOperationEnum; + /** + * Portion of position amount this transaction moved (native units). Absent on legacy rows. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'amount'?: string; + /** + * User-provided note from the transfer request. Omitted when not set. + * @type {string} + * @memberof PositionRelatedTransaction + */ + 'txNote'?: string; +} + +export const PositionRelatedTransactionStatusEnum = { + Pending: 'PENDING', + Completed: 'COMPLETED', + Failed: 'FAILED' +} as const; + +export type PositionRelatedTransactionStatusEnum = typeof PositionRelatedTransactionStatusEnum[keyof typeof PositionRelatedTransactionStatusEnum]; +export const PositionRelatedTransactionStakingOperationEnum = { + Approve: 'APPROVE', + Stake: 'STAKE', + Unstake: 'UNSTAKE', + Withdraw: 'WITHDRAW', + ClaimRewards: 'CLAIM_REWARDS', + Split: 'SPLIT', + Consolidate: 'CONSOLIDATE', + Merge: 'MERGE', + Transfer: 'TRANSFER', + Authorize: 'AUTHORIZE', + AddToStake: 'ADD_TO_STAKE' +} as const; + +export type PositionRelatedTransactionStakingOperationEnum = typeof PositionRelatedTransactionStakingOperationEnum[keyof typeof PositionRelatedTransactionStakingOperationEnum]; + + diff --git a/models/quote.ts b/models/quote.ts index 5adbdb5c..c352f35d 100644 --- a/models/quote.ts +++ b/models/quote.ts @@ -136,7 +136,7 @@ export interface Quote { * @type {string} * @memberof Quote */ - 'orderCreationRequirements'?: string; + 'requiredParticipantsIdentificationOnOrder'?: string; } export const QuoteTypeEnum = { diff --git a/models/role-details2.ts b/models/role-details2.ts new file mode 100644 index 00000000..739f1955 --- /dev/null +++ b/models/role-details2.ts @@ -0,0 +1,45 @@ +/* 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 { RoleGrantee } from './role-grantee'; + +/** + * + * @export + * @interface RoleDetails2 + */ +export interface RoleDetails2 { + /** + * The role hash identifier + * @type {string} + * @memberof RoleDetails2 + */ + 'roleHash': string; + /** + * Human-readable description of the role + * @type {string} + * @memberof RoleDetails2 + */ + 'description': string; + /** + * List of accounts that have been granted this role + * @type {Array} + * @memberof RoleDetails2 + */ + 'accounts': Array; +} + diff --git a/models/screening-travel-rule-prescreening-rule.ts b/models/screening-travel-rule-prescreening-rule.ts index cbd161b9..9a48bb39 100644 --- a/models/screening-travel-rule-prescreening-rule.ts +++ b/models/screening-travel-rule-prescreening-rule.ts @@ -21,7 +21,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleActionEnum } from './travel-rule-action-enum'; @@ -40,10 +40,10 @@ export interface ScreeningTravelRulePrescreeningRule { 'bypassReason'?: string; /** * - * @type {TransferPeerTypeEnum} + * @type {TransferPeerTypeEnum2} * @memberof ScreeningTravelRulePrescreeningRule */ - 'sourceType'?: TransferPeerTypeEnum; + 'sourceType'?: TransferPeerTypeEnum2; /** * * @type {TransferPeerSubTypeEnum} @@ -52,10 +52,10 @@ export interface ScreeningTravelRulePrescreeningRule { 'sourceSubType'?: TransferPeerSubTypeEnum; /** * - * @type {TransferPeerTypeEnum} + * @type {TransferPeerTypeEnum2} * @memberof ScreeningTravelRulePrescreeningRule */ - 'destType'?: TransferPeerTypeEnum; + 'destType'?: TransferPeerTypeEnum2; /** * * @type {TransferPeerSubTypeEnum} @@ -64,10 +64,10 @@ export interface ScreeningTravelRulePrescreeningRule { 'destSubType'?: TransferPeerSubTypeEnum; /** * - * @type {TransferPeerTypeEnum} + * @type {TransferPeerTypeEnum2} * @memberof ScreeningTravelRulePrescreeningRule */ - 'transferPeerType'?: TransferPeerTypeEnum; + 'transferPeerType'?: TransferPeerTypeEnum2; /** * * @type {TransferPeerSubTypeEnum} diff --git a/models/screening-trlink-missing-trm-decision.ts b/models/screening-trlink-missing-trm-decision.ts index e0f601fd..a4d99805 100644 --- a/models/screening-trlink-missing-trm-decision.ts +++ b/models/screening-trlink-missing-trm-decision.ts @@ -30,7 +30,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleDirectionEnum } from './travel-rule-direction-enum'; diff --git a/models/screening-trlink-missing-trm-rule.ts b/models/screening-trlink-missing-trm-rule.ts index daae17b0..5ef2f96a 100644 --- a/models/screening-trlink-missing-trm-rule.ts +++ b/models/screening-trlink-missing-trm-rule.ts @@ -30,7 +30,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleDirectionEnum } from './travel-rule-direction-enum'; diff --git a/models/screening-trlink-post-screening-rule.ts b/models/screening-trlink-post-screening-rule.ts index 98575da7..a2dd2c59 100644 --- a/models/screening-trlink-post-screening-rule.ts +++ b/models/screening-trlink-post-screening-rule.ts @@ -33,7 +33,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleDirectionEnum } from './travel-rule-direction-enum'; diff --git a/models/screening-trlink-prescreening-rule.ts b/models/screening-trlink-prescreening-rule.ts index bafd54e3..3019ac43 100644 --- a/models/screening-trlink-prescreening-rule.ts +++ b/models/screening-trlink-prescreening-rule.ts @@ -30,7 +30,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleDirectionEnum } from './travel-rule-direction-enum'; diff --git a/models/screening-trlink-rule-base.ts b/models/screening-trlink-rule-base.ts index 8cf427ea..37f3d453 100644 --- a/models/screening-trlink-rule-base.ts +++ b/models/screening-trlink-rule-base.ts @@ -24,7 +24,7 @@ import { TransactionOperationEnum } from './transaction-operation-enum'; import { TransferPeerSubTypeEnum } from './transfer-peer-sub-type-enum'; // May contain unused imports in some cases // @ts-ignore -import { TransferPeerTypeEnum } from './transfer-peer-type-enum'; +import { TransferPeerTypeEnum2 } from './transfer-peer-type-enum2'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleDirectionEnum } from './travel-rule-direction-enum'; @@ -49,10 +49,10 @@ export interface ScreeningTRLinkRuleBase { 'direction'?: TravelRuleDirectionEnum; /** * - * @type {TransferPeerTypeEnum} + * @type {TransferPeerTypeEnum2} * @memberof ScreeningTRLinkRuleBase */ - 'sourceType'?: TransferPeerTypeEnum; + 'sourceType'?: TransferPeerTypeEnum2; /** * * @type {TransferPeerSubTypeEnum} @@ -67,10 +67,10 @@ export interface ScreeningTRLinkRuleBase { 'sourceAddress'?: string; /** * - * @type {TransferPeerTypeEnum} + * @type {TransferPeerTypeEnum2} * @memberof ScreeningTRLinkRuleBase */ - 'destType'?: TransferPeerTypeEnum; + 'destType'?: TransferPeerTypeEnum2; /** * * @type {TransferPeerSubTypeEnum} diff --git a/models/staking-position-related-transactions-paginated-response.ts b/models/staking-position-related-transactions-paginated-response.ts new file mode 100644 index 00000000..c0ad3081 --- /dev/null +++ b/models/staking-position-related-transactions-paginated-response.ts @@ -0,0 +1,39 @@ +/* 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 { PositionRelatedTransaction } from './position-related-transaction'; + +/** + * + * @export + * @interface StakingPositionRelatedTransactionsPaginatedResponse + */ +export interface StakingPositionRelatedTransactionsPaginatedResponse { + /** + * The related transactions for the current page. + * @type {Array} + * @memberof StakingPositionRelatedTransactionsPaginatedResponse + */ + 'data': Array; + /** + * Cursor for the next page. Use this value in the pageCursor parameter to fetch the next page. Null if no more pages. + * @type {string} + * @memberof StakingPositionRelatedTransactionsPaginatedResponse + */ + 'next'?: string | null; +} + diff --git a/models/submit-order-requirement-request.ts b/models/submit-order-requirement-request.ts new file mode 100644 index 00000000..d61e7924 --- /dev/null +++ b/models/submit-order-requirement-request.ts @@ -0,0 +1,30 @@ +/* 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. + */ + + + +/** + * Body of POST /trading/orders/{orderId}/requirement/data. Carries the textual response (`data`). Any required files are uploaded separately via POST /trading/orders/{orderId}/requirement/file. + * @export + * @interface SubmitOrderRequirementRequest + */ +export interface SubmitOrderRequirementRequest { + /** + * Free-form object that MUST conform to the `requiredData` JSON Schema returned by the GET endpoint. Carries text/select fields. + * @type {{ [key: string]: any; }} + * @memberof SubmitOrderRequirementRequest + */ + 'data': { [key: string]: any; }; +} + diff --git a/models/total-supply-paged-response2.ts b/models/total-supply-paged-response2.ts new file mode 100644 index 00000000..7c4c14b2 --- /dev/null +++ b/models/total-supply-paged-response2.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 { TotalSupplyItemDto } from './total-supply-item-dto'; + +/** + * + * @export + * @interface TotalSupplyPagedResponse2 + */ +export interface TotalSupplyPagedResponse2 { + /** + * Array of total supply data points + * @type {Array} + * @memberof TotalSupplyPagedResponse2 + */ + 'data': Array; + /** + * Cursor for next page + * @type {string} + * @memberof TotalSupplyPagedResponse2 + */ + 'next'?: string; + /** + * Cursor for previous page + * @type {string} + * @memberof TotalSupplyPagedResponse2 + */ + 'prev'?: string; + /** + * Total count of items + * @type {number} + * @memberof TotalSupplyPagedResponse2 + */ + 'total'?: number; +} + diff --git a/models/transaction-configurations.ts b/models/transaction-configurations.ts new file mode 100644 index 00000000..ad3a253d --- /dev/null +++ b/models/transaction-configurations.ts @@ -0,0 +1,30 @@ +/* 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. + */ + + + +/** + * + * @export + * @interface TransactionConfigurations + */ +export interface TransactionConfigurations { + /** + * The number of seconds the transaction is valid for before it expires. After the specified duration, the transaction will expire if it has not been broadcasted. + * @type {number} + * @memberof TransactionConfigurations + */ + 'expiresAfterSeconds'?: number; +} + diff --git a/models/transaction-request.ts b/models/transaction-request.ts index 2412fc3b..09b21124 100644 --- a/models/transaction-request.ts +++ b/models/transaction-request.ts @@ -24,6 +24,9 @@ import { ExtraParameters } from './extra-parameters'; import { SourceTransferPeerPath } from './source-transfer-peer-path'; // May contain unused imports in some cases // @ts-ignore +import { TransactionConfigurations } from './transaction-configurations'; +// May contain unused imports in some cases +// @ts-ignore import { TransactionOperation } from './transaction-operation'; // May contain unused imports in some cases // @ts-ignore @@ -240,11 +243,11 @@ export interface TransactionRequest { */ 'useGasless'?: boolean; /** - * The number of seconds the transaction is valid for before it expires. After the specified duration, the transaction will expire if it has not been broadcasted. - * @type {number} + * + * @type {TransactionConfigurations} * @memberof TransactionRequest */ - 'expiresAfterSeconds'?: number; + 'configurations'?: TransactionConfigurations; } export const TransactionRequestFeeLevelEnum = { diff --git a/models/transfer-peer-path-type.ts b/models/transfer-peer-path-type.ts index 9116c201..e017e9ee 100644 --- a/models/transfer-peer-path-type.ts +++ b/models/transfer-peer-path-type.ts @@ -36,7 +36,8 @@ export const TransferPeerPathType = { EndUserWallet: 'END_USER_WALLET', ProgramCall: 'PROGRAM_CALL', MultiDestination: 'MULTI_DESTINATION', - OecPartner: 'OEC_PARTNER' + OecPartner: 'OEC_PARTNER', + WalletPool: 'WALLET_POOL' } as const; export type TransferPeerPathType = typeof TransferPeerPathType[keyof typeof TransferPeerPathType]; diff --git a/models/transfer-peer-type-enum.ts b/models/transfer-peer-type-enum.ts index 8563efaf..b5204560 100644 --- a/models/transfer-peer-type-enum.ts +++ b/models/transfer-peer-type-enum.ts @@ -34,7 +34,8 @@ export const TransferPeerTypeEnum = { Unknown: 'UNKNOWN', EndUserWallet: 'END_USER_WALLET', ProgramCall: 'PROGRAM_CALL', - MultiDestination: 'MULTI_DESTINATION' + MultiDestination: 'MULTI_DESTINATION', + WalletPool: 'WALLET_POOL' } as const; export type TransferPeerTypeEnum = typeof TransferPeerTypeEnum[keyof typeof TransferPeerTypeEnum]; diff --git a/models/transfer-peer-type-enum2.ts b/models/transfer-peer-type-enum2.ts new file mode 100644 index 00000000..a8f4c17e --- /dev/null +++ b/models/transfer-peer-type-enum2.ts @@ -0,0 +1,43 @@ +/* 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. + */ + + + +/** + * Transfer peer type (source or destination) + * @export + * @enum {string} + */ + +export const TransferPeerTypeEnum2 = { + VaultAccount: 'VAULT_ACCOUNT', + ExchangeAccount: 'EXCHANGE_ACCOUNT', + InternalWallet: 'INTERNAL_WALLET', + ExternalWallet: 'EXTERNAL_WALLET', + Contract: 'CONTRACT', + NetworkConnection: 'NETWORK_CONNECTION', + FiatAccount: 'FIAT_ACCOUNT', + Compound: 'COMPOUND', + GasStation: 'GAS_STATION', + OneTimeAddress: 'ONE_TIME_ADDRESS', + Unknown: 'UNKNOWN', + EndUserWallet: 'END_USER_WALLET', + ProgramCall: 'PROGRAM_CALL', + MultiDestination: 'MULTI_DESTINATION' +} as const; + +export type TransferPeerTypeEnum2 = typeof TransferPeerTypeEnum2[keyof typeof TransferPeerTypeEnum2]; + + + diff --git a/models/update-webhook-request.ts b/models/update-webhook-request.ts index 66b93de6..4d2fecc1 100644 --- a/models/update-webhook-request.ts +++ b/models/update-webhook-request.ts @@ -16,6 +16,9 @@ // May contain unused imports in some cases // @ts-ignore import { WebhookEvent } from './webhook-event'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookMtls } from './webhook-mtls'; /** * @@ -47,5 +50,11 @@ export interface UpdateWebhookRequest { * @memberof UpdateWebhookRequest */ 'enabled'?: boolean; + /** + * + * @type {WebhookMtls} + * @memberof UpdateWebhookRequest + */ + 'mtls'?: WebhookMtls | null; } diff --git a/models/webhook-mtls-csr-response.ts b/models/webhook-mtls-csr-response.ts new file mode 100644 index 00000000..13b4616d --- /dev/null +++ b/models/webhook-mtls-csr-response.ts @@ -0,0 +1,30 @@ +/* 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. + */ + + + +/** + * mTLS Certificate Signing Request response + * @export + * @interface WebhookMtlsCsrResponse + */ +export interface WebhookMtlsCsrResponse { + /** + * The Fireblocks PEM-encoded Certificate Signing Request (CSR). + * @type {string} + * @memberof WebhookMtlsCsrResponse + */ + 'csr': string; +} + diff --git a/models/webhook-mtls.ts b/models/webhook-mtls.ts new file mode 100644 index 00000000..10bd8c8a --- /dev/null +++ b/models/webhook-mtls.ts @@ -0,0 +1,30 @@ +/* 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. + */ + + + +/** + * mTLS configuration for the webhook. On responses, present only when a signed client certificate is set. On requests, provide a signed client certificate to enable mTLS, or null to remove it. + * @export + * @interface WebhookMtls + */ +export interface WebhookMtls { + /** + * Signed client certificate PEM used for mTLS when delivering notifications. + * @type {string} + * @memberof WebhookMtls + */ + 'clientSignedCert': string; +} + diff --git a/models/webhook.ts b/models/webhook.ts index ac04b753..1cc1ec53 100644 --- a/models/webhook.ts +++ b/models/webhook.ts @@ -16,6 +16,9 @@ // May contain unused imports in some cases // @ts-ignore import { WebhookEvent } from './webhook-event'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookMtls } from './webhook-mtls'; /** * @@ -65,6 +68,12 @@ export interface Webhook { * @memberof Webhook */ 'description'?: string; + /** + * + * @type {WebhookMtls} + * @memberof Webhook + */ + 'mtls'?: WebhookMtls | null; } export const WebhookStatusEnum = { diff --git a/package-lock.json b/package-lock.json index 5e26e5cf..f4ded378 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@fireblocks/ts-sdk", - "version": "20.0.0", + "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@fireblocks/ts-sdk", - "version": "20.0.0", + "version": "0.0.0", "license": "MIT License", "dependencies": { "axios": "^1.15.2", @@ -1074,6 +1074,18 @@ "dev": true, "license": "MIT" }, + "node_modules/agent-base": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", + "license": "MIT", + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, "node_modules/ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -1147,13 +1159,14 @@ "license": "MIT" }, "node_modules/axios": { - "version": "1.16.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.16.0.tgz", - "integrity": "sha512-6hp5CwvTPlN2A31g5dxnwAX0orzM7pmCRDLnZSX772mv8WDqICwFjowHuPs04Mc8deIld1+ejhtaMn5vp6b+1w==", + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.16.1.tgz", + "integrity": "sha512-caYkukvroVPO8KrzuJEb50Hm07KwfBZPEC3VeFHTsqWHvKTsy54hjJz9BS/cdaypROE2rH6xvm9mHX4fgWkr3A==", "license": "MIT", "dependencies": { "follow-redirects": "^1.16.0", "form-data": "^4.0.5", + "https-proxy-agent": "^5.0.1", "proxy-from-env": "^2.1.0" } }, @@ -1281,9 +1294,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.29", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.29.tgz", - "integrity": "sha512-Asa2krT+XTPZINCS+2QcyS8WTkObE77RwkydwF7h6DmnKqbvlalz93m/dnphUyCa6SWSP51VgtEUf2FN+gelFQ==", + "version": "2.10.31", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.31.tgz", + "integrity": "sha512-MujYO3eP72uvmSE0i4wltsodRfIpZATP3jvzRNRGGxgzId7aVocVJJV3nf01qnzzKFGxQVC9bpWxl5cjxTr/7Q==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1421,9 +1434,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001792", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001792.tgz", - "integrity": "sha512-hVLMUZFgR4JJ6ACt1uEESvQN1/dBVqPAKY0hgrV70eN3391K6juAfTjKZLKvOMsx8PxA7gsY1/tLMMTcfFLLpw==", + "version": "1.0.30001793", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001793.tgz", + "integrity": "sha512-iwSsYWaCOoh26cV8NwNRViHlrfUvYsHDfRVcbtmw0Kg6PJIZZXwMkj1442FYLBGkeUf1juAsU3DTfxW579mrPA==", "dev": true, "funding": [ { @@ -1611,7 +1624,6 @@ "version": "4.4.3", "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", - "dev": true, "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -1703,9 +1715,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.354", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.354.tgz", - "integrity": "sha512-JaBHwWcfIdmSAfWM5l3uwjGd431j8YEMikZ+K/2nXVuBqJKyZ0f+2h4n4JY5AyNiZmnY9qQr2RU3v9DxDmHMNg==", + "version": "1.5.360", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.360.tgz", + "integrity": "sha512-GkcBt6YYAw9SxFWn+xVar4cLVGlXVuswwtRLBozi2zp0GjXs4ZnOrqV4zbXzg35n7w81hCkyJNYicgXlVHAmBA==", "dev": true, "license": "ISC" }, @@ -2156,6 +2168,19 @@ "dev": true, "license": "MIT" }, + "node_modules/https-proxy-agent": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", + "license": "MIT", + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/human-signals": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", @@ -2316,9 +2341,9 @@ } }, "node_modules/istanbul-lib-instrument/node_modules/semver": { - "version": "7.8.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", - "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.1.tgz", + "integrity": "sha512-rkVq3IXh+4FDGch+KwzX3aV9W3kO54GyEgpvBzSyctDA6Xtd7RJQV1xmXbeQp5v7+VzLOfVqiutSE6GICgPFvg==", "dev": true, "license": "ISC", "bin": { @@ -2871,9 +2896,9 @@ } }, "node_modules/jest-snapshot/node_modules/semver": { - "version": "7.8.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", - "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.1.tgz", + "integrity": "sha512-rkVq3IXh+4FDGch+KwzX3aV9W3kO54GyEgpvBzSyctDA6Xtd7RJQV1xmXbeQp5v7+VzLOfVqiutSE6GICgPFvg==", "dev": true, "license": "ISC", "bin": { @@ -3061,9 +3086,9 @@ } }, "node_modules/jsonwebtoken/node_modules/semver": { - "version": "7.8.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", - "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.1.tgz", + "integrity": "sha512-rkVq3IXh+4FDGch+KwzX3aV9W3kO54GyEgpvBzSyctDA6Xtd7RJQV1xmXbeQp5v7+VzLOfVqiutSE6GICgPFvg==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -3209,9 +3234,9 @@ } }, "node_modules/make-dir/node_modules/semver": { - "version": "7.8.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", - "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.1.tgz", + "integrity": "sha512-rkVq3IXh+4FDGch+KwzX3aV9W3kO54GyEgpvBzSyctDA6Xtd7RJQV1xmXbeQp5v7+VzLOfVqiutSE6GICgPFvg==", "dev": true, "license": "ISC", "bin": { @@ -3346,11 +3371,14 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.44", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.44.tgz", - "integrity": "sha512-5WUyunoPMsvvEhS8AxHtRzP+oA8UCkJ7YRxatWKjngndhDGLiqEVAQKWjFAiAiuL8zMRGzGSJxFnLetoa43qGQ==", + "version": "2.0.45", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.45.tgz", + "integrity": "sha512-iIbHXV9eBB2nB0wa7oTsrrXq+qQt+9SIlx9AX3T96YgobtEQfis5n6TJ6vV+3QP8DwdriEAcGhARaFCu37peBg==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/normalize-path": { "version": "3.0.0", @@ -4000,9 +4028,9 @@ } }, "node_modules/ts-jest/node_modules/semver": { - "version": "7.8.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", - "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.1.tgz", + "integrity": "sha512-rkVq3IXh+4FDGch+KwzX3aV9W3kO54GyEgpvBzSyctDA6Xtd7RJQV1xmXbeQp5v7+VzLOfVqiutSE6GICgPFvg==", "dev": true, "license": "ISC", "bin": { diff --git a/package.json b/package.json index 4752aada..584251d5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fireblocks/ts-sdk", - "version": "20.0.0", + "version": "0.0.0", "description": "OpenAPI client for @fireblocks/ts-sdk", "author": "Fireblocks SDK Generator", "repository": {