From 472618bf401c9b966e9bf604da425fc87384703a Mon Sep 17 00:00:00 2001 From: fireblocks_dx_team Date: Wed, 4 Nov 2026 09:28:02 +0000 Subject: [PATCH] Generated SDK #3026276285 --- .openapi-generator/FILES | 30 +- CHANGELOG.md | 258 ------- README.md | 63 +- api.ts | 6 +- api/console-user-api.ts | 8 +- ...cosigners-beta-api.ts => cosigners-api.ts} | 720 +++++++++--------- api/{key-link-beta-api.ts => key-link-api.ts} | 466 +++++++----- api/{keys-beta-api.ts => keys-api.ts} | 66 +- api/trlink-api.ts | 105 ++- api/vaults-api.ts | 8 +- client/client.ts | 24 +- docs/apis/ConsoleUserApi.md | 2 +- .../{CosignersBetaApi.md => CosignersApi.md} | 222 +++--- .../apis/{KeyLinkBetaApi.md => KeyLinkApi.md} | 145 +++- docs/apis/{KeysBetaApi.md => KeysApi.md} | 14 +- docs/apis/TRLinkApi.md | 72 +- docs/apis/VaultsApi.md | 2 +- docs/models/AddCosignerRequest.md | 2 +- docs/models/AddCosignerResponse.md | 2 +- ...sponse.md => ApiUsersPaginatedResponse.md} | 4 +- docs/models/{ApiKey.md => CosignerApiUser.md} | 6 +- docs/models/CreateMultipleAccountsRequest.md | 11 + docs/models/CreateTempoTransferRequest.md | 1 - ...ApiKeyRequest.md => PairApiUserRequest.md} | 2 +- ...iKeyResponse.md => PairApiUserResponse.md} | 4 +- .../TRLinkManualDecisionDestinationDetail.md | 2 +- docs/models/TRLinkManualDecisionResponse.md | 1 + .../TRLinkManualDecisionResponseStatusEnum.md | 14 + docs/models/TRLinkManualDecisionSource.md | 4 +- docs/models/TempoTransferDestination.md | 1 + .../TypedMessageTransactionStatusEnum.md | 4 + docs/models/ValidationKeyDto.md | 2 + models/add-cosigner-request.ts | 4 +- models/add-cosigner-response.ts | 4 +- ...nse.ts => api-users-paginated-response.ts} | 14 +- models/{api-key.ts => cosigner-api-user.ts} | 14 +- models/create-multiple-accounts-request.ts | 20 + models/create-tempo-transfer-request.ts | 6 - models/index.ts | 9 +- ...ey-request.ts => pair-api-user-request.ts} | 6 +- ...-response.ts => pair-api-user-response.ts} | 10 +- models/tempo-transfer-destination.ts | 6 + models/trlink-manual-decision-action.ts | 2 +- ...link-manual-decision-destination-detail.ts | 2 +- models/trlink-manual-decision-request.ts | 2 +- ...nk-manual-decision-response-status-enum.ts | 32 + models/trlink-manual-decision-response.ts | 11 +- models/trlink-manual-decision-source.ts | 6 +- .../typed-message-transaction-status-enum.ts | 2 + models/validation-key-dto.ts | 12 + package-lock.json | 52 +- package.json | 2 +- tests/client.spec.ts | 42 +- tests/lifecycleWarning.spec.ts | 61 +- utils/lifecycleWarning.ts | 10 +- 55 files changed, 1409 insertions(+), 1191 deletions(-) delete mode 100644 CHANGELOG.md rename api/{cosigners-beta-api.ts => cosigners-api.ts} (60%) rename api/{key-link-beta-api.ts => key-link-api.ts} (75%) rename api/{keys-beta-api.ts => keys-api.ts} (77%) rename docs/apis/{CosignersBetaApi.md => CosignersApi.md} (73%) rename docs/apis/{KeyLinkBetaApi.md => KeyLinkApi.md} (81%) rename docs/apis/{KeysBetaApi.md => KeysApi.md} (84%) rename docs/models/{ApiKeysPaginatedResponse.md => ApiUsersPaginatedResponse.md} (72%) rename docs/models/{ApiKey.md => CosignerApiUser.md} (66%) rename docs/models/{PairApiKeyRequest.md => PairApiUserRequest.md} (95%) rename docs/models/{PairApiKeyResponse.md => PairApiUserResponse.md} (79%) create mode 100644 docs/models/TRLinkManualDecisionResponseStatusEnum.md rename models/{api-keys-paginated-response.ts => api-users-paginated-response.ts} (74%) rename models/{api-key.ts => cosigner-api-user.ts} (80%) rename models/{pair-api-key-request.ts => pair-api-user-request.ts} (89%) rename models/{pair-api-key-response.ts => pair-api-user-response.ts} (83%) create mode 100644 models/trlink-manual-decision-response-status-enum.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 8262d813..5707ddbd 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -97,9 +97,8 @@ AmountOverTimeConfig.md AmountRange.md AmountRangeMinMax.md AmountRangeMinMax2.md -ApiKey.md -ApiKeysPaginatedResponse.md ApiUserApi.md +ApiUsersPaginatedResponse.md ApprovalApiKey.md ApprovalApiPublicKey.md ApprovalRequest.md @@ -317,7 +316,8 @@ ConversionValidationFailure.md ConvertAssetsRequest.md ConvertAssetsResponse.md Cosigner.md -CosignersBetaApi.md +CosignerApiUser.md +CosignersApi.md CosignersPaginatedResponse.md CounterpartyGroup.md CounterpartyGroupsPaginatedResponse.md @@ -627,8 +627,8 @@ InvalidParamaterValueError.md IssueApiUserPairingTokenResponse.md IssueTokenMultichainResponse.md JobCreated.md -KeyLinkBetaApi.md -KeysBetaApi.md +KeyLinkApi.md +KeysApi.md LICENSE LayerZeroAdapterCreateParams.md LbtPaymentInfo.md @@ -774,8 +774,8 @@ PaginatedAssetWalletResponse.md PaginatedAssetWalletResponsePaging.md PaginatedAssetsResponse.md Paging.md -PairApiKeyRequest.md -PairApiKeyResponse.md +PairApiUserRequest.md +PairApiUserResponse.md Parameter.md ParameterWithValue.md ParameterWithValueList.md @@ -1131,6 +1131,7 @@ TRLinkManualDecisionAction.md TRLinkManualDecisionDestinationDetail.md TRLinkManualDecisionRequest.md TRLinkManualDecisionResponse.md +TRLinkManualDecisionResponseStatusEnum.md TRLinkManualDecisionSource.md TRLinkMissingTrmAction.md TRLinkMissingTrmAction2.md @@ -1462,7 +1463,7 @@ api/contacts-api.ts api/contract-interactions-api.ts api/contract-templates-api.ts api/contracts-api.ts -api/cosigners-beta-api.ts +api/cosigners-api.ts api/deployed-contracts-api.ts api/earn-api.ts api/embedded-wallets-api.ts @@ -1472,8 +1473,8 @@ api/fiat-accounts-api.ts api/gas-stations-api.ts api/genie-beta-api.ts api/internal-wallets-api.ts -api/key-link-beta-api.ts -api/keys-beta-api.ts +api/key-link-api.ts +api/keys-api.ts api/network-connections-api.ts api/nfts-api.ts api/off-exchanges-api.ts @@ -1607,8 +1608,7 @@ models/amount-over-time-config.ts models/amount-range-min-max.ts models/amount-range-min-max2.ts models/amount-range.ts -models/api-key.ts -models/api-keys-paginated-response.ts +models/api-users-paginated-response.ts models/apiuser.ts models/apiusers.ts models/approval-api-key.ts @@ -1813,6 +1813,7 @@ models/conversion-operation-type.ts models/conversion-validation-failure.ts models/convert-assets-request.ts models/convert-assets-response.ts +models/cosigner-api-user.ts models/cosigner.ts models/cosigners-paginated-response.ts models/counterparty-group.ts @@ -2254,8 +2255,8 @@ models/paginated-asset-wallet-response-paging.ts models/paginated-asset-wallet-response.ts models/paginated-assets-response.ts models/paging.ts -models/pair-api-key-request.ts -models/pair-api-key-response.ts +models/pair-api-user-request.ts +models/pair-api-user-response.ts models/parameter-with-value-list.ts models/parameter-with-value.ts models/parameter.ts @@ -2727,6 +2728,7 @@ models/trlink-jwk-public-key.ts models/trlink-manual-decision-action.ts models/trlink-manual-decision-destination-detail.ts models/trlink-manual-decision-request.ts +models/trlink-manual-decision-response-status-enum.ts models/trlink-manual-decision-response.ts models/trlink-manual-decision-source.ts models/trlink-missing-trm-action-enum.ts diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 908ab0f5..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). - -## [v35.2.0](https://github.com/fireblocks/ts-sdk/compare/v19.0.0...v35.2.0) - 2026-10-28 - -### Merged - -- Generated SDK #2999499117 [`#215`](https://github.com/fireblocks/ts-sdk/pull/215) - -## [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 360cedd3..7e05543f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ npm install @fireblocks/ts-sdk ## Versioning -This SDK follows [semantic versioning](https://semver.org), with one exception: operations in the `beta` lifecycle state. Beta operations are not generally available and may not be accessible to all customers. They can change or be removed without notice. +This SDK follows [semantic versioning](https://semver.org), with one exception: operations in the `ea` (Early Availability, EA) lifecycle state. EA operations are not generally available and may not be accessible to all customers. They can change or break before they reach GA. ## Usage ### Initializing the SDK @@ -132,7 +132,7 @@ header, so it is always current - it does not depend on the SDK version you have installed. ``` -Operation 'createTransaction' is in 'beta' lifecycle state and is not generally available. It may change or be removed without notice. +Operation 'createTransaction' is in EA (Early Availability) and is not generally available. It may change or break before it reaches GA. ``` Deprecated operations report their sunset date, and the replacement and migration @@ -277,16 +277,16 @@ Class | Method | HTTP request | Description *ContractsApi* | [**getContract**](docs/apis/ContractsApi.md#getContract) | **GET** /contracts/{contractId} | Find a Specific Whitelisted Contract *ContractsApi* | [**getContractAsset**](docs/apis/ContractsApi.md#getContractAsset) | **GET** /contracts/{contractId}/{assetId} | Find a whitelisted contract\'s asset *ContractsApi* | [**getContracts**](docs/apis/ContractsApi.md#getContracts) | **GET** /contracts | List Whitelisted Contracts -*CosignersBetaApi* | [**addCosigner**](docs/apis/CosignersBetaApi.md#addCosigner) | **POST** /cosigners | Add cosigner -*CosignersBetaApi* | [**getApiKey**](docs/apis/CosignersBetaApi.md#getApiKey) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key -*CosignersBetaApi* | [**getApiKeys**](docs/apis/CosignersBetaApi.md#getApiKeys) | **GET** /cosigners/{cosignerId}/api_keys | Get all API keys -*CosignersBetaApi* | [**getCosigner**](docs/apis/CosignersBetaApi.md#getCosigner) | **GET** /cosigners/{cosignerId} | Get cosigner -*CosignersBetaApi* | [**getCosigners**](docs/apis/CosignersBetaApi.md#getCosigners) | **GET** /cosigners | Get all cosigners -*CosignersBetaApi* | [**getRequestStatus**](docs/apis/CosignersBetaApi.md#getRequestStatus) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} | Get request status -*CosignersBetaApi* | [**pairApiKey**](docs/apis/CosignersBetaApi.md#pairApiKey) | **PUT** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Pair API key -*CosignersBetaApi* | [**renameCosigner**](docs/apis/CosignersBetaApi.md#renameCosigner) | **PATCH** /cosigners/{cosignerId} | Rename cosigner -*CosignersBetaApi* | [**unpairApiKey**](docs/apis/CosignersBetaApi.md#unpairApiKey) | **DELETE** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Unpair API key -*CosignersBetaApi* | [**updateCallbackHandler**](docs/apis/CosignersBetaApi.md#updateCallbackHandler) | **PATCH** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Update API key callback handler +*CosignersApi* | [**addCosigner**](docs/apis/CosignersApi.md#addCosigner) | **POST** /cosigners | Add cosigner +*CosignersApi* | [**getCosigner**](docs/apis/CosignersApi.md#getCosigner) | **GET** /cosigners/{cosignerId} | Get cosigner +*CosignersApi* | [**getCosignerApiUser**](docs/apis/CosignersApi.md#getCosignerApiUser) | **GET** /cosigners/{cosignerId}/api_users/{apiUserId} | Get API user +*CosignersApi* | [**getCosignerApiUserRequestStatus**](docs/apis/CosignersApi.md#getCosignerApiUserRequestStatus) | **GET** /cosigners/{cosignerId}/api_users/{apiUserId}/{requestId} | Get API user request status +*CosignersApi* | [**getCosignerApiUsers**](docs/apis/CosignersApi.md#getCosignerApiUsers) | **GET** /cosigners/{cosignerId}/api_users | Get all API users +*CosignersApi* | [**getCosigners**](docs/apis/CosignersApi.md#getCosigners) | **GET** /cosigners | Get all cosigners +*CosignersApi* | [**pairCosignerApiUser**](docs/apis/CosignersApi.md#pairCosignerApiUser) | **PUT** /cosigners/{cosignerId}/api_users/{apiUserId} | Pair API user +*CosignersApi* | [**renameCosigner**](docs/apis/CosignersApi.md#renameCosigner) | **PATCH** /cosigners/{cosignerId} | Rename cosigner +*CosignersApi* | [**unpairCosignerApiUser**](docs/apis/CosignersApi.md#unpairCosignerApiUser) | **DELETE** /cosigners/{cosignerId}/api_users/{apiUserId} | Unpair API user +*CosignersApi* | [**updateCosignerApiUserCallbackHandler**](docs/apis/CosignersApi.md#updateCosignerApiUserCallbackHandler) | **PATCH** /cosigners/{cosignerId}/api_users/{apiUserId} | Update API user callback handler *DeployedContractsApi* | [**addContractABI**](docs/apis/DeployedContractsApi.md#addContractABI) | **POST** /tokenization/contracts/abi | Save contract ABI *DeployedContractsApi* | [**fetchContractAbi**](docs/apis/DeployedContractsApi.md#fetchContractAbi) | **POST** /tokenization/contracts/fetch_abi | Fetch the contract ABI *DeployedContractsApi* | [**getDeployedContractByAddress**](docs/apis/DeployedContractsApi.md#getDeployedContractByAddress) | **GET** /tokenization/contracts/{assetId}/{contractAddress} | Return deployed contract data @@ -355,20 +355,21 @@ Class | Method | HTTP request | Description *InternalWalletsApi* | [**getInternalWalletAssetsPaginated**](docs/apis/InternalWalletsApi.md#getInternalWalletAssetsPaginated) | **GET** /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated) *InternalWalletsApi* | [**getInternalWallets**](docs/apis/InternalWalletsApi.md#getInternalWallets) | **GET** /internal_wallets | List internal wallets *InternalWalletsApi* | [**setCustomerRefIdForInternalWallet**](docs/apis/InternalWalletsApi.md#setCustomerRefIdForInternalWallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for internal wallet -*KeyLinkBetaApi* | [**createBulkSigningKeys**](docs/apis/KeyLinkBetaApi.md#createBulkSigningKeys) | **POST** /key_link/signing_keys/bulk | Register signing keys in bulk -*KeyLinkBetaApi* | [**createSigningKey**](docs/apis/KeyLinkBetaApi.md#createSigningKey) | **POST** /key_link/signing_keys | Add a new signing key -*KeyLinkBetaApi* | [**createValidationKey**](docs/apis/KeyLinkBetaApi.md#createValidationKey) | **POST** /key_link/validation_keys | Add a new validation key -*KeyLinkBetaApi* | [**disableValidationKey**](docs/apis/KeyLinkBetaApi.md#disableValidationKey) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key -*KeyLinkBetaApi* | [**getBulkSigningKeysJob**](docs/apis/KeyLinkBetaApi.md#getBulkSigningKeysJob) | **GET** /key_link/signing_keys/bulk/jobs/{jobId} | Get a bulk registration job -*KeyLinkBetaApi* | [**getBulkSigningKeysJobs**](docs/apis/KeyLinkBetaApi.md#getBulkSigningKeysJobs) | **GET** /key_link/signing_keys/bulk/jobs | Get bulk registration jobs -*KeyLinkBetaApi* | [**getSigningKey**](docs/apis/KeyLinkBetaApi.md#getSigningKey) | **GET** /key_link/signing_keys/{keyId} | Get a signing key by `keyId` -*KeyLinkBetaApi* | [**getSigningKeysList**](docs/apis/KeyLinkBetaApi.md#getSigningKeysList) | **GET** /key_link/signing_keys | Get list of signing keys -*KeyLinkBetaApi* | [**getValidationKey**](docs/apis/KeyLinkBetaApi.md#getValidationKey) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId` -*KeyLinkBetaApi* | [**getValidationKeysList**](docs/apis/KeyLinkBetaApi.md#getValidationKeysList) | **GET** /key_link/validation_keys | Get list of registered validation keys -*KeyLinkBetaApi* | [**setAgentId**](docs/apis/KeyLinkBetaApi.md#setAgentId) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id -*KeyLinkBetaApi* | [**updateSigningKey**](docs/apis/KeyLinkBetaApi.md#updateSigningKey) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId -*KeysBetaApi* | [**getMpcKeysList**](docs/apis/KeysBetaApi.md#getMpcKeysList) | **GET** /keys/mpc/list | Get list of mpc keys -*KeysBetaApi* | [**getMpcKeysListByUser**](docs/apis/KeysBetaApi.md#getMpcKeysListByUser) | **GET** /keys/mpc/list/{userId} | Get list of mpc keys by `userId` +*KeyLinkApi* | [**createBulkSigningKeys**](docs/apis/KeyLinkApi.md#createBulkSigningKeys) | **POST** /key_link/signing_keys/bulk | Register signing keys in bulk +*KeyLinkApi* | [**createSigningKey**](docs/apis/KeyLinkApi.md#createSigningKey) | **POST** /key_link/signing_keys | Add a new signing key +*KeyLinkApi* | [**createValidationKey**](docs/apis/KeyLinkApi.md#createValidationKey) | **POST** /key_link/validation_keys | Add a new validation key +*KeyLinkApi* | [**disableValidationKey**](docs/apis/KeyLinkApi.md#disableValidationKey) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key +*KeyLinkApi* | [**getBulkSigningKeysJob**](docs/apis/KeyLinkApi.md#getBulkSigningKeysJob) | **GET** /key_link/signing_keys/bulk/jobs/{jobId} | Get a bulk registration job +*KeyLinkApi* | [**getBulkSigningKeysJobs**](docs/apis/KeyLinkApi.md#getBulkSigningKeysJobs) | **GET** /key_link/signing_keys/bulk/jobs | Get bulk registration jobs +*KeyLinkApi* | [**getSigningKey**](docs/apis/KeyLinkApi.md#getSigningKey) | **GET** /key_link/signing_keys/{keyId} | Get a signing key by `keyId` +*KeyLinkApi* | [**getSigningKeysList**](docs/apis/KeyLinkApi.md#getSigningKeysList) | **GET** /key_link/signing_keys | Get list of signing keys +*KeyLinkApi* | [**getValidationKey**](docs/apis/KeyLinkApi.md#getValidationKey) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId` +*KeyLinkApi* | [**getValidationKeysList**](docs/apis/KeyLinkApi.md#getValidationKeysList) | **GET** /key_link/validation_keys | Get list of registered validation keys +*KeyLinkApi* | [**revokeValidationKey**](docs/apis/KeyLinkApi.md#revokeValidationKey) | **POST** /key_link/validation_keys/{keyId}/revoke | Revokes a validation key +*KeyLinkApi* | [**setAgentId**](docs/apis/KeyLinkApi.md#setAgentId) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id +*KeyLinkApi* | [**updateSigningKey**](docs/apis/KeyLinkApi.md#updateSigningKey) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId +*KeysApi* | [**getMpcKeysList**](docs/apis/KeysApi.md#getMpcKeysList) | **GET** /keys/mpc/list | Get list of mpc keys +*KeysApi* | [**getMpcKeysListByUser**](docs/apis/KeysApi.md#getMpcKeysListByUser) | **GET** /keys/mpc/list/{userId} | Get list of mpc keys by `userId` *NFTsApi* | [**getNFT**](docs/apis/NFTsApi.md#getNFT) | **GET** /nfts/tokens/{id} | List token data by ID *NFTsApi* | [**getNFTs**](docs/apis/NFTsApi.md#getNFTs) | **GET** /nfts/tokens | List tokens by IDs *NFTsApi* | [**getOwnershipTokens**](docs/apis/NFTsApi.md#getOwnershipTokens) | **GET** /nfts/ownership/tokens | List all owned tokens (paginated) @@ -479,6 +480,7 @@ Class | Method | HTTP request | Description *TRLinkApi* | [**getTRLinkCustomerIntegrations**](docs/apis/TRLinkApi.md#getTRLinkCustomerIntegrations) | **GET** /screening/trlink/customers/{customerId}/integrations | Get customer integrations *TRLinkApi* | [**getTRLinkCustomers**](docs/apis/TRLinkApi.md#getTRLinkCustomers) | **GET** /screening/trlink/customers | Get all customers *TRLinkApi* | [**getTRLinkIntegrationPublicKey**](docs/apis/TRLinkApi.md#getTRLinkIntegrationPublicKey) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/public_key | Get public key for PII encryption +*TRLinkApi* | [**getTRLinkManualDecision**](docs/apis/TRLinkApi.md#getTRLinkManualDecision) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision | Get manual decision for missing TRM *TRLinkApi* | [**getTRLinkPartners**](docs/apis/TRLinkApi.md#getTRLinkPartners) | **GET** /screening/trlink/partners | List available TRSupport partners *TRLinkApi* | [**getTRLinkPolicy**](docs/apis/TRLinkApi.md#getTRLinkPolicy) | **GET** /screening/trlink/policy | Get TRLink policy *TRLinkApi* | [**getTRLinkSupportedAsset**](docs/apis/TRLinkApi.md#getTRLinkSupportedAsset) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID @@ -751,8 +753,7 @@ Class | Method | HTTP request | Description - [AmountRange](docs/models/AmountRange.md) - [AmountRangeMinMax](docs/models/AmountRangeMinMax.md) - [AmountRangeMinMax2](docs/models/AmountRangeMinMax2.md) - - [ApiKey](docs/models/ApiKey.md) - - [ApiKeysPaginatedResponse](docs/models/ApiKeysPaginatedResponse.md) + - [ApiUsersPaginatedResponse](docs/models/ApiUsersPaginatedResponse.md) - [ApprovalApiKey](docs/models/ApprovalApiKey.md) - [ApprovalApiPublicKey](docs/models/ApprovalApiPublicKey.md) - [ApprovalRequest](docs/models/ApprovalRequest.md) @@ -956,6 +957,7 @@ Class | Method | HTTP request | Description - [ConvertAssetsRequest](docs/models/ConvertAssetsRequest.md) - [ConvertAssetsResponse](docs/models/ConvertAssetsResponse.md) - [Cosigner](docs/models/Cosigner.md) + - [CosignerApiUser](docs/models/CosignerApiUser.md) - [CosignersPaginatedResponse](docs/models/CosignersPaginatedResponse.md) - [CounterpartyGroup](docs/models/CounterpartyGroup.md) - [CounterpartyGroupsPaginatedResponse](docs/models/CounterpartyGroupsPaginatedResponse.md) @@ -1395,8 +1397,8 @@ Class | Method | HTTP request | Description - [PaginatedAssetWalletResponsePaging](docs/models/PaginatedAssetWalletResponsePaging.md) - [PaginatedAssetsResponse](docs/models/PaginatedAssetsResponse.md) - [Paging](docs/models/Paging.md) - - [PairApiKeyRequest](docs/models/PairApiKeyRequest.md) - - [PairApiKeyResponse](docs/models/PairApiKeyResponse.md) + - [PairApiUserRequest](docs/models/PairApiUserRequest.md) + - [PairApiUserResponse](docs/models/PairApiUserResponse.md) - [Parameter](docs/models/Parameter.md) - [ParameterWithValue](docs/models/ParameterWithValue.md) - [ParameterWithValueList](docs/models/ParameterWithValueList.md) @@ -1741,6 +1743,7 @@ Class | Method | HTTP request | Description - [TRLinkManualDecisionDestinationDetail](docs/models/TRLinkManualDecisionDestinationDetail.md) - [TRLinkManualDecisionRequest](docs/models/TRLinkManualDecisionRequest.md) - [TRLinkManualDecisionResponse](docs/models/TRLinkManualDecisionResponse.md) + - [TRLinkManualDecisionResponseStatusEnum](docs/models/TRLinkManualDecisionResponseStatusEnum.md) - [TRLinkManualDecisionSource](docs/models/TRLinkManualDecisionSource.md) - [TRLinkMissingTrmAction](docs/models/TRLinkMissingTrmAction.md) - [TRLinkMissingTrmAction2](docs/models/TRLinkMissingTrmAction2.md) diff --git a/api.ts b/api.ts index 5649d3ad..86056288 100644 --- a/api.ts +++ b/api.ts @@ -29,7 +29,7 @@ export * from './api/contacts-api'; export * from './api/contract-interactions-api'; export * from './api/contract-templates-api'; export * from './api/contracts-api'; -export * from './api/cosigners-beta-api'; +export * from './api/cosigners-api'; export * from './api/deployed-contracts-api'; export * from './api/earn-api'; export * from './api/embedded-wallets-api'; @@ -39,8 +39,8 @@ export * from './api/fiat-accounts-api'; export * from './api/gas-stations-api'; export * from './api/genie-beta-api'; export * from './api/internal-wallets-api'; -export * from './api/key-link-beta-api'; -export * from './api/keys-beta-api'; +export * from './api/key-link-api'; +export * from './api/keys-api'; export * from './api/nfts-api'; export * from './api/network-connections-api'; export * from './api/otabeta-api'; diff --git a/api/console-user-api.ts b/api/console-user-api.ts index 86fb0baf..515c468a 100644 --- a/api/console-user-api.ts +++ b/api/console-user-api.ts @@ -86,7 +86,7 @@ export const ConsoleUserApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is in Early Availability (EA) and may change or break before it reaches GA. * @summary Request deletion of a console user * @param {string} id The ID of the console user to delete * @param {boolean} [force] Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console. @@ -186,7 +186,7 @@ export const ConsoleUserApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is in Early Availability (EA) and may change or break before it reaches GA. * @summary Request deletion of a console user * @param {string} id The ID of the console user to delete * @param {boolean} [force] Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console. @@ -232,7 +232,7 @@ export const ConsoleUserApiFactory = function (configuration?: Configuration, ba return localVarFp.createConsoleUser(requestParameters.createConsoleUser, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is in Early Availability (EA) and may change or break before it reaches GA. * @summary Request deletion of a console user * @param {ConsoleUserApiDeleteConsoleUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -315,7 +315,7 @@ export class ConsoleUserApi extends BaseAPI { } /** - * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. + * Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is in Early Availability (EA) and may change or break before it reaches GA. * @summary Request deletion of a console user * @param {ConsoleUserApiDeleteConsoleUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/api/cosigners-beta-api.ts b/api/cosigners-api.ts similarity index 60% rename from api/cosigners-beta-api.ts rename to api/cosigners-api.ts index f656485b..9a6402cd 100644 --- a/api/cosigners-beta-api.ts +++ b/api/cosigners-api.ts @@ -31,19 +31,19 @@ import { AddCosignerRequest } from '../models'; // @ts-ignore import { AddCosignerResponse } from '../models'; // @ts-ignore -import { ApiKey } from '../models'; -// @ts-ignore -import { ApiKeysPaginatedResponse } from '../models'; +import { ApiUsersPaginatedResponse } from '../models'; // @ts-ignore import { Cosigner } from '../models'; // @ts-ignore +import { CosignerApiUser } from '../models'; +// @ts-ignore import { CosignersPaginatedResponse } from '../models'; // @ts-ignore import { ErrorSchema } from '../models'; // @ts-ignore -import { PairApiKeyRequest } from '../models'; +import { PairApiUserRequest } from '../models'; // @ts-ignore -import { PairApiKeyResponse } from '../models'; +import { PairApiUserResponse } from '../models'; // @ts-ignore import { RenameCosigner } from '../models'; // @ts-ignore @@ -53,13 +53,13 @@ import { UpdateCallbackHandlerRequest } from '../models'; // @ts-ignore import { UpdateCallbackHandlerResponse } from '../models'; /** - * CosignersBetaApi - axios parameter creator + * CosignersApi - axios parameter creator * @export */ -export const CosignersBetaApiAxiosParamCreator = function (configuration?: Configuration) { +export const CosignersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. + * Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin. * @summary Add cosigner * @param {AddCosignerRequest} addCosignerRequest * @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. @@ -103,19 +103,16 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get API key + * Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get cosigner * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApiKey: async (cosignerId: string, apiKeyId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('getApiKey', 'cosignerId', cosignerId) - assertParamExistsAndNotEmpty('getApiKey', 'apiKeyId', apiKeyId) - const localVarPath = `/cosigners/{cosignerId}/api_keys/{apiKeyId}` - .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) - .replace(`{${"apiKeyId"}}`, encodeURIComponent(String(apiKeyId))); + getCosigner: async (cosignerId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getCosigner', 'cosignerId', cosignerId) + const localVarPath = `/cosigners/{cosignerId}` + .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -127,7 +124,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'getApiKey'; + (localVarRequestOptions as any).fireblocksOperationId = 'getCosigner'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -143,19 +140,19 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all API keys + * Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user * @param {string} cosignerId The unique identifier of the cosigner - * @param {GetApiKeysOrderEnum} [order] ASC / DESC ordering (default DESC) - * @param {string} [pageCursor] Cursor of the required page - * @param {number} [pageSize] Maximum number of items in the page + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApiKeys: async (cosignerId: string, order?: GetApiKeysOrderEnum, pageCursor?: string, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('getApiKeys', 'cosignerId', cosignerId) - const localVarPath = `/cosigners/{cosignerId}/api_keys` - .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))); + getCosignerApiUser: async (cosignerId: string, apiUserId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getCosignerApiUser', 'cosignerId', cosignerId) + assertParamExistsAndNotEmpty('getCosignerApiUser', 'apiUserId', apiUserId) + const localVarPath = `/cosigners/{cosignerId}/api_users/{apiUserId}` + .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) + .replace(`{${"apiUserId"}}`, encodeURIComponent(String(apiUserId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -167,22 +164,10 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'getApiKeys'; + (localVarRequestOptions as any).fireblocksOperationId = 'getCosignerApiUser'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (order !== undefined) { - localVarQueryParameter['order'] = order; - } - - if (pageCursor !== undefined) { - localVarQueryParameter['pageCursor'] = pageCursor; - } - - if (pageSize !== undefined) { - localVarQueryParameter['pageSize'] = pageSize; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -195,16 +180,22 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get cosigner + * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user request status * @param {string} cosignerId The unique identifier of the cosigner + * @param {string} apiUserId The unique identifier of the API user + * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCosigner: async (cosignerId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('getCosigner', 'cosignerId', cosignerId) - const localVarPath = `/cosigners/{cosignerId}` - .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))); + getCosignerApiUserRequestStatus: async (cosignerId: string, apiUserId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getCosignerApiUserRequestStatus', 'cosignerId', cosignerId) + assertParamExistsAndNotEmpty('getCosignerApiUserRequestStatus', 'apiUserId', apiUserId) + assertParamExistsAndNotEmpty('getCosignerApiUserRequestStatus', 'requestId', requestId) + const localVarPath = `/cosigners/{cosignerId}/api_users/{apiUserId}/{requestId}` + .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) + .replace(`{${"apiUserId"}}`, encodeURIComponent(String(apiUserId))) + .replace(`{${"requestId"}}`, encodeURIComponent(String(requestId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -216,7 +207,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'getCosigner'; + (localVarRequestOptions as any).fireblocksOperationId = 'getCosignerApiUserRequestStatus'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -232,16 +223,19 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all cosigners - * @param {GetCosignersOrderEnum} [order] ASC / DESC ordering (default DESC) + * Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all API users + * @param {string} cosignerId The unique identifier of the cosigner + * @param {GetCosignerApiUsersOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCosigners: async (order?: GetCosignersOrderEnum, pageCursor?: string, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/cosigners`; + getCosignerApiUsers: async (cosignerId: string, order?: GetCosignerApiUsersOrderEnum, pageCursor?: string, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getCosignerApiUsers', 'cosignerId', cosignerId) + const localVarPath = `/cosigners/{cosignerId}/api_users` + .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -253,7 +247,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'getCosigners'; + (localVarRequestOptions as any).fireblocksOperationId = 'getCosignerApiUsers'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -281,22 +275,16 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get request status - * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key - * @param {string} requestId + * Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all cosigners + * @param {GetCosignersOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {string} [pageCursor] Cursor of the required page + * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRequestStatus: async (cosignerId: string, apiKeyId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('getRequestStatus', 'cosignerId', cosignerId) - assertParamExistsAndNotEmpty('getRequestStatus', 'apiKeyId', apiKeyId) - assertParamExistsAndNotEmpty('getRequestStatus', 'requestId', requestId) - const localVarPath = `/cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId}` - .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) - .replace(`{${"apiKeyId"}}`, encodeURIComponent(String(apiKeyId))) - .replace(`{${"requestId"}}`, encodeURIComponent(String(requestId))); + getCosigners: async (order?: GetCosignersOrderEnum, pageCursor?: string, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/cosigners`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -308,10 +296,22 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'getRequestStatus'; + (localVarRequestOptions as any).fireblocksOperationId = 'getCosigners'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -324,22 +324,22 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Pair API key - * @param {PairApiKeyRequest} pairApiKeyRequest + * Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Pair API user + * @param {PairApiUserRequest} pairApiUserRequest * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @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} */ - pairApiKey: async (pairApiKeyRequest: PairApiKeyRequest, cosignerId: string, apiKeyId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('pairApiKey', 'pairApiKeyRequest', pairApiKeyRequest) - assertParamExistsAndNotEmpty('pairApiKey', 'cosignerId', cosignerId) - assertParamExistsAndNotEmpty('pairApiKey', 'apiKeyId', apiKeyId) - const localVarPath = `/cosigners/{cosignerId}/api_keys/{apiKeyId}` + pairCosignerApiUser: async (pairApiUserRequest: PairApiUserRequest, cosignerId: string, apiUserId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('pairCosignerApiUser', 'pairApiUserRequest', pairApiUserRequest) + assertParamExistsAndNotEmpty('pairCosignerApiUser', 'cosignerId', cosignerId) + assertParamExistsAndNotEmpty('pairCosignerApiUser', 'apiUserId', apiUserId) + const localVarPath = `/cosigners/{cosignerId}/api_users/{apiUserId}` .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) - .replace(`{${"apiKeyId"}}`, encodeURIComponent(String(apiKeyId))); + .replace(`{${"apiUserId"}}`, encodeURIComponent(String(apiUserId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -351,7 +351,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'pairApiKey'; + (localVarRequestOptions as any).fireblocksOperationId = 'pairCosignerApiUser'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -366,7 +366,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(pairApiKeyRequest, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(pairApiUserRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -374,7 +374,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. + * Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. * @summary Rename cosigner * @param {RenameCosigner} renameCosigner * @param {string} cosignerId The unique identifier of the cosigner @@ -416,19 +416,19 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Unpair API key + * Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Unpair API user * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unpairApiKey: async (cosignerId: string, apiKeyId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExistsAndNotEmpty('unpairApiKey', 'cosignerId', cosignerId) - assertParamExistsAndNotEmpty('unpairApiKey', 'apiKeyId', apiKeyId) - const localVarPath = `/cosigners/{cosignerId}/api_keys/{apiKeyId}` + unpairCosignerApiUser: async (cosignerId: string, apiUserId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('unpairCosignerApiUser', 'cosignerId', cosignerId) + assertParamExistsAndNotEmpty('unpairCosignerApiUser', 'apiUserId', apiUserId) + const localVarPath = `/cosigners/{cosignerId}/api_users/{apiUserId}` .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) - .replace(`{${"apiKeyId"}}`, encodeURIComponent(String(apiKeyId))); + .replace(`{${"apiUserId"}}`, encodeURIComponent(String(apiUserId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -440,7 +440,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'unpairApiKey'; + (localVarRequestOptions as any).fireblocksOperationId = 'unpairCosignerApiUser'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -456,21 +456,21 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. - * @summary Update API key callback handler + * Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin. + * @summary Update API user callback handler * @param {UpdateCallbackHandlerRequest} updateCallbackHandlerRequest * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateCallbackHandler: async (updateCallbackHandlerRequest: UpdateCallbackHandlerRequest, cosignerId: string, apiKeyId: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('updateCallbackHandler', 'updateCallbackHandlerRequest', updateCallbackHandlerRequest) - assertParamExistsAndNotEmpty('updateCallbackHandler', 'cosignerId', cosignerId) - assertParamExistsAndNotEmpty('updateCallbackHandler', 'apiKeyId', apiKeyId) - const localVarPath = `/cosigners/{cosignerId}/api_keys/{apiKeyId}` + updateCosignerApiUserCallbackHandler: async (updateCallbackHandlerRequest: UpdateCallbackHandlerRequest, cosignerId: string, apiUserId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExists('updateCosignerApiUserCallbackHandler', 'updateCallbackHandlerRequest', updateCallbackHandlerRequest) + assertParamExistsAndNotEmpty('updateCosignerApiUserCallbackHandler', 'cosignerId', cosignerId) + assertParamExistsAndNotEmpty('updateCosignerApiUserCallbackHandler', 'apiUserId', apiUserId) + const localVarPath = `/cosigners/{cosignerId}/api_users/{apiUserId}` .replace(`{${"cosignerId"}}`, encodeURIComponent(String(cosignerId))) - .replace(`{${"apiKeyId"}}`, encodeURIComponent(String(apiKeyId))); + .replace(`{${"apiUserId"}}`, encodeURIComponent(String(apiUserId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -482,7 +482,7 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. - (localVarRequestOptions as any).fireblocksOperationId = 'updateCallbackHandler'; + (localVarRequestOptions as any).fireblocksOperationId = 'updateCosignerApiUserCallbackHandler'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -504,14 +504,14 @@ export const CosignersBetaApiAxiosParamCreator = function (configuration?: Confi }; /** - * CosignersBetaApi - functional programming interface + * CosignersApi - functional programming interface * @export */ -export const CosignersBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CosignersBetaApiAxiosParamCreator(configuration) +export const CosignersApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CosignersApiAxiosParamCreator(configuration) return { /** - * Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. + * Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin. * @summary Add cosigner * @param {AddCosignerRequest} addCosignerRequest * @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. @@ -521,100 +521,100 @@ export const CosignersBetaApiFp = function(configuration?: Configuration) { async addCosigner(addCosignerRequest: AddCosignerRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.addCosigner(addCosignerRequest, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.addCosigner']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.addCosigner']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get API key + * Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get cosigner * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getApiKey(cosignerId: string, apiKeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApiKey(cosignerId, apiKeyId, options); + async getCosigner(cosignerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCosigner(cosignerId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.getApiKey']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.getCosigner']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all API keys + * Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user * @param {string} cosignerId The unique identifier of the cosigner - * @param {GetApiKeysOrderEnum} [order] ASC / DESC ordering (default DESC) - * @param {string} [pageCursor] Cursor of the required page - * @param {number} [pageSize] Maximum number of items in the page + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getApiKeys(cosignerId: string, order?: GetApiKeysOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApiKeys(cosignerId, order, pageCursor, pageSize, options); + async getCosignerApiUser(cosignerId: string, apiUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCosignerApiUser(cosignerId, apiUserId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.getApiKeys']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.getCosignerApiUser']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get cosigner + * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user request status * @param {string} cosignerId The unique identifier of the cosigner + * @param {string} apiUserId The unique identifier of the API user + * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCosigner(cosignerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCosigner(cosignerId, options); + async getCosignerApiUserRequestStatus(cosignerId: string, apiUserId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCosignerApiUserRequestStatus(cosignerId, apiUserId, requestId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.getCosigner']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.getCosignerApiUserRequestStatus']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all cosigners - * @param {GetCosignersOrderEnum} [order] ASC / DESC ordering (default DESC) + * Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all API users + * @param {string} cosignerId The unique identifier of the cosigner + * @param {GetCosignerApiUsersOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCosigners(order?: GetCosignersOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCosigners(order, pageCursor, pageSize, options); + async getCosignerApiUsers(cosignerId: string, order?: GetCosignerApiUsersOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCosignerApiUsers(cosignerId, order, pageCursor, pageSize, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.getCosigners']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.getCosignerApiUsers']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get request status - * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key - * @param {string} requestId + * Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all cosigners + * @param {GetCosignersOrderEnum} [order] ASC / DESC ordering (default DESC) + * @param {string} [pageCursor] Cursor of the required page + * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getRequestStatus(cosignerId: string, apiKeyId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRequestStatus(cosignerId, apiKeyId, requestId, options); + async getCosigners(order?: GetCosignersOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCosigners(order, pageCursor, pageSize, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.getRequestStatus']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.getCosigners']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Pair API key - * @param {PairApiKeyRequest} pairApiKeyRequest + * Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Pair API user + * @param {PairApiUserRequest} pairApiUserRequest * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @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 pairApiKey(pairApiKeyRequest: PairApiKeyRequest, cosignerId: string, apiKeyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pairApiKey(pairApiKeyRequest, cosignerId, apiKeyId, idempotencyKey, options); + async pairCosignerApiUser(pairApiUserRequest: PairApiUserRequest, cosignerId: string, apiUserId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pairCosignerApiUser(pairApiUserRequest, cosignerId, apiUserId, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.pairApiKey']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.pairCosignerApiUser']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. + * Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. * @summary Rename cosigner * @param {RenameCosigner} renameCosigner * @param {string} cosignerId The unique identifier of the cosigner @@ -624,539 +624,539 @@ export const CosignersBetaApiFp = function(configuration?: Configuration) { async renameCosigner(renameCosigner: RenameCosigner, cosignerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.renameCosigner(renameCosigner, cosignerId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.renameCosigner']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.renameCosigner']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Unpair API key + * Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Unpair API user * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async unpairApiKey(cosignerId: string, apiKeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unpairApiKey(cosignerId, apiKeyId, options); + async unpairCosignerApiUser(cosignerId: string, apiUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unpairCosignerApiUser(cosignerId, apiUserId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.unpairApiKey']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.unpairCosignerApiUser']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. - * @summary Update API key callback handler + * Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin. + * @summary Update API user callback handler * @param {UpdateCallbackHandlerRequest} updateCallbackHandlerRequest * @param {string} cosignerId The unique identifier of the cosigner - * @param {string} apiKeyId The unique identifier of the API key + * @param {string} apiUserId The unique identifier of the API user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateCallbackHandler(updateCallbackHandlerRequest: UpdateCallbackHandlerRequest, cosignerId: string, apiKeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCallbackHandler(updateCallbackHandlerRequest, cosignerId, apiKeyId, options); + async updateCosignerApiUserCallbackHandler(updateCallbackHandlerRequest: UpdateCallbackHandlerRequest, cosignerId: string, apiUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateCosignerApiUserCallbackHandler(updateCallbackHandlerRequest, cosignerId, apiUserId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CosignersBetaApi.updateCallbackHandler']?.[index]?.url; + const operationBasePath = operationServerMap['CosignersApi.updateCosignerApiUserCallbackHandler']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, } }; /** - * CosignersBetaApi - factory interface + * CosignersApi - factory interface * @export */ -export const CosignersBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CosignersBetaApiFp(configuration) +export const CosignersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CosignersApiFp(configuration) return { /** - * Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. + * Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin. * @summary Add cosigner - * @param {CosignersBetaApiAddCosignerRequest} requestParameters Request parameters. + * @param {CosignersApiAddCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addCosigner(requestParameters: CosignersBetaApiAddCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { + addCosigner(requestParameters: CosignersApiAddCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.addCosigner(requestParameters.addCosignerRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get API key - * @param {CosignersBetaApiGetApiKeyRequest} requestParameters Request parameters. + * Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get cosigner + * @param {CosignersApiGetCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApiKey(requestParameters: CosignersBetaApiGetApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApiKey(requestParameters.cosignerId, requestParameters.apiKeyId, options).then((request) => request(axios, basePath)); + getCosigner(requestParameters: CosignersApiGetCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCosigner(requestParameters.cosignerId, options).then((request) => request(axios, basePath)); }, /** - * Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all API keys - * @param {CosignersBetaApiGetApiKeysRequest} requestParameters Request parameters. + * Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user + * @param {CosignersApiGetCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApiKeys(requestParameters: CosignersBetaApiGetApiKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApiKeys(requestParameters.cosignerId, requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); + getCosignerApiUser(requestParameters: CosignersApiGetCosignerApiUserRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCosignerApiUser(requestParameters.cosignerId, requestParameters.apiUserId, options).then((request) => request(axios, basePath)); }, /** - * Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get cosigner - * @param {CosignersBetaApiGetCosignerRequest} requestParameters Request parameters. + * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user request status + * @param {CosignersApiGetCosignerApiUserRequestStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCosigner(requestParameters: CosignersBetaApiGetCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCosigner(requestParameters.cosignerId, options).then((request) => request(axios, basePath)); + getCosignerApiUserRequestStatus(requestParameters: CosignersApiGetCosignerApiUserRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCosignerApiUserRequestStatus(requestParameters.cosignerId, requestParameters.apiUserId, requestParameters.requestId, options).then((request) => request(axios, basePath)); }, /** - * Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all cosigners - * @param {CosignersBetaApiGetCosignersRequest} requestParameters Request parameters. + * Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all API users + * @param {CosignersApiGetCosignerApiUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCosigners(requestParameters: CosignersBetaApiGetCosignersRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCosigners(requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); + getCosignerApiUsers(requestParameters: CosignersApiGetCosignerApiUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCosignerApiUsers(requestParameters.cosignerId, requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); }, /** - * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get request status - * @param {CosignersBetaApiGetRequestStatusRequest} requestParameters Request parameters. + * Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all cosigners + * @param {CosignersApiGetCosignersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRequestStatus(requestParameters: CosignersBetaApiGetRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRequestStatus(requestParameters.cosignerId, requestParameters.apiKeyId, requestParameters.requestId, options).then((request) => request(axios, basePath)); + getCosigners(requestParameters: CosignersApiGetCosignersRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCosigners(requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); }, /** - * Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Pair API key - * @param {CosignersBetaApiPairApiKeyRequest} requestParameters Request parameters. + * Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Pair API user + * @param {CosignersApiPairCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - pairApiKey(requestParameters: CosignersBetaApiPairApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pairApiKey(requestParameters.pairApiKeyRequest, requestParameters.cosignerId, requestParameters.apiKeyId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + pairCosignerApiUser(requestParameters: CosignersApiPairCosignerApiUserRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pairCosignerApiUser(requestParameters.pairApiUserRequest, requestParameters.cosignerId, requestParameters.apiUserId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. + * Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. * @summary Rename cosigner - * @param {CosignersBetaApiRenameCosignerRequest} requestParameters Request parameters. + * @param {CosignersApiRenameCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - renameCosigner(requestParameters: CosignersBetaApiRenameCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { + renameCosigner(requestParameters: CosignersApiRenameCosignerRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.renameCosigner(requestParameters.renameCosigner, requestParameters.cosignerId, options).then((request) => request(axios, basePath)); }, /** - * Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Unpair API key - * @param {CosignersBetaApiUnpairApiKeyRequest} requestParameters Request parameters. + * Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Unpair API user + * @param {CosignersApiUnpairCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unpairApiKey(requestParameters: CosignersBetaApiUnpairApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unpairApiKey(requestParameters.cosignerId, requestParameters.apiKeyId, options).then((request) => request(axios, basePath)); + unpairCosignerApiUser(requestParameters: CosignersApiUnpairCosignerApiUserRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unpairCosignerApiUser(requestParameters.cosignerId, requestParameters.apiUserId, options).then((request) => request(axios, basePath)); }, /** - * Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. - * @summary Update API key callback handler - * @param {CosignersBetaApiUpdateCallbackHandlerRequest} requestParameters Request parameters. + * Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin. + * @summary Update API user callback handler + * @param {CosignersApiUpdateCosignerApiUserCallbackHandlerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateCallbackHandler(requestParameters: CosignersBetaApiUpdateCallbackHandlerRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCallbackHandler(requestParameters.updateCallbackHandlerRequest, requestParameters.cosignerId, requestParameters.apiKeyId, options).then((request) => request(axios, basePath)); + updateCosignerApiUserCallbackHandler(requestParameters: CosignersApiUpdateCosignerApiUserCallbackHandlerRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateCosignerApiUserCallbackHandler(requestParameters.updateCallbackHandlerRequest, requestParameters.cosignerId, requestParameters.apiUserId, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for addCosigner operation in CosignersBetaApi. + * Request parameters for addCosigner operation in CosignersApi. * @export - * @interface CosignersBetaApiAddCosignerRequest + * @interface CosignersApiAddCosignerRequest */ -export interface CosignersBetaApiAddCosignerRequest { +export interface CosignersApiAddCosignerRequest { /** * * @type {AddCosignerRequest} - * @memberof CosignersBetaApiAddCosigner + * @memberof CosignersApiAddCosigner */ readonly addCosignerRequest: AddCosignerRequest /** * 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 CosignersBetaApiAddCosigner + * @memberof CosignersApiAddCosigner */ readonly idempotencyKey?: string } /** - * Request parameters for getApiKey operation in CosignersBetaApi. + * Request parameters for getCosigner operation in CosignersApi. + * @export + * @interface CosignersApiGetCosignerRequest + */ +export interface CosignersApiGetCosignerRequest { + /** + * The unique identifier of the cosigner + * @type {string} + * @memberof CosignersApiGetCosigner + */ + readonly cosignerId: string +} + +/** + * Request parameters for getCosignerApiUser operation in CosignersApi. * @export - * @interface CosignersBetaApiGetApiKeyRequest + * @interface CosignersApiGetCosignerApiUserRequest */ -export interface CosignersBetaApiGetApiKeyRequest { +export interface CosignersApiGetCosignerApiUserRequest { /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiGetApiKey + * @memberof CosignersApiGetCosignerApiUser */ readonly cosignerId: string /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof CosignersBetaApiGetApiKey + * @memberof CosignersApiGetCosignerApiUser */ - readonly apiKeyId: string + readonly apiUserId: string } /** - * Request parameters for getApiKeys operation in CosignersBetaApi. + * Request parameters for getCosignerApiUserRequestStatus operation in CosignersApi. * @export - * @interface CosignersBetaApiGetApiKeysRequest + * @interface CosignersApiGetCosignerApiUserRequestStatusRequest */ -export interface CosignersBetaApiGetApiKeysRequest { +export interface CosignersApiGetCosignerApiUserRequestStatusRequest { /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiGetApiKeys + * @memberof CosignersApiGetCosignerApiUserRequestStatus */ readonly cosignerId: string /** - * ASC / DESC ordering (default DESC) - * @type {'ASC' | 'DESC'} - * @memberof CosignersBetaApiGetApiKeys - */ - readonly order?: GetApiKeysOrderEnum - - /** - * Cursor of the required page + * The unique identifier of the API user * @type {string} - * @memberof CosignersBetaApiGetApiKeys + * @memberof CosignersApiGetCosignerApiUserRequestStatus */ - readonly pageCursor?: string + readonly apiUserId: string /** - * Maximum number of items in the page - * @type {number} - * @memberof CosignersBetaApiGetApiKeys + * + * @type {string} + * @memberof CosignersApiGetCosignerApiUserRequestStatus */ - readonly pageSize?: number + readonly requestId: string } /** - * Request parameters for getCosigner operation in CosignersBetaApi. + * Request parameters for getCosignerApiUsers operation in CosignersApi. * @export - * @interface CosignersBetaApiGetCosignerRequest + * @interface CosignersApiGetCosignerApiUsersRequest */ -export interface CosignersBetaApiGetCosignerRequest { +export interface CosignersApiGetCosignerApiUsersRequest { /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiGetCosigner + * @memberof CosignersApiGetCosignerApiUsers */ readonly cosignerId: string -} -/** - * Request parameters for getCosigners operation in CosignersBetaApi. - * @export - * @interface CosignersBetaApiGetCosignersRequest - */ -export interface CosignersBetaApiGetCosignersRequest { /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} - * @memberof CosignersBetaApiGetCosigners + * @memberof CosignersApiGetCosignerApiUsers */ - readonly order?: GetCosignersOrderEnum + readonly order?: GetCosignerApiUsersOrderEnum /** * Cursor of the required page * @type {string} - * @memberof CosignersBetaApiGetCosigners + * @memberof CosignersApiGetCosignerApiUsers */ readonly pageCursor?: string /** * Maximum number of items in the page * @type {number} - * @memberof CosignersBetaApiGetCosigners + * @memberof CosignersApiGetCosignerApiUsers */ readonly pageSize?: number } /** - * Request parameters for getRequestStatus operation in CosignersBetaApi. + * Request parameters for getCosigners operation in CosignersApi. * @export - * @interface CosignersBetaApiGetRequestStatusRequest + * @interface CosignersApiGetCosignersRequest */ -export interface CosignersBetaApiGetRequestStatusRequest { +export interface CosignersApiGetCosignersRequest { /** - * The unique identifier of the cosigner - * @type {string} - * @memberof CosignersBetaApiGetRequestStatus + * ASC / DESC ordering (default DESC) + * @type {'ASC' | 'DESC'} + * @memberof CosignersApiGetCosigners */ - readonly cosignerId: string + readonly order?: GetCosignersOrderEnum /** - * The unique identifier of the API key + * Cursor of the required page * @type {string} - * @memberof CosignersBetaApiGetRequestStatus + * @memberof CosignersApiGetCosigners */ - readonly apiKeyId: string + readonly pageCursor?: string /** - * - * @type {string} - * @memberof CosignersBetaApiGetRequestStatus + * Maximum number of items in the page + * @type {number} + * @memberof CosignersApiGetCosigners */ - readonly requestId: string + readonly pageSize?: number } /** - * Request parameters for pairApiKey operation in CosignersBetaApi. + * Request parameters for pairCosignerApiUser operation in CosignersApi. * @export - * @interface CosignersBetaApiPairApiKeyRequest + * @interface CosignersApiPairCosignerApiUserRequest */ -export interface CosignersBetaApiPairApiKeyRequest { +export interface CosignersApiPairCosignerApiUserRequest { /** * - * @type {PairApiKeyRequest} - * @memberof CosignersBetaApiPairApiKey + * @type {PairApiUserRequest} + * @memberof CosignersApiPairCosignerApiUser */ - readonly pairApiKeyRequest: PairApiKeyRequest + readonly pairApiUserRequest: PairApiUserRequest /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiPairApiKey + * @memberof CosignersApiPairCosignerApiUser */ readonly cosignerId: string /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof CosignersBetaApiPairApiKey + * @memberof CosignersApiPairCosignerApiUser */ - readonly apiKeyId: string + readonly apiUserId: 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 CosignersBetaApiPairApiKey + * @memberof CosignersApiPairCosignerApiUser */ readonly idempotencyKey?: string } /** - * Request parameters for renameCosigner operation in CosignersBetaApi. + * Request parameters for renameCosigner operation in CosignersApi. * @export - * @interface CosignersBetaApiRenameCosignerRequest + * @interface CosignersApiRenameCosignerRequest */ -export interface CosignersBetaApiRenameCosignerRequest { +export interface CosignersApiRenameCosignerRequest { /** * * @type {RenameCosigner} - * @memberof CosignersBetaApiRenameCosigner + * @memberof CosignersApiRenameCosigner */ readonly renameCosigner: RenameCosigner /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiRenameCosigner + * @memberof CosignersApiRenameCosigner */ readonly cosignerId: string } /** - * Request parameters for unpairApiKey operation in CosignersBetaApi. + * Request parameters for unpairCosignerApiUser operation in CosignersApi. * @export - * @interface CosignersBetaApiUnpairApiKeyRequest + * @interface CosignersApiUnpairCosignerApiUserRequest */ -export interface CosignersBetaApiUnpairApiKeyRequest { +export interface CosignersApiUnpairCosignerApiUserRequest { /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiUnpairApiKey + * @memberof CosignersApiUnpairCosignerApiUser */ readonly cosignerId: string /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof CosignersBetaApiUnpairApiKey + * @memberof CosignersApiUnpairCosignerApiUser */ - readonly apiKeyId: string + readonly apiUserId: string } /** - * Request parameters for updateCallbackHandler operation in CosignersBetaApi. + * Request parameters for updateCosignerApiUserCallbackHandler operation in CosignersApi. * @export - * @interface CosignersBetaApiUpdateCallbackHandlerRequest + * @interface CosignersApiUpdateCosignerApiUserCallbackHandlerRequest */ -export interface CosignersBetaApiUpdateCallbackHandlerRequest { +export interface CosignersApiUpdateCosignerApiUserCallbackHandlerRequest { /** * * @type {UpdateCallbackHandlerRequest} - * @memberof CosignersBetaApiUpdateCallbackHandler + * @memberof CosignersApiUpdateCosignerApiUserCallbackHandler */ readonly updateCallbackHandlerRequest: UpdateCallbackHandlerRequest /** * The unique identifier of the cosigner * @type {string} - * @memberof CosignersBetaApiUpdateCallbackHandler + * @memberof CosignersApiUpdateCosignerApiUserCallbackHandler */ readonly cosignerId: string /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof CosignersBetaApiUpdateCallbackHandler + * @memberof CosignersApiUpdateCosignerApiUserCallbackHandler */ - readonly apiKeyId: string + readonly apiUserId: string } /** - * CosignersBetaApi - object-oriented interface + * CosignersApi - object-oriented interface * @export - * @class CosignersBetaApi + * @class CosignersApi * @extends {BaseAPI} */ -export class CosignersBetaApi extends BaseAPI { +export class CosignersApi extends BaseAPI { /** - * Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. + * Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin. * @summary Add cosigner - * @param {CosignersBetaApiAddCosignerRequest} requestParameters Request parameters. + * @param {CosignersApiAddCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public addCosigner(requestParameters: CosignersBetaApiAddCosignerRequest) { - return CosignersBetaApiFp(this.configuration).addCosigner(requestParameters.addCosignerRequest, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public addCosigner(requestParameters: CosignersApiAddCosignerRequest) { + return CosignersApiFp(this.configuration).addCosigner(requestParameters.addCosignerRequest, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get API key - * @param {CosignersBetaApiGetApiKeyRequest} requestParameters Request parameters. + * Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get cosigner + * @param {CosignersApiGetCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public getApiKey(requestParameters: CosignersBetaApiGetApiKeyRequest) { - return CosignersBetaApiFp(this.configuration).getApiKey(requestParameters.cosignerId, requestParameters.apiKeyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getCosigner(requestParameters: CosignersApiGetCosignerRequest) { + return CosignersApiFp(this.configuration).getCosigner(requestParameters.cosignerId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all API keys - * @param {CosignersBetaApiGetApiKeysRequest} requestParameters Request parameters. + * Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user + * @param {CosignersApiGetCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public getApiKeys(requestParameters: CosignersBetaApiGetApiKeysRequest) { - return CosignersBetaApiFp(this.configuration).getApiKeys(requestParameters.cosignerId, requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getCosignerApiUser(requestParameters: CosignersApiGetCosignerApiUserRequest) { + return CosignersApiFp(this.configuration).getCosignerApiUser(requestParameters.cosignerId, requestParameters.apiUserId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get cosigner - * @param {CosignersBetaApiGetCosignerRequest} requestParameters Request parameters. + * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get API user request status + * @param {CosignersApiGetCosignerApiUserRequestStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public getCosigner(requestParameters: CosignersBetaApiGetCosignerRequest) { - return CosignersBetaApiFp(this.configuration).getCosigner(requestParameters.cosignerId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getCosignerApiUserRequestStatus(requestParameters: CosignersApiGetCosignerApiUserRequestStatusRequest) { + return CosignersApiFp(this.configuration).getCosignerApiUserRequestStatus(requestParameters.cosignerId, requestParameters.apiUserId, requestParameters.requestId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get all cosigners - * @param {CosignersBetaApiGetCosignersRequest} requestParameters Request parameters. + * Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all API users + * @param {CosignersApiGetCosignerApiUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public getCosigners(requestParameters: CosignersBetaApiGetCosignersRequest = {}) { - return CosignersBetaApiFp(this.configuration).getCosigners(requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getCosignerApiUsers(requestParameters: CosignersApiGetCosignerApiUsersRequest) { + return CosignersApiFp(this.configuration).getCosignerApiUsers(requestParameters.cosignerId, requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. - * @summary Get request status - * @param {CosignersBetaApiGetRequestStatusRequest} requestParameters Request parameters. + * Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin. + * @summary Get all cosigners + * @param {CosignersApiGetCosignersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public getRequestStatus(requestParameters: CosignersBetaApiGetRequestStatusRequest) { - return CosignersBetaApiFp(this.configuration).getRequestStatus(requestParameters.cosignerId, requestParameters.apiKeyId, requestParameters.requestId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getCosigners(requestParameters: CosignersApiGetCosignersRequest = {}) { + return CosignersApiFp(this.configuration).getCosigners(requestParameters.order, requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Pair API key - * @param {CosignersBetaApiPairApiKeyRequest} requestParameters Request parameters. + * Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Pair API user + * @param {CosignersApiPairCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public pairApiKey(requestParameters: CosignersBetaApiPairApiKeyRequest) { - return CosignersBetaApiFp(this.configuration).pairApiKey(requestParameters.pairApiKeyRequest, requestParameters.cosignerId, requestParameters.apiKeyId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public pairCosignerApiUser(requestParameters: CosignersApiPairCosignerApiUserRequest) { + return CosignersApiFp(this.configuration).pairCosignerApiUser(requestParameters.pairApiUserRequest, requestParameters.cosignerId, requestParameters.apiUserId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. + * Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. * @summary Rename cosigner - * @param {CosignersBetaApiRenameCosignerRequest} requestParameters Request parameters. + * @param {CosignersApiRenameCosignerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public renameCosigner(requestParameters: CosignersBetaApiRenameCosignerRequest) { - return CosignersBetaApiFp(this.configuration).renameCosigner(requestParameters.renameCosigner, requestParameters.cosignerId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public renameCosigner(requestParameters: CosignersApiRenameCosignerRequest) { + return CosignersApiFp(this.configuration).renameCosigner(requestParameters.renameCosigner, requestParameters.cosignerId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. - * @summary Unpair API key - * @param {CosignersBetaApiUnpairApiKeyRequest} requestParameters Request parameters. + * Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin. + * @summary Unpair API user + * @param {CosignersApiUnpairCosignerApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public unpairApiKey(requestParameters: CosignersBetaApiUnpairApiKeyRequest) { - return CosignersBetaApiFp(this.configuration).unpairApiKey(requestParameters.cosignerId, requestParameters.apiKeyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public unpairCosignerApiUser(requestParameters: CosignersApiUnpairCosignerApiUserRequest) { + return CosignersApiFp(this.configuration).unpairCosignerApiUser(requestParameters.cosignerId, requestParameters.apiUserId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. - * @summary Update API key callback handler - * @param {CosignersBetaApiUpdateCallbackHandlerRequest} requestParameters Request parameters. + * Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin. + * @summary Update API user callback handler + * @param {CosignersApiUpdateCosignerApiUserCallbackHandlerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CosignersBetaApi + * @memberof CosignersApi */ - public updateCallbackHandler(requestParameters: CosignersBetaApiUpdateCallbackHandlerRequest) { - return CosignersBetaApiFp(this.configuration).updateCallbackHandler(requestParameters.updateCallbackHandlerRequest, requestParameters.cosignerId, requestParameters.apiKeyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public updateCosignerApiUserCallbackHandler(requestParameters: CosignersApiUpdateCosignerApiUserCallbackHandlerRequest) { + return CosignersApiFp(this.configuration).updateCosignerApiUserCallbackHandler(requestParameters.updateCallbackHandlerRequest, requestParameters.cosignerId, requestParameters.apiUserId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } } /** * @export */ -export const GetApiKeysOrderEnum = { +export const GetCosignerApiUsersOrderEnum = { Asc: 'ASC', Desc: 'DESC' } as const; -export type GetApiKeysOrderEnum = typeof GetApiKeysOrderEnum[keyof typeof GetApiKeysOrderEnum]; +export type GetCosignerApiUsersOrderEnum = typeof GetCosignerApiUsersOrderEnum[keyof typeof GetCosignerApiUsersOrderEnum]; /** * @export */ diff --git a/api/key-link-beta-api.ts b/api/key-link-api.ts similarity index 75% rename from api/key-link-beta-api.ts rename to api/key-link-api.ts index 4c3aa65b..ba6d7db5 100644 --- a/api/key-link-beta-api.ts +++ b/api/key-link-api.ts @@ -57,10 +57,10 @@ import { SigningKeyDto } from '../models'; // @ts-ignore import { ValidationKeyDto } from '../models'; /** - * KeyLinkBetaApi - axios parameter creator + * KeyLinkApi - axios parameter creator * @export */ -export const KeyLinkBetaApiAxiosParamCreator = function (configuration?: Configuration) { +export const KeyLinkApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. @@ -195,11 +195,12 @@ export const KeyLinkBetaApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. + * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {ModifyValidationKeyDto} modifyValidationKeyDto * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @param {*} [options] Override http request option. + * @deprecated * @throws {RequiredError} */ disableValidationKey: async (modifyValidationKeyDto: ModifyValidationKeyDto, keyId: string, options: RawAxiosRequestConfig = {}): Promise => { @@ -481,16 +482,17 @@ export const KeyLinkBetaApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns the list of validation keys in the workspace + * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetValidationKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetValidationKeysListOrderEnum} [order] Is the order ascending or descending + * @param {boolean} [includeRevoked] Include revoked validation keys in the response * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getValidationKeysList: async (pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, options: RawAxiosRequestConfig = {}): Promise => { + getValidationKeysList: async (pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, includeRevoked?: boolean, options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/key_link/validation_keys`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -523,6 +525,52 @@ export const KeyLinkBetaApiAxiosParamCreator = function (configuration?: Configu localVarQueryParameter['order'] = order; } + if (includeRevoked !== undefined) { + localVarQueryParameter['includeRevoked'] = includeRevoked; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. + * @summary Revokes a validation key + * @param {string} keyId The unique identifier for the validation key provided by Fireblocks + * @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} + */ + revokeValidationKey: async (keyId: string, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('revokeValidationKey', 'keyId', keyId) + const localVarPath = `/key_link/validation_keys/{keyId}/revoke` + .replace(`{${"keyId"}}`, encodeURIComponent(String(keyId))); + // 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}; + // Stamped onto the request config (not the headers, so it never goes on + // the wire) so the response interceptor can name the operation in the + // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. + (localVarRequestOptions as any).fireblocksOperationId = 'revokeValidationKey'; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (idempotencyKey != null) { + localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -622,11 +670,11 @@ export const KeyLinkBetaApiAxiosParamCreator = function (configuration?: Configu }; /** - * KeyLinkBetaApi - functional programming interface + * KeyLinkApi - functional programming interface * @export */ -export const KeyLinkBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = KeyLinkBetaApiAxiosParamCreator(configuration) +export const KeyLinkApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = KeyLinkApiAxiosParamCreator(configuration) return { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. @@ -639,7 +687,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async createBulkSigningKeys(createBulkSigningKeys: CreateBulkSigningKeys, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createBulkSigningKeys(createBulkSigningKeys, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.createBulkSigningKeys']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.createBulkSigningKeys']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -653,7 +701,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async createSigningKey(createSigningKeyDto: CreateSigningKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createSigningKey(createSigningKeyDto, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.createSigningKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.createSigningKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -667,21 +715,22 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async createValidationKey(createValidationKeyDto: CreateValidationKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createValidationKey(createValidationKeyDto, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.createValidationKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.createValidationKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. + * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {ModifyValidationKeyDto} modifyValidationKeyDto * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @param {*} [options] Override http request option. + * @deprecated * @throws {RequiredError} */ async disableValidationKey(modifyValidationKeyDto: ModifyValidationKeyDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.disableValidationKey(modifyValidationKeyDto, keyId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.disableValidationKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.disableValidationKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -694,7 +743,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async getBulkSigningKeysJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkSigningKeysJob(jobId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getBulkSigningKeysJob']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.getBulkSigningKeysJob']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -708,7 +757,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async getBulkSigningKeysJobs(pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkSigningKeysJobs(pageCursor, pageSize, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getBulkSigningKeysJobs']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.getBulkSigningKeysJobs']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -721,7 +770,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async getSigningKey(keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSigningKey(keyId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getSigningKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.getSigningKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -744,7 +793,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async getSigningKeysList(pageCursor?: string, pageSize?: number, sortBy?: GetSigningKeysListSortByEnum, order?: GetSigningKeysListOrderEnum, vaultAccountId?: number, agentUserId?: string, algorithm?: GetSigningKeysListAlgorithmEnum, enabled?: boolean, available?: boolean, isAssigned?: boolean | null, keyPrefix?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSigningKeysList(pageCursor, pageSize, sortBy, order, vaultAccountId, agentUserId, algorithm, enabled, available, isAssigned, keyPrefix, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getSigningKeysList']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.getSigningKeysList']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -757,23 +806,38 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async getValidationKey(keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getValidationKey(keyId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getValidationKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.getValidationKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Returns the list of validation keys in the workspace + * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetValidationKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetValidationKeysListOrderEnum} [order] Is the order ascending or descending + * @param {boolean} [includeRevoked] Include revoked validation keys in the response + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getValidationKeysList(pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, includeRevoked?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getValidationKeysList(pageCursor, pageSize, sortBy, order, includeRevoked, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['KeyLinkApi.getValidationKeysList']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. + * @summary Revokes a validation key + * @param {string} keyId The unique identifier for the validation key provided by Fireblocks + * @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 getValidationKeysList(pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getValidationKeysList(pageCursor, pageSize, sortBy, order, options); + async revokeValidationKey(keyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.revokeValidationKey(keyId, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.getValidationKeysList']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.revokeValidationKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -787,7 +851,7 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async setAgentId(modifySigningKeyAgentIdDto: ModifySigningKeyAgentIdDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.setAgentId(modifySigningKeyAgentIdDto, keyId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.setAgentId']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.setAgentId']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -801,599 +865,651 @@ export const KeyLinkBetaApiFp = function(configuration?: Configuration) { async updateSigningKey(modifySigningKeyDto: ModifySigningKeyDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateSigningKey(modifySigningKeyDto, keyId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeyLinkBetaApi.updateSigningKey']?.[index]?.url; + const operationBasePath = operationServerMap['KeyLinkApi.updateSigningKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, } }; /** - * KeyLinkBetaApi - factory interface + * KeyLinkApi - factory interface * @export */ -export const KeyLinkBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = KeyLinkBetaApiFp(configuration) +export const KeyLinkApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = KeyLinkApiFp(configuration) return { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk - * @param {KeyLinkBetaApiCreateBulkSigningKeysRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateBulkSigningKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createBulkSigningKeys(requestParameters: KeyLinkBetaApiCreateBulkSigningKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise { + createBulkSigningKeys(requestParameters: KeyLinkApiCreateBulkSigningKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createBulkSigningKeys(requestParameters.createBulkSigningKeys, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key - * @param {KeyLinkBetaApiCreateSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createSigningKey(requestParameters: KeyLinkBetaApiCreateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + createSigningKey(requestParameters: KeyLinkApiCreateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createSigningKey(requestParameters.createSigningKeyDto, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key - * @param {KeyLinkBetaApiCreateValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createValidationKey(requestParameters: KeyLinkBetaApiCreateValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + createValidationKey(requestParameters: KeyLinkApiCreateValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createValidationKey(requestParameters.createValidationKeyDto, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. + * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key - * @param {KeyLinkBetaApiDisableValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiDisableValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. + * @deprecated * @throws {RequiredError} */ - disableValidationKey(requestParameters: KeyLinkBetaApiDisableValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + disableValidationKey(requestParameters: KeyLinkApiDisableValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.disableValidationKey(requestParameters.modifyValidationKeyDto, requestParameters.keyId, options).then((request) => request(axios, basePath)); }, /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job - * @param {KeyLinkBetaApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBulkSigningKeysJob(requestParameters: KeyLinkBetaApiGetBulkSigningKeysJobRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getBulkSigningKeysJob(requestParameters: KeyLinkApiGetBulkSigningKeysJobRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getBulkSigningKeysJob(requestParameters.jobId, options).then((request) => request(axios, basePath)); }, /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs - * @param {KeyLinkBetaApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBulkSigningKeysJobs(requestParameters: KeyLinkBetaApiGetBulkSigningKeysJobsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + getBulkSigningKeysJobs(requestParameters: KeyLinkApiGetBulkSigningKeysJobsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getBulkSigningKeysJobs(requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); }, /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` - * @param {KeyLinkBetaApiGetSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSigningKey(requestParameters: KeyLinkBetaApiGetSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getSigningKey(requestParameters: KeyLinkApiGetSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSigningKey(requestParameters.keyId, options).then((request) => request(axios, basePath)); }, /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys - * @param {KeyLinkBetaApiGetSigningKeysListRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetSigningKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSigningKeysList(requestParameters: KeyLinkBetaApiGetSigningKeysListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + getSigningKeysList(requestParameters: KeyLinkApiGetSigningKeysListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSigningKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.vaultAccountId, requestParameters.agentUserId, requestParameters.algorithm, requestParameters.enabled, requestParameters.available, requestParameters.isAssigned, requestParameters.keyPrefix, options).then((request) => request(axios, basePath)); }, /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` - * @param {KeyLinkBetaApiGetValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getValidationKey(requestParameters: KeyLinkBetaApiGetValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getValidationKey(requestParameters: KeyLinkApiGetValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getValidationKey(requestParameters.keyId, options).then((request) => request(axios, basePath)); }, /** - * Returns the list of validation keys in the workspace + * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys - * @param {KeyLinkBetaApiGetValidationKeysListRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetValidationKeysListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getValidationKeysList(requestParameters: KeyLinkApiGetValidationKeysListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getValidationKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.includeRevoked, options).then((request) => request(axios, basePath)); + }, + /** + * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. + * @summary Revokes a validation key + * @param {KeyLinkApiRevokeValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getValidationKeysList(requestParameters: KeyLinkBetaApiGetValidationKeysListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getValidationKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, options).then((request) => request(axios, basePath)); + revokeValidationKey(requestParameters: KeyLinkApiRevokeValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.revokeValidationKey(requestParameters.keyId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id - * @param {KeyLinkBetaApiSetAgentIdRequest} requestParameters Request parameters. + * @param {KeyLinkApiSetAgentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setAgentId(requestParameters: KeyLinkBetaApiSetAgentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise { + setAgentId(requestParameters: KeyLinkApiSetAgentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.setAgentId(requestParameters.modifySigningKeyAgentIdDto, requestParameters.keyId, options).then((request) => request(axios, basePath)); }, /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId - * @param {KeyLinkBetaApiUpdateSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiUpdateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateSigningKey(requestParameters: KeyLinkBetaApiUpdateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { + updateSigningKey(requestParameters: KeyLinkApiUpdateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateSigningKey(requestParameters.modifySigningKeyDto, requestParameters.keyId, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for createBulkSigningKeys operation in KeyLinkBetaApi. + * Request parameters for createBulkSigningKeys operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiCreateBulkSigningKeysRequest + * @interface KeyLinkApiCreateBulkSigningKeysRequest */ -export interface KeyLinkBetaApiCreateBulkSigningKeysRequest { +export interface KeyLinkApiCreateBulkSigningKeysRequest { /** * * @type {CreateBulkSigningKeys} - * @memberof KeyLinkBetaApiCreateBulkSigningKeys + * @memberof KeyLinkApiCreateBulkSigningKeys */ readonly createBulkSigningKeys: CreateBulkSigningKeys /** * 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 KeyLinkBetaApiCreateBulkSigningKeys + * @memberof KeyLinkApiCreateBulkSigningKeys */ readonly idempotencyKey?: string } /** - * Request parameters for createSigningKey operation in KeyLinkBetaApi. + * Request parameters for createSigningKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiCreateSigningKeyRequest + * @interface KeyLinkApiCreateSigningKeyRequest */ -export interface KeyLinkBetaApiCreateSigningKeyRequest { +export interface KeyLinkApiCreateSigningKeyRequest { /** * * @type {CreateSigningKeyDto} - * @memberof KeyLinkBetaApiCreateSigningKey + * @memberof KeyLinkApiCreateSigningKey */ readonly createSigningKeyDto: CreateSigningKeyDto /** * 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 KeyLinkBetaApiCreateSigningKey + * @memberof KeyLinkApiCreateSigningKey */ readonly idempotencyKey?: string } /** - * Request parameters for createValidationKey operation in KeyLinkBetaApi. + * Request parameters for createValidationKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiCreateValidationKeyRequest + * @interface KeyLinkApiCreateValidationKeyRequest */ -export interface KeyLinkBetaApiCreateValidationKeyRequest { +export interface KeyLinkApiCreateValidationKeyRequest { /** * * @type {CreateValidationKeyDto} - * @memberof KeyLinkBetaApiCreateValidationKey + * @memberof KeyLinkApiCreateValidationKey */ readonly createValidationKeyDto: CreateValidationKeyDto /** * 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 KeyLinkBetaApiCreateValidationKey + * @memberof KeyLinkApiCreateValidationKey */ readonly idempotencyKey?: string } /** - * Request parameters for disableValidationKey operation in KeyLinkBetaApi. + * Request parameters for disableValidationKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiDisableValidationKeyRequest + * @interface KeyLinkApiDisableValidationKeyRequest */ -export interface KeyLinkBetaApiDisableValidationKeyRequest { +export interface KeyLinkApiDisableValidationKeyRequest { /** * * @type {ModifyValidationKeyDto} - * @memberof KeyLinkBetaApiDisableValidationKey + * @memberof KeyLinkApiDisableValidationKey */ readonly modifyValidationKeyDto: ModifyValidationKeyDto /** * The unique identifier for the validation key provided by Fireblocks * @type {string} - * @memberof KeyLinkBetaApiDisableValidationKey + * @memberof KeyLinkApiDisableValidationKey */ readonly keyId: string } /** - * Request parameters for getBulkSigningKeysJob operation in KeyLinkBetaApi. + * Request parameters for getBulkSigningKeysJob operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetBulkSigningKeysJobRequest + * @interface KeyLinkApiGetBulkSigningKeysJobRequest */ -export interface KeyLinkBetaApiGetBulkSigningKeysJobRequest { +export interface KeyLinkApiGetBulkSigningKeysJobRequest { /** * The id of the bulk registration job * @type {string} - * @memberof KeyLinkBetaApiGetBulkSigningKeysJob + * @memberof KeyLinkApiGetBulkSigningKeysJob */ readonly jobId: string } /** - * Request parameters for getBulkSigningKeysJobs operation in KeyLinkBetaApi. + * Request parameters for getBulkSigningKeysJobs operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetBulkSigningKeysJobsRequest + * @interface KeyLinkApiGetBulkSigningKeysJobsRequest */ -export interface KeyLinkBetaApiGetBulkSigningKeysJobsRequest { +export interface KeyLinkApiGetBulkSigningKeysJobsRequest { /** * Cursor to the next page * @type {string} - * @memberof KeyLinkBetaApiGetBulkSigningKeysJobs + * @memberof KeyLinkApiGetBulkSigningKeysJobs */ readonly pageCursor?: string /** * Amount of results to return in the next page * @type {number} - * @memberof KeyLinkBetaApiGetBulkSigningKeysJobs + * @memberof KeyLinkApiGetBulkSigningKeysJobs */ readonly pageSize?: number } /** - * Request parameters for getSigningKey operation in KeyLinkBetaApi. + * Request parameters for getSigningKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetSigningKeyRequest + * @interface KeyLinkApiGetSigningKeyRequest */ -export interface KeyLinkBetaApiGetSigningKeyRequest { +export interface KeyLinkApiGetSigningKeyRequest { /** * The unique identifier for the signing key provided by Fireblocks * @type {string} - * @memberof KeyLinkBetaApiGetSigningKey + * @memberof KeyLinkApiGetSigningKey */ readonly keyId: string } /** - * Request parameters for getSigningKeysList operation in KeyLinkBetaApi. + * Request parameters for getSigningKeysList operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetSigningKeysListRequest + * @interface KeyLinkApiGetSigningKeysListRequest */ -export interface KeyLinkBetaApiGetSigningKeysListRequest { +export interface KeyLinkApiGetSigningKeysListRequest { /** * Cursor to the next page * @type {string} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly pageCursor?: string /** * Amount of results to return in the next page * @type {number} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly pageSize?: number /** * Field(s) to use for sorting * @type {'createdAt'} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly sortBy?: GetSigningKeysListSortByEnum /** * Is the order ascending or descending * @type {'ASC' | 'DESC'} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly order?: GetSigningKeysListOrderEnum /** * Return keys assigned to a specific vault * @type {number} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly vaultAccountId?: number /** * Return keys associated with a specific agent user * @type {string} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly agentUserId?: string /** * Return only keys with a specific algorithm * @type {'ECDSA_SECP256K1' | 'EDDSA_ED25519'} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly algorithm?: GetSigningKeysListAlgorithmEnum /** * Return keys that have been proof of ownership * @type {boolean} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly enabled?: boolean /** * Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set * @type {boolean} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly available?: boolean /** * Return keys that are assigned to a vault account * @type {boolean} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly isAssigned?: boolean | null /** * A case-insensitive prefix filter that matches records where either keyId or signingDeviceKeyID starts with the specified value. * @type {string} - * @memberof KeyLinkBetaApiGetSigningKeysList + * @memberof KeyLinkApiGetSigningKeysList */ readonly keyPrefix?: string } /** - * Request parameters for getValidationKey operation in KeyLinkBetaApi. + * Request parameters for getValidationKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetValidationKeyRequest + * @interface KeyLinkApiGetValidationKeyRequest */ -export interface KeyLinkBetaApiGetValidationKeyRequest { +export interface KeyLinkApiGetValidationKeyRequest { /** * * @type {string} - * @memberof KeyLinkBetaApiGetValidationKey + * @memberof KeyLinkApiGetValidationKey */ readonly keyId: string } /** - * Request parameters for getValidationKeysList operation in KeyLinkBetaApi. + * Request parameters for getValidationKeysList operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiGetValidationKeysListRequest + * @interface KeyLinkApiGetValidationKeysListRequest */ -export interface KeyLinkBetaApiGetValidationKeysListRequest { +export interface KeyLinkApiGetValidationKeysListRequest { /** * Cursor to the next page * @type {string} - * @memberof KeyLinkBetaApiGetValidationKeysList + * @memberof KeyLinkApiGetValidationKeysList */ readonly pageCursor?: string /** * Amount of results to return in the next page * @type {number} - * @memberof KeyLinkBetaApiGetValidationKeysList + * @memberof KeyLinkApiGetValidationKeysList */ readonly pageSize?: number /** * Field(s) to use for sorting * @type {'createdAt'} - * @memberof KeyLinkBetaApiGetValidationKeysList + * @memberof KeyLinkApiGetValidationKeysList */ readonly sortBy?: GetValidationKeysListSortByEnum /** * Is the order ascending or descending * @type {'ASC' | 'DESC'} - * @memberof KeyLinkBetaApiGetValidationKeysList + * @memberof KeyLinkApiGetValidationKeysList */ readonly order?: GetValidationKeysListOrderEnum + + /** + * Include revoked validation keys in the response + * @type {boolean} + * @memberof KeyLinkApiGetValidationKeysList + */ + readonly includeRevoked?: boolean } /** - * Request parameters for setAgentId operation in KeyLinkBetaApi. + * Request parameters for revokeValidationKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiSetAgentIdRequest + * @interface KeyLinkApiRevokeValidationKeyRequest */ -export interface KeyLinkBetaApiSetAgentIdRequest { +export interface KeyLinkApiRevokeValidationKeyRequest { + /** + * The unique identifier for the validation key provided by Fireblocks + * @type {string} + * @memberof KeyLinkApiRevokeValidationKey + */ + readonly keyId: 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 KeyLinkApiRevokeValidationKey + */ + readonly idempotencyKey?: string +} + +/** + * Request parameters for setAgentId operation in KeyLinkApi. + * @export + * @interface KeyLinkApiSetAgentIdRequest + */ +export interface KeyLinkApiSetAgentIdRequest { /** * * @type {ModifySigningKeyAgentIdDto} - * @memberof KeyLinkBetaApiSetAgentId + * @memberof KeyLinkApiSetAgentId */ readonly modifySigningKeyAgentIdDto: ModifySigningKeyAgentIdDto /** * The unique identifier for the signing key provided by Fireblocks * @type {string} - * @memberof KeyLinkBetaApiSetAgentId + * @memberof KeyLinkApiSetAgentId */ readonly keyId: string } /** - * Request parameters for updateSigningKey operation in KeyLinkBetaApi. + * Request parameters for updateSigningKey operation in KeyLinkApi. * @export - * @interface KeyLinkBetaApiUpdateSigningKeyRequest + * @interface KeyLinkApiUpdateSigningKeyRequest */ -export interface KeyLinkBetaApiUpdateSigningKeyRequest { +export interface KeyLinkApiUpdateSigningKeyRequest { /** * * @type {ModifySigningKeyDto} - * @memberof KeyLinkBetaApiUpdateSigningKey + * @memberof KeyLinkApiUpdateSigningKey */ readonly modifySigningKeyDto: ModifySigningKeyDto /** * The unique identifier for the signing key provided by Fireblocks * @type {string} - * @memberof KeyLinkBetaApiUpdateSigningKey + * @memberof KeyLinkApiUpdateSigningKey */ readonly keyId: string } /** - * KeyLinkBetaApi - object-oriented interface + * KeyLinkApi - object-oriented interface * @export - * @class KeyLinkBetaApi + * @class KeyLinkApi * @extends {BaseAPI} */ -export class KeyLinkBetaApi extends BaseAPI { +export class KeyLinkApi extends BaseAPI { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk - * @param {KeyLinkBetaApiCreateBulkSigningKeysRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateBulkSigningKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public createBulkSigningKeys(requestParameters: KeyLinkBetaApiCreateBulkSigningKeysRequest) { - return KeyLinkBetaApiFp(this.configuration).createBulkSigningKeys(requestParameters.createBulkSigningKeys, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public createBulkSigningKeys(requestParameters: KeyLinkApiCreateBulkSigningKeysRequest) { + return KeyLinkApiFp(this.configuration).createBulkSigningKeys(requestParameters.createBulkSigningKeys, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key - * @param {KeyLinkBetaApiCreateSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public createSigningKey(requestParameters: KeyLinkBetaApiCreateSigningKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).createSigningKey(requestParameters.createSigningKeyDto, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public createSigningKey(requestParameters: KeyLinkApiCreateSigningKeyRequest) { + return KeyLinkApiFp(this.configuration).createSigningKey(requestParameters.createSigningKeyDto, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key - * @param {KeyLinkBetaApiCreateValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiCreateValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public createValidationKey(requestParameters: KeyLinkBetaApiCreateValidationKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).createValidationKey(requestParameters.createValidationKeyDto, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public createValidationKey(requestParameters: KeyLinkApiCreateValidationKeyRequest) { + return KeyLinkApiFp(this.configuration).createValidationKey(requestParameters.createValidationKeyDto, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. + * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key - * @param {KeyLinkBetaApiDisableValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiDisableValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. + * @deprecated * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public disableValidationKey(requestParameters: KeyLinkBetaApiDisableValidationKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).disableValidationKey(requestParameters.modifyValidationKeyDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public disableValidationKey(requestParameters: KeyLinkApiDisableValidationKeyRequest) { + return KeyLinkApiFp(this.configuration).disableValidationKey(requestParameters.modifyValidationKeyDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job - * @param {KeyLinkBetaApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getBulkSigningKeysJob(requestParameters: KeyLinkBetaApiGetBulkSigningKeysJobRequest) { - return KeyLinkBetaApiFp(this.configuration).getBulkSigningKeysJob(requestParameters.jobId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getBulkSigningKeysJob(requestParameters: KeyLinkApiGetBulkSigningKeysJobRequest) { + return KeyLinkApiFp(this.configuration).getBulkSigningKeysJob(requestParameters.jobId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs - * @param {KeyLinkBetaApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getBulkSigningKeysJobs(requestParameters: KeyLinkBetaApiGetBulkSigningKeysJobsRequest = {}) { - return KeyLinkBetaApiFp(this.configuration).getBulkSigningKeysJobs(requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getBulkSigningKeysJobs(requestParameters: KeyLinkApiGetBulkSigningKeysJobsRequest = {}) { + return KeyLinkApiFp(this.configuration).getBulkSigningKeysJobs(requestParameters.pageCursor, requestParameters.pageSize).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` - * @param {KeyLinkBetaApiGetSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getSigningKey(requestParameters: KeyLinkBetaApiGetSigningKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).getSigningKey(requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getSigningKey(requestParameters: KeyLinkApiGetSigningKeyRequest) { + return KeyLinkApiFp(this.configuration).getSigningKey(requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys - * @param {KeyLinkBetaApiGetSigningKeysListRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetSigningKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getSigningKeysList(requestParameters: KeyLinkBetaApiGetSigningKeysListRequest = {}) { - return KeyLinkBetaApiFp(this.configuration).getSigningKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.vaultAccountId, requestParameters.agentUserId, requestParameters.algorithm, requestParameters.enabled, requestParameters.available, requestParameters.isAssigned, requestParameters.keyPrefix).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getSigningKeysList(requestParameters: KeyLinkApiGetSigningKeysListRequest = {}) { + return KeyLinkApiFp(this.configuration).getSigningKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.vaultAccountId, requestParameters.agentUserId, requestParameters.algorithm, requestParameters.enabled, requestParameters.available, requestParameters.isAssigned, requestParameters.keyPrefix).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` - * @param {KeyLinkBetaApiGetValidationKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getValidationKey(requestParameters: KeyLinkBetaApiGetValidationKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).getValidationKey(requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getValidationKey(requestParameters: KeyLinkApiGetValidationKeyRequest) { + return KeyLinkApiFp(this.configuration).getValidationKey(requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Returns the list of validation keys in the workspace + * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys - * @param {KeyLinkBetaApiGetValidationKeysListRequest} requestParameters Request parameters. + * @param {KeyLinkApiGetValidationKeysListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof KeyLinkApi + */ + public getValidationKeysList(requestParameters: KeyLinkApiGetValidationKeysListRequest = {}) { + return KeyLinkApiFp(this.configuration).getValidationKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order, requestParameters.includeRevoked).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. + * @summary Revokes a validation key + * @param {KeyLinkApiRevokeValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public getValidationKeysList(requestParameters: KeyLinkBetaApiGetValidationKeysListRequest = {}) { - return KeyLinkBetaApiFp(this.configuration).getValidationKeysList(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.sortBy, requestParameters.order).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public revokeValidationKey(requestParameters: KeyLinkApiRevokeValidationKeyRequest) { + return KeyLinkApiFp(this.configuration).revokeValidationKey(requestParameters.keyId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id - * @param {KeyLinkBetaApiSetAgentIdRequest} requestParameters Request parameters. + * @param {KeyLinkApiSetAgentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public setAgentId(requestParameters: KeyLinkBetaApiSetAgentIdRequest) { - return KeyLinkBetaApiFp(this.configuration).setAgentId(requestParameters.modifySigningKeyAgentIdDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public setAgentId(requestParameters: KeyLinkApiSetAgentIdRequest) { + return KeyLinkApiFp(this.configuration).setAgentId(requestParameters.modifySigningKeyAgentIdDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId - * @param {KeyLinkBetaApiUpdateSigningKeyRequest} requestParameters Request parameters. + * @param {KeyLinkApiUpdateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeyLinkBetaApi + * @memberof KeyLinkApi */ - public updateSigningKey(requestParameters: KeyLinkBetaApiUpdateSigningKeyRequest) { - return KeyLinkBetaApiFp(this.configuration).updateSigningKey(requestParameters.modifySigningKeyDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public updateSigningKey(requestParameters: KeyLinkApiUpdateSigningKeyRequest) { + return KeyLinkApiFp(this.configuration).updateSigningKey(requestParameters.modifySigningKeyDto, requestParameters.keyId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } } diff --git a/api/keys-beta-api.ts b/api/keys-api.ts similarity index 77% rename from api/keys-beta-api.ts rename to api/keys-api.ts index 7e7a3547..b27b3867 100644 --- a/api/keys-beta-api.ts +++ b/api/keys-api.ts @@ -31,13 +31,13 @@ import { ErrorSchema } from '../models'; // @ts-ignore import { GetMpcKeysResponse } from '../models'; /** - * KeysBetaApi - axios parameter creator + * KeysApi - axios parameter creator * @export */ -export const KeysBetaApiAxiosParamCreator = function (configuration?: Configuration) { +export const KeysApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -71,7 +71,7 @@ export const KeysBetaApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys by `userId` * @param {string} userId The id for the user * @param {*} [options] Override http request option. @@ -111,14 +111,14 @@ export const KeysBetaApiAxiosParamCreator = function (configuration?: Configurat }; /** - * KeysBetaApi - functional programming interface + * KeysApi - functional programming interface * @export */ -export const KeysBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = KeysBetaApiAxiosParamCreator(configuration) +export const KeysApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = KeysApiAxiosParamCreator(configuration) return { /** - * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -126,11 +126,11 @@ export const KeysBetaApiFp = function(configuration?: Configuration) { async getMpcKeysList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMpcKeysList(options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeysBetaApi.getMpcKeysList']?.[index]?.url; + const operationBasePath = operationServerMap['KeysApi.getMpcKeysList']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys by `userId` * @param {string} userId The id for the user * @param {*} [options] Override http request option. @@ -139,21 +139,21 @@ export const KeysBetaApiFp = function(configuration?: Configuration) { async getMpcKeysListByUser(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMpcKeysListByUser(userId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['KeysBetaApi.getMpcKeysListByUser']?.[index]?.url; + const operationBasePath = operationServerMap['KeysApi.getMpcKeysListByUser']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, } }; /** - * KeysBetaApi - factory interface + * KeysApi - factory interface * @export */ -export const KeysBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = KeysBetaApiFp(configuration) +export const KeysApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = KeysApiFp(configuration) return { /** - * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -162,60 +162,60 @@ export const KeysBetaApiFactory = function (configuration?: Configuration, baseP return localVarFp.getMpcKeysList(options).then((request) => request(axios, basePath)); }, /** - * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys by `userId` - * @param {KeysBetaApiGetMpcKeysListByUserRequest} requestParameters Request parameters. + * @param {KeysApiGetMpcKeysListByUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMpcKeysListByUser(requestParameters: KeysBetaApiGetMpcKeysListByUserRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getMpcKeysListByUser(requestParameters: KeysApiGetMpcKeysListByUserRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getMpcKeysListByUser(requestParameters.userId, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for getMpcKeysListByUser operation in KeysBetaApi. + * Request parameters for getMpcKeysListByUser operation in KeysApi. * @export - * @interface KeysBetaApiGetMpcKeysListByUserRequest + * @interface KeysApiGetMpcKeysListByUserRequest */ -export interface KeysBetaApiGetMpcKeysListByUserRequest { +export interface KeysApiGetMpcKeysListByUserRequest { /** * The id for the user * @type {string} - * @memberof KeysBetaApiGetMpcKeysListByUser + * @memberof KeysApiGetMpcKeysListByUser */ readonly userId: string } /** - * KeysBetaApi - object-oriented interface + * KeysApi - object-oriented interface * @export - * @class KeysBetaApi + * @class KeysApi * @extends {BaseAPI} */ -export class KeysBetaApi extends BaseAPI { +export class KeysApi extends BaseAPI { /** - * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeysBetaApi + * @memberof KeysApi */ public getMpcKeysList() { - return KeysBetaApiFp(this.configuration).getMpcKeysList().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + return KeysApiFp(this.configuration).getMpcKeysList().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. + * Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. * @summary Get list of mpc keys by `userId` - * @param {KeysBetaApiGetMpcKeysListByUserRequest} requestParameters Request parameters. + * @param {KeysApiGetMpcKeysListByUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof KeysBetaApi + * @memberof KeysApi */ - public getMpcKeysListByUser(requestParameters: KeysBetaApiGetMpcKeysListByUserRequest) { - return KeysBetaApiFp(this.configuration).getMpcKeysListByUser(requestParameters.userId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getMpcKeysListByUser(requestParameters: KeysApiGetMpcKeysListByUserRequest) { + return KeysApiFp(this.configuration).getMpcKeysListByUser(requestParameters.userId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } } diff --git a/api/trlink-api.ts b/api/trlink-api.ts index bc5bc1c5..6353d466 100644 --- a/api/trlink-api.ts +++ b/api/trlink-api.ts @@ -327,7 +327,7 @@ export const TRLinkApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. + * Accept or reject destinations waiting for a Travel Rule message (missing TRM), without waiting for a TRP webhook or the missing-TRM policy timeout. You can submit before a destination enters the missing-TRM wait; if it can\'t be updated immediately, the decision is applied on the next processing attempt instead (status ACCEPTED). Check `status` in the response to see whether the decision has been applied. * @summary Manual decision for missing TRM * @param {TRLinkManualDecisionRequest} tRLinkManualDecisionRequest * @param {string} customerIntegrationId Customer integration unique identifier @@ -673,6 +673,46 @@ export const TRLinkApiAxiosParamCreator = function (configuration?: Configuratio + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns the current manual missing-TRM decision for a transaction. Use to follow a decision that is not yet applied, or to check status at any time. + * @summary Get manual decision for missing TRM + * @param {string} customerIntegrationId Customer integration unique identifier + * @param {string} txId Fireblocks transaction unique identifier + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTRLinkManualDecision: async (customerIntegrationId: string, txId: string, options: RawAxiosRequestConfig = {}): Promise => { + assertParamExistsAndNotEmpty('getTRLinkManualDecision', 'customerIntegrationId', customerIntegrationId) + assertParamExistsAndNotEmpty('getTRLinkManualDecision', 'txId', txId) + const localVarPath = `/screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision` + .replace(`{${"customerIntegrationId"}}`, encodeURIComponent(String(customerIntegrationId))) + .replace(`{${"txId"}}`, encodeURIComponent(String(txId))); + // 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}; + // Stamped onto the request config (not the headers, so it never goes on + // the wire) so the response interceptor can name the operation in the + // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. + (localVarRequestOptions as any).fireblocksOperationId = 'getTRLinkManualDecision'; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -1372,7 +1412,7 @@ export const TRLinkApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. + * Accept or reject destinations waiting for a Travel Rule message (missing TRM), without waiting for a TRP webhook or the missing-TRM policy timeout. You can submit before a destination enters the missing-TRM wait; if it can\'t be updated immediately, the decision is applied on the next processing attempt instead (status ACCEPTED). Check `status` in the response to see whether the decision has been applied. * @summary Manual decision for missing TRM * @param {TRLinkManualDecisionRequest} tRLinkManualDecisionRequest * @param {string} customerIntegrationId Customer integration unique identifier @@ -1493,6 +1533,20 @@ export const TRLinkApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['TRLinkApi.getTRLinkIntegrationPublicKey']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * Returns the current manual missing-TRM decision for a transaction. Use to follow a decision that is not yet applied, or to check status at any time. + * @summary Get manual decision for missing TRM + * @param {string} customerIntegrationId Customer integration unique identifier + * @param {string} txId Fireblocks transaction unique identifier + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTRLinkManualDecision(customerIntegrationId: string, txId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTRLinkManualDecision(customerIntegrationId, txId, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TRLinkApi.getTRLinkManualDecision']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * Retrieves a list of all available Travel Rule Support integration partners. Partners provide Travel Rule compliance services such as VASP discovery, TRM exchange, and PII encryption. * @summary List available TRSupport partners @@ -1755,7 +1809,7 @@ export const TRLinkApiFactory = function (configuration?: Configuration, basePat return localVarFp.createTRLinkIntegration(requestParameters.tRLinkCreateIntegrationRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. + * Accept or reject destinations waiting for a Travel Rule message (missing TRM), without waiting for a TRP webhook or the missing-TRM policy timeout. You can submit before a destination enters the missing-TRM wait; if it can\'t be updated immediately, the decision is applied on the next processing attempt instead (status ACCEPTED). Check `status` in the response to see whether the decision has been applied. * @summary Manual decision for missing TRM * @param {TRLinkApiCreateTRLinkManualDecisionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -1843,6 +1897,16 @@ export const TRLinkApiFactory = function (configuration?: Configuration, basePat getTRLinkIntegrationPublicKey(requestParameters: TRLinkApiGetTRLinkIntegrationPublicKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getTRLinkIntegrationPublicKey(requestParameters.customerIntegrationId, options).then((request) => request(axios, basePath)); }, + /** + * Returns the current manual missing-TRM decision for a transaction. Use to follow a decision that is not yet applied, or to check status at any time. + * @summary Get manual decision for missing TRM + * @param {TRLinkApiGetTRLinkManualDecisionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTRLinkManualDecision(requestParameters: TRLinkApiGetTRLinkManualDecisionRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTRLinkManualDecision(requestParameters.customerIntegrationId, requestParameters.txId, options).then((request) => request(axios, basePath)); + }, /** * Retrieves a list of all available Travel Rule Support integration partners. Partners provide Travel Rule compliance services such as VASP discovery, TRM exchange, and PII encryption. * @summary List available TRSupport partners @@ -2271,6 +2335,27 @@ export interface TRLinkApiGetTRLinkIntegrationPublicKeyRequest { readonly customerIntegrationId: string } +/** + * Request parameters for getTRLinkManualDecision operation in TRLinkApi. + * @export + * @interface TRLinkApiGetTRLinkManualDecisionRequest + */ +export interface TRLinkApiGetTRLinkManualDecisionRequest { + /** + * Customer integration unique identifier + * @type {string} + * @memberof TRLinkApiGetTRLinkManualDecision + */ + readonly customerIntegrationId: string + + /** + * Fireblocks transaction unique identifier + * @type {string} + * @memberof TRLinkApiGetTRLinkManualDecision + */ + readonly txId: string +} + /** * Request parameters for getTRLinkSupportedAsset operation in TRLinkApi. * @export @@ -2654,7 +2739,7 @@ export class TRLinkApi extends BaseAPI { } /** - * Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. + * Accept or reject destinations waiting for a Travel Rule message (missing TRM), without waiting for a TRP webhook or the missing-TRM policy timeout. You can submit before a destination enters the missing-TRM wait; if it can\'t be updated immediately, the decision is applied on the next processing attempt instead (status ACCEPTED). Check `status` in the response to see whether the decision has been applied. * @summary Manual decision for missing TRM * @param {TRLinkApiCreateTRLinkManualDecisionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -2760,6 +2845,18 @@ export class TRLinkApi extends BaseAPI { return TRLinkApiFp(this.configuration).getTRLinkIntegrationPublicKey(requestParameters.customerIntegrationId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } + /** + * Returns the current manual missing-TRM decision for a transaction. Use to follow a decision that is not yet applied, or to check status at any time. + * @summary Get manual decision for missing TRM + * @param {TRLinkApiGetTRLinkManualDecisionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TRLinkApi + */ + public getTRLinkManualDecision(requestParameters: TRLinkApiGetTRLinkManualDecisionRequest) { + return TRLinkApiFp(this.configuration).getTRLinkManualDecision(requestParameters.customerIntegrationId, requestParameters.txId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + /** * Retrieves a list of all available Travel Rule Support integration partners. Partners provide Travel Rule compliance services such as VASP discovery, TRM exchange, and PII encryption. * @summary List available TRSupport partners diff --git a/api/vaults-api.ts b/api/vaults-api.ts index 74e5d6b1..a0a52f0e 100644 --- a/api/vaults-api.ts +++ b/api/vaults-api.ts @@ -293,7 +293,7 @@ export const VaultsApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. + * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {CreateMultipleAccountsRequest} createMultipleAccountsRequest * @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. @@ -1963,7 +1963,7 @@ export const VaultsApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. + * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {CreateMultipleAccountsRequest} createMultipleAccountsRequest * @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. @@ -2527,7 +2527,7 @@ export const VaultsApiFactory = function (configuration?: Configuration, basePat return localVarFp.createLegacyAddress(requestParameters.vaultAccountId, requestParameters.assetId, requestParameters.addressId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. + * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {VaultsApiCreateMultipleAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -4017,7 +4017,7 @@ export class VaultsApi extends BaseAPI { } /** - * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. + * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {VaultsApiCreateMultipleAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/client/client.ts b/client/client.ts index 38060cda..e6c41bf3 100644 --- a/client/client.ts +++ b/client/client.ts @@ -27,7 +27,7 @@ import { ApiUserApi, ContractInteractionsApi, ContractTemplatesApi, ContractsApi, - CosignersBetaApi, + CosignersApi, DeployedContractsApi, EarnApi, EmbeddedWalletsApi, @@ -37,8 +37,8 @@ import { ApiUserApi, GasStationsApi, GenieBetaApi, InternalWalletsApi, - KeyLinkBetaApi, - KeysBetaApi, + KeyLinkApi, + KeysApi, NFTsApi, NetworkConnectionsApi, OTABetaApi, @@ -92,7 +92,7 @@ export class Fireblocks { private _contractInteractions?: ContractInteractionsApi; private _contractTemplates?: ContractTemplatesApi; private _contracts?: ContractsApi; - private _cosignersBeta?: CosignersBetaApi; + private _cosigners?: CosignersApi; private _deployedContracts?: DeployedContractsApi; private _earn?: EarnApi; private _embeddedWallets?: EmbeddedWalletsApi; @@ -102,8 +102,8 @@ export class Fireblocks { private _gasStations?: GasStationsApi; private _genieBeta?: GenieBetaApi; private _internalWallets?: InternalWalletsApi; - private _keyLinkBeta?: KeyLinkBetaApi; - private _keysBeta?: KeysBetaApi; + private _keyLink?: KeyLinkApi; + private _keys?: KeysApi; private _nfts?: NFTsApi; private _networkConnections?: NetworkConnectionsApi; private _otaBeta?: OTABetaApi; @@ -201,8 +201,8 @@ export class Fireblocks { get contracts(): ContractsApi { return this._contracts ?? new ContractsApi(this.config, undefined, this.axiosManager.axios); } - get cosignersBeta(): CosignersBetaApi { - return this._cosignersBeta ?? new CosignersBetaApi(this.config, undefined, this.axiosManager.axios); + get cosigners(): CosignersApi { + return this._cosigners ?? new CosignersApi(this.config, undefined, this.axiosManager.axios); } get deployedContracts(): DeployedContractsApi { return this._deployedContracts ?? new DeployedContractsApi(this.config, undefined, this.axiosManager.axios); @@ -231,11 +231,11 @@ export class Fireblocks { get internalWallets(): InternalWalletsApi { return this._internalWallets ?? new InternalWalletsApi(this.config, undefined, this.axiosManager.axios); } - get keyLinkBeta(): KeyLinkBetaApi { - return this._keyLinkBeta ?? new KeyLinkBetaApi(this.config, undefined, this.axiosManager.axios); + get keyLink(): KeyLinkApi { + return this._keyLink ?? new KeyLinkApi(this.config, undefined, this.axiosManager.axios); } - get keysBeta(): KeysBetaApi { - return this._keysBeta ?? new KeysBetaApi(this.config, undefined, this.axiosManager.axios); + get keys(): KeysApi { + return this._keys ?? new KeysApi(this.config, undefined, this.axiosManager.axios); } get nfts(): NFTsApi { return this._nfts ?? new NFTsApi(this.config, undefined, this.axiosManager.axios); diff --git a/docs/apis/ConsoleUserApi.md b/docs/apis/ConsoleUserApi.md index e087ce47..7fb8656a 100644 --- a/docs/apis/ConsoleUserApi.md +++ b/docs/apis/ConsoleUserApi.md @@ -79,7 +79,7 @@ No authorization required # **deleteConsoleUser** > ConsoleUser deleteConsoleUser() -Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is currently in beta and might be subject to changes. +Requests deletion of a console user. The request is asynchronous: it goes through the workspace\'s configured \"Delete users\" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - The workspace must have a \"Delete users\" approval policy (admin quorum or approval group). If \"Delete users\" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user\'s own approval counts toward the quorum. - Track progress by polling GET /management/users; deletion is complete when the user is disabled. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. **Note:** This endpoint is in Early Availability (EA) and may change or break before it reaches GA. ### Example diff --git a/docs/apis/CosignersBetaApi.md b/docs/apis/CosignersApi.md similarity index 73% rename from docs/apis/CosignersBetaApi.md rename to docs/apis/CosignersApi.md index b5147ba6..93ad06f1 100644 --- a/docs/apis/CosignersBetaApi.md +++ b/docs/apis/CosignersApi.md @@ -1,25 +1,25 @@ -# CosignersBetaApi +# CosignersApi All URIs are relative to https://developers.fireblocks.com/reference/ Method | HTTP request | Description ------------- | ------------- | ------------- [**addCosigner**](#addCosigner) | **POST** /cosigners | Add cosigner -[**getApiKey**](#getApiKey) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key -[**getApiKeys**](#getApiKeys) | **GET** /cosigners/{cosignerId}/api_keys | Get all API keys [**getCosigner**](#getCosigner) | **GET** /cosigners/{cosignerId} | Get cosigner +[**getCosignerApiUser**](#getCosignerApiUser) | **GET** /cosigners/{cosignerId}/api_users/{apiUserId} | Get API user +[**getCosignerApiUserRequestStatus**](#getCosignerApiUserRequestStatus) | **GET** /cosigners/{cosignerId}/api_users/{apiUserId}/{requestId} | Get API user request status +[**getCosignerApiUsers**](#getCosignerApiUsers) | **GET** /cosigners/{cosignerId}/api_users | Get all API users [**getCosigners**](#getCosigners) | **GET** /cosigners | Get all cosigners -[**getRequestStatus**](#getRequestStatus) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} | Get request status -[**pairApiKey**](#pairApiKey) | **PUT** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Pair API key +[**pairCosignerApiUser**](#pairCosignerApiUser) | **PUT** /cosigners/{cosignerId}/api_users/{apiUserId} | Pair API user [**renameCosigner**](#renameCosigner) | **PATCH** /cosigners/{cosignerId} | Rename cosigner -[**unpairApiKey**](#unpairApiKey) | **DELETE** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Unpair API key -[**updateCallbackHandler**](#updateCallbackHandler) | **PATCH** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Update API key callback handler +[**unpairCosignerApiUser**](#unpairCosignerApiUser) | **DELETE** /cosigners/{cosignerId}/api_users/{apiUserId} | Unpair API user +[**updateCosignerApiUserCallbackHandler**](#updateCosignerApiUserCallbackHandler) | **PATCH** /cosigners/{cosignerId}/api_users/{apiUserId} | Update API user callback handler # **addCosigner** > AddCosignerResponse addCosigner(addCosignerRequest) -Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. +Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -27,7 +27,7 @@ Add a new cosigner. The cosigner will be pending pairing until the API key is ma ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiAddCosignerRequest, AddCosignerResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiAddCosignerRequest, AddCosignerResponse } 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" @@ -36,14 +36,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiAddCosignerRequest = { +let body: CosignersApiAddCosignerRequest = { // AddCosignerRequest addCosignerRequest: param_value, // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) idempotencyKey: idempotencyKey_example, }; -fireblocks.cosignersBeta.addCosigner(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.addCosigner(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -79,10 +79,10 @@ 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) -# **getApiKey** -> ApiKey getApiKey() +# **getCosigner** +> Cosigner getCosigner() -Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. +Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -90,7 +90,7 @@ Get an API key by ID. **Note:** These endpoints are currently in beta and might ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiGetApiKeyRequest, ApiKey } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiGetCosignerRequest, Cosigner } 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" @@ -99,14 +99,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiGetApiKeyRequest = { +let body: CosignersApiGetCosignerRequest = { // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string | The unique identifier of the API key - apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f, }; -fireblocks.cosignersBeta.getApiKey(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.getCosigner(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -117,12 +115,11 @@ fireblocks.cosignersBeta.getApiKey(body).then((res: FireblocksResponse) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cosignerId** | [**string**] | The unique identifier of the cosigner | defaults to undefined - **apiKeyId** | [**string**] | The unique identifier of the API key | defaults to undefined ### Return type -**[ApiKey](../models/ApiKey.md)** +**[Cosigner](../models/Cosigner.md)** ### Authorization @@ -137,15 +134,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | An ApiKey object | * X-Request-ID -
| +**200** | A cosigner object | * 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) -# **getApiKeys** -> ApiKeysPaginatedResponse getApiKeys() +# **getCosignerApiUser** +> CosignerApiUser getCosignerApiUser() -Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. +Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -153,7 +150,7 @@ Get all cosigner paired API keys (paginated). **Note:** These endpoints are curr ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiGetApiKeysRequest, ApiKeysPaginatedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiGetCosignerApiUserRequest, CosignerApiUser } 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" @@ -162,18 +159,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiGetApiKeysRequest = { +let body: CosignersApiGetCosignerApiUserRequest = { // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) - order: ASC, - // string | Cursor of the required page (optional) - pageCursor: pageCursor_example, - // number | Maximum number of items in the page (optional) - pageSize: 10, + // string | The unique identifier of the API user + apiUserId: 44fcead0-7053-4831-a53a-df7fb90d440f, }; -fireblocks.cosignersBeta.getApiKeys(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.getCosignerApiUser(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -184,14 +177,12 @@ fireblocks.cosignersBeta.getApiKeys(body).then((res: FireblocksResponse** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' - **pageCursor** | [**string**] | Cursor of the required page | (optional) defaults to undefined - **pageSize** | [**number**] | Maximum number of items in the page | (optional) defaults to 10 + **apiUserId** | [**string**] | The unique identifier of the API user | defaults to undefined ### Return type -**[ApiKeysPaginatedResponse](../models/ApiKeysPaginatedResponse.md)** +**[CosignerApiUser](../models/CosignerApiUser.md)** ### Authorization @@ -206,15 +197,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | A paginated response containing ApiKey objects | * X-Request-ID -
| +**200** | A CosignerApiUser object | * 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) -# **getCosigner** -> Cosigner getCosigner() +# **getCosignerApiUserRequestStatus** +> Status getCosignerApiUserRequestStatus() -Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. +Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -222,7 +213,7 @@ Get a cosigner by ID. **Note:** These endpoints are currently in beta and might ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiGetCosignerRequest, Cosigner } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiGetCosignerApiUserRequestStatusRequest, Status } 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" @@ -231,12 +222,16 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiGetCosignerRequest = { +let body: CosignersApiGetCosignerApiUserRequestStatusRequest = { // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, + // string | The unique identifier of the API user + apiUserId: 44fcead0-7053-4831-a53a-df7fb90d440f, + // string + requestId: requestId_example, }; -fireblocks.cosignersBeta.getCosigner(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.getCosignerApiUserRequestStatus(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -247,11 +242,13 @@ fireblocks.cosignersBeta.getCosigner(body).then((res: FireblocksResponse | +**200** | The status of 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) -# **getCosigners** -> CosignersPaginatedResponse getCosigners() +# **getCosignerApiUsers** +> ApiUsersPaginatedResponse getCosignerApiUsers() -Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. +Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -282,7 +279,7 @@ Get all workspace cosigners (paginated). **Note:** These endpoints are currently ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiGetCosignersRequest, CosignersPaginatedResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiGetCosignerApiUsersRequest, ApiUsersPaginatedResponse } 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" @@ -291,7 +288,9 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiGetCosignersRequest = { +let body: CosignersApiGetCosignerApiUsersRequest = { + // string | The unique identifier of the cosigner + cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) order: ASC, // string | Cursor of the required page (optional) @@ -300,7 +299,7 @@ let body: CosignersBetaApiGetCosignersRequest = { pageSize: 10, }; -fireblocks.cosignersBeta.getCosigners(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.getCosignerApiUsers(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -310,6 +309,7 @@ fireblocks.cosignersBeta.getCosigners(body).then((res: FireblocksResponse** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' **pageCursor** | [**string**] | Cursor of the required page | (optional) defaults to undefined **pageSize** | [**number**] | Maximum number of items in the page | (optional) defaults to 10 @@ -317,7 +317,7 @@ Name | Type | Description | Notes ### Return type -**[CosignersPaginatedResponse](../models/CosignersPaginatedResponse.md)** +**[ApiUsersPaginatedResponse](../models/ApiUsersPaginatedResponse.md)** ### Authorization @@ -332,15 +332,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | A paginated response containing Cosigner objects | * X-Request-ID -
| +**200** | A paginated response containing CosignerApiUser objects | * 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) -# **getRequestStatus** -> Status getRequestStatus() +# **getCosigners** +> CosignersPaginatedResponse getCosigners() -Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. +Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -348,7 +348,7 @@ Get the status of an asynchronous request Endpoint Permission: Admin and Non-Sig ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiGetRequestStatusRequest, Status } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiGetCosignersRequest, CosignersPaginatedResponse } 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" @@ -357,16 +357,16 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiGetRequestStatusRequest = { - // string | The unique identifier of the cosigner - cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string | The unique identifier of the API key - apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string - requestId: requestId_example, +let body: CosignersApiGetCosignersRequest = { + // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional) + order: ASC, + // string | Cursor of the required page (optional) + pageCursor: pageCursor_example, + // number | Maximum number of items in the page (optional) + pageSize: 10, }; -fireblocks.cosignersBeta.getRequestStatus(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.getCosigners(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -376,14 +376,14 @@ fireblocks.cosignersBeta.getRequestStatus(body).then((res: FireblocksResponse** | ASC / DESC ordering (default DESC) | (optional) defaults to 'DESC' + **pageCursor** | [**string**] | Cursor of the required page | (optional) defaults to undefined + **pageSize** | [**number**] | Maximum number of items in the page | (optional) defaults to 10 ### Return type -**[Status](../models/Status.md)** +**[CosignersPaginatedResponse](../models/CosignersPaginatedResponse.md)** ### Authorization @@ -398,15 +398,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The status of the request | * X-Request-ID -
| +**200** | A paginated response containing Cosigner objects | * 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) -# **pairApiKey** -> PairApiKeyResponse pairApiKey(pairApiKeyRequest, ) +# **pairCosignerApiUser** +> PairApiUserResponse pairCosignerApiUser(pairApiUserRequest, ) -Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. +Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -414,7 +414,7 @@ Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiPairApiKeyRequest, PairApiKeyResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiPairCosignerApiUserRequest, PairApiUserResponse } 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" @@ -423,18 +423,18 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiPairApiKeyRequest = { - // PairApiKeyRequest - pairApiKeyRequest: param_value, +let body: CosignersApiPairCosignerApiUserRequest = { + // PairApiUserRequest + pairApiUserRequest: param_value, // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string | The unique identifier of the API key - apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f, + // string | The unique identifier of the API user + apiUserId: 44fcead0-7053-4831-a53a-df7fb90d440f, // 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.cosignersBeta.pairApiKey(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.pairCosignerApiUser(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -444,15 +444,15 @@ fireblocks.cosignersBeta.pairApiKey(body).then((res: FireblocksResponse * Location -
| +**202** | The API user object to be paired | * X-Request-ID -
* Location -
| **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) @@ -475,7 +475,7 @@ No authorization required # **renameCosigner** > Cosigner renameCosigner(renameCosigner, ) -Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. +Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -483,7 +483,7 @@ Rename a cosigner by ID. **Note:** These endpoints are currently in beta and mig ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiRenameCosignerRequest, Cosigner } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiRenameCosignerRequest, Cosigner } 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" @@ -492,14 +492,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiRenameCosignerRequest = { +let body: CosignersApiRenameCosignerRequest = { // RenameCosigner renameCosigner: param_value, // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, }; -fireblocks.cosignersBeta.renameCosigner(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.renameCosigner(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -535,10 +535,10 @@ 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) -# **unpairApiKey** -> ApiKey unpairApiKey() +# **unpairCosignerApiUser** +> CosignerApiUser unpairCosignerApiUser() -Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. +Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -546,7 +546,7 @@ Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Adm ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiUnpairApiKeyRequest, ApiKey } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiUnpairCosignerApiUserRequest, CosignerApiUser } 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" @@ -555,14 +555,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiUnpairApiKeyRequest = { +let body: CosignersApiUnpairCosignerApiUserRequest = { // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string | The unique identifier of the API key - apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f, + // string | The unique identifier of the API user + apiUserId: 44fcead0-7053-4831-a53a-df7fb90d440f, }; -fireblocks.cosignersBeta.unpairApiKey(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.unpairCosignerApiUser(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -573,12 +573,12 @@ fireblocks.cosignersBeta.unpairApiKey(body).then((res: FireblocksResponse * Location -
| +**202** | The API user object to be unpaired | * X-Request-ID -
* Location -
| **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) -# **updateCallbackHandler** -> UpdateCallbackHandlerResponse updateCallbackHandler(updateCallbackHandlerRequest, ) +# **updateCosignerApiUserCallbackHandler** +> UpdateCallbackHandlerResponse updateCosignerApiUserCallbackHandler(updateCallbackHandlerRequest, ) -Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. +Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin. ### Example @@ -609,7 +609,7 @@ Update the callback handler of an API key Endpoint Permission: Admin and Non-Sig ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, CosignersBetaApiUpdateCallbackHandlerRequest, UpdateCallbackHandlerResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, CosignersApiUpdateCosignerApiUserCallbackHandlerRequest, UpdateCallbackHandlerResponse } 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" @@ -618,16 +618,16 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: CosignersBetaApiUpdateCallbackHandlerRequest = { +let body: CosignersApiUpdateCosignerApiUserCallbackHandlerRequest = { // UpdateCallbackHandlerRequest updateCallbackHandlerRequest: param_value, // string | The unique identifier of the cosigner cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f, - // string | The unique identifier of the API key - apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f, + // string | The unique identifier of the API user + apiUserId: 44fcead0-7053-4831-a53a-df7fb90d440f, }; -fireblocks.cosignersBeta.updateCallbackHandler(body).then((res: FireblocksResponse) => { +fireblocks.cosigners.updateCosignerApiUserCallbackHandler(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -639,7 +639,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateCallbackHandlerRequest** | **[UpdateCallbackHandlerRequest](../models/UpdateCallbackHandlerRequest.md)**| | **cosignerId** | [**string**] | The unique identifier of the cosigner | defaults to undefined - **apiKeyId** | [**string**] | The unique identifier of the API key | defaults to undefined + **apiUserId** | [**string**] | The unique identifier of the API user | defaults to undefined ### Return type @@ -659,7 +659,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**202** | The API key object with the new callback handler | * X-Request-ID -
* Location -
| +**202** | The API user object with the new callback handler | * X-Request-ID -
* Location -
| **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/KeyLinkBetaApi.md b/docs/apis/KeyLinkApi.md similarity index 81% rename from docs/apis/KeyLinkBetaApi.md rename to docs/apis/KeyLinkApi.md index 45776132..120fa8e2 100644 --- a/docs/apis/KeyLinkBetaApi.md +++ b/docs/apis/KeyLinkApi.md @@ -1,4 +1,4 @@ -# KeyLinkBetaApi +# KeyLinkApi All URIs are relative to https://developers.fireblocks.com/reference/ @@ -14,6 +14,7 @@ Method | HTTP request | Description [**getSigningKeysList**](#getSigningKeysList) | **GET** /key_link/signing_keys | Get list of signing keys [**getValidationKey**](#getValidationKey) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId` [**getValidationKeysList**](#getValidationKeysList) | **GET** /key_link/validation_keys | Get list of registered validation keys +[**revokeValidationKey**](#revokeValidationKey) | **POST** /key_link/validation_keys/{keyId}/revoke | Revokes a validation key [**setAgentId**](#setAgentId) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id [**updateSigningKey**](#updateSigningKey) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId @@ -29,7 +30,7 @@ Accepts a set of signing keys certified by a single validation key and queues th ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiCreateBulkSigningKeysRequest, CreateBulkSigningKeysResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiCreateBulkSigningKeysRequest, CreateBulkSigningKeysResponse } 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" @@ -38,14 +39,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiCreateBulkSigningKeysRequest = { +let body: KeyLinkApiCreateBulkSigningKeysRequest = { // CreateBulkSigningKeys createBulkSigningKeys: param_value, // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) idempotencyKey: idempotencyKey_example, }; -fireblocks.keyLinkBeta.createBulkSigningKeys(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.createBulkSigningKeys(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -93,7 +94,7 @@ Adds a new signing key to the workspace. The added key will be linked to the spe ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiCreateSigningKeyRequest, SigningKeyDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiCreateSigningKeyRequest, SigningKeyDto } 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" @@ -102,14 +103,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiCreateSigningKeyRequest = { +let body: KeyLinkApiCreateSigningKeyRequest = { // CreateSigningKeyDto createSigningKeyDto: param_value, // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) idempotencyKey: idempotencyKey_example, }; -fireblocks.keyLinkBeta.createSigningKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.createSigningKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -156,7 +157,7 @@ Adds a new validation key used to validate signing keys. The new validation key ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiCreateValidationKeyRequest, CreateValidationKeyResponseDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiCreateValidationKeyRequest, CreateValidationKeyResponseDto } 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" @@ -165,14 +166,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiCreateValidationKeyRequest = { +let body: KeyLinkApiCreateValidationKeyRequest = { // CreateValidationKeyDto createValidationKeyDto: param_value, // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) idempotencyKey: idempotencyKey_example, }; -fireblocks.keyLinkBeta.createValidationKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.createValidationKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -211,7 +212,7 @@ No authorization required # **disableValidationKey** > ValidationKeyDto disableValidationKey(modifyValidationKeyDto, ) -Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. +DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. ### Example @@ -219,7 +220,7 @@ Allows disabling validation key even if it has not expired yet. It is not allowe ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiDisableValidationKeyRequest, ValidationKeyDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiDisableValidationKeyRequest, ValidationKeyDto } 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" @@ -228,14 +229,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiDisableValidationKeyRequest = { +let body: KeyLinkApiDisableValidationKeyRequest = { // ModifyValidationKeyDto modifyValidationKeyDto: param_value, // string | The unique identifier for the validation key provided by Fireblocks keyId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keyLinkBeta.disableValidationKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.disableValidationKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -282,7 +283,7 @@ Returns the progress and outcome of a bulk registration job. `created + alreadyR ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetBulkSigningKeysJobRequest, BulkSigningKeyJob } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetBulkSigningKeysJobRequest, BulkSigningKeyJob } 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" @@ -291,12 +292,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetBulkSigningKeysJobRequest = { +let body: KeyLinkApiGetBulkSigningKeysJobRequest = { // string | The id of the bulk registration job jobId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keyLinkBeta.getBulkSigningKeysJob(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getBulkSigningKeysJob(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -342,7 +343,7 @@ Returns the workspace\'s bulk registration jobs, newest first, a page at a time. ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetBulkSigningKeysJobsRequest, GetBulkSigningKeysJobsResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetBulkSigningKeysJobsRequest, GetBulkSigningKeysJobsResponse } 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" @@ -351,14 +352,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetBulkSigningKeysJobsRequest = { +let body: KeyLinkApiGetBulkSigningKeysJobsRequest = { // string | Cursor to the next page (optional) pageCursor: pageCursor_example, // number | Amount of results to return in the next page (optional) pageSize: 56, }; -fireblocks.keyLinkBeta.getBulkSigningKeysJobs(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getBulkSigningKeysJobs(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -405,7 +406,7 @@ Returns a signing key if it exists, identified by the specified `keyId`. ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetSigningKeyRequest, SigningKeyDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetSigningKeyRequest, SigningKeyDto } 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" @@ -414,12 +415,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetSigningKeyRequest = { +let body: KeyLinkApiGetSigningKeyRequest = { // string | The unique identifier for the signing key provided by Fireblocks keyId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keyLinkBeta.getSigningKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getSigningKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -465,7 +466,7 @@ Returns the list of signing keys in the workspace ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetSigningKeysListRequest, GetSigningKeyResponseDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetSigningKeysListRequest, GetSigningKeyResponseDto } 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" @@ -474,7 +475,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetSigningKeysListRequest = { +let body: KeyLinkApiGetSigningKeysListRequest = { // string | Cursor to the next page (optional) pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, // number | Amount of results to return in the next page (optional) @@ -499,7 +500,7 @@ let body: KeyLinkBetaApiGetSigningKeysListRequest = { keyPrefix: keyPrefix_example, }; -fireblocks.keyLinkBeta.getSigningKeysList(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getSigningKeysList(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -555,7 +556,7 @@ Returns a validation key if it exists, identified by the specified `keyId`. ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetValidationKeyRequest, ValidationKeyDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetValidationKeyRequest, ValidationKeyDto } 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" @@ -564,12 +565,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetValidationKeyRequest = { +let body: KeyLinkApiGetValidationKeyRequest = { // string keyId: keyId_example, }; -fireblocks.keyLinkBeta.getValidationKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getValidationKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -607,7 +608,7 @@ No authorization required # **getValidationKeysList** > GetValidationKeyResponseDto getValidationKeysList() -Returns the list of validation keys in the workspace +Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. ### Example @@ -615,7 +616,7 @@ Returns the list of validation keys in the workspace ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiGetValidationKeysListRequest, GetValidationKeyResponseDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiGetValidationKeysListRequest, GetValidationKeyResponseDto } 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" @@ -624,7 +625,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiGetValidationKeysListRequest = { +let body: KeyLinkApiGetValidationKeysListRequest = { // string | Cursor to the next page (optional) pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==, // number | Amount of results to return in the next page (optional) @@ -633,9 +634,11 @@ let body: KeyLinkBetaApiGetValidationKeysListRequest = { sortBy: sortBy_example, // 'ASC' | 'DESC' | Is the order ascending or descending (optional) order: order_example, + // boolean | Include revoked validation keys in the response (optional) + includeRevoked: true, }; -fireblocks.keyLinkBeta.getValidationKeysList(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.getValidationKeysList(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -649,6 +652,7 @@ Name | Type | Description | Notes **pageSize** | [**number**] | Amount of results to return in the next page | (optional) defaults to 10 **sortBy** | [**'createdAt'**]**Array<'createdAt'>** | Field(s) to use for sorting | (optional) defaults to 'createdAt' **order** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | Is the order ascending or descending | (optional) defaults to 'ASC' + **includeRevoked** | [**boolean**] | Include revoked validation keys in the response | (optional) defaults to false ### Return type @@ -673,6 +677,69 @@ 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) +# **revokeValidationKey** +> ValidationKeyDto revokeValidationKey() + +Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiRevokeValidationKeyRequest, ValidationKeyDto } 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: KeyLinkApiRevokeValidationKeyRequest = { + // string | The unique identifier for the validation key provided by Fireblocks + keyId: 46a92767-5f93-4a46-9eed-f012196bb4fc, + // 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.keyLink.revokeValidationKey(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 +------------- | ------------- | ------------- | ------------- + **keyId** | [**string**] | The unique identifier for the validation key provided by Fireblocks | 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 + +**[ValidationKeyDto](../models/ValidationKeyDto.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Revoked validation key data | * 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) + # **setAgentId** > setAgentId(modifySigningKeyAgentIdDto, ) @@ -684,7 +751,7 @@ Can modify existing signing key id if the key is not enabled. The change done in ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiSetAgentIdRequest } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiSetAgentIdRequest } 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" @@ -693,14 +760,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiSetAgentIdRequest = { +let body: KeyLinkApiSetAgentIdRequest = { // ModifySigningKeyAgentIdDto modifySigningKeyAgentIdDto: param_value, // string | The unique identifier for the signing key provided by Fireblocks keyId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keyLinkBeta.setAgentId(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.setAgentId(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -747,7 +814,7 @@ Allows assigning the signing key to a vault account, if it hasn\'t been assigned ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeyLinkBetaApiUpdateSigningKeyRequest, SigningKeyDto } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeyLinkApiUpdateSigningKeyRequest, SigningKeyDto } 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" @@ -756,14 +823,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeyLinkBetaApiUpdateSigningKeyRequest = { +let body: KeyLinkApiUpdateSigningKeyRequest = { // ModifySigningKeyDto modifySigningKeyDto: param_value, // string | The unique identifier for the signing key provided by Fireblocks keyId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keyLinkBeta.updateSigningKey(body).then((res: FireblocksResponse) => { +fireblocks.keyLink.updateSigningKey(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` diff --git a/docs/apis/KeysBetaApi.md b/docs/apis/KeysApi.md similarity index 84% rename from docs/apis/KeysBetaApi.md rename to docs/apis/KeysApi.md index 11c8a97a..aba3fb3c 100644 --- a/docs/apis/KeysBetaApi.md +++ b/docs/apis/KeysApi.md @@ -1,4 +1,4 @@ -# KeysBetaApi +# KeysApi All URIs are relative to https://developers.fireblocks.com/reference/ @@ -11,7 +11,7 @@ Method | HTTP request | Description # **getMpcKeysList** > GetMpcKeysResponse getMpcKeysList() -Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. +Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. ### Example @@ -30,7 +30,7 @@ const fireblocks = new Fireblocks(); let body:any = {}; -fireblocks.keysBeta.getMpcKeysList(body).then((res: FireblocksResponse) => { +fireblocks.keys.getMpcKeysList(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -65,7 +65,7 @@ No authorization required # **getMpcKeysListByUser** > GetMpcKeysResponse getMpcKeysListByUser() -Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. +Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. ### Example @@ -73,7 +73,7 @@ Returns a list of MPC signing keys of a specific user. For each key, the list of ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, KeysBetaApiGetMpcKeysListByUserRequest, GetMpcKeysResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, KeysApiGetMpcKeysListByUserRequest, GetMpcKeysResponse } 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" @@ -82,12 +82,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: KeysBetaApiGetMpcKeysListByUserRequest = { +let body: KeysApiGetMpcKeysListByUserRequest = { // string | The id for the user userId: 46a92767-5f93-4a46-9eed-f012196bb4fc, }; -fireblocks.keysBeta.getMpcKeysListByUser(body).then((res: FireblocksResponse) => { +fireblocks.keys.getMpcKeysListByUser(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` diff --git a/docs/apis/TRLinkApi.md b/docs/apis/TRLinkApi.md index 472e3ac2..3e3987d6 100644 --- a/docs/apis/TRLinkApi.md +++ b/docs/apis/TRLinkApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description [**getTRLinkCustomerIntegrations**](#getTRLinkCustomerIntegrations) | **GET** /screening/trlink/customers/{customerId}/integrations | Get customer integrations [**getTRLinkCustomers**](#getTRLinkCustomers) | **GET** /screening/trlink/customers | Get all customers [**getTRLinkIntegrationPublicKey**](#getTRLinkIntegrationPublicKey) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/public_key | Get public key for PII encryption +[**getTRLinkManualDecision**](#getTRLinkManualDecision) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision | Get manual decision for missing TRM [**getTRLinkPartners**](#getTRLinkPartners) | **GET** /screening/trlink/partners | List available TRSupport partners [**getTRLinkPolicy**](#getTRLinkPolicy) | **GET** /screening/trlink/policy | Get TRLink policy [**getTRLinkSupportedAsset**](#getTRLinkSupportedAsset) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID @@ -364,7 +365,7 @@ No authorization required # **createTRLinkManualDecision** > TRLinkManualDecisionResponse createTRLinkManualDecision(tRLinkManualDecisionRequest, ) -Accept or reject destinations stuck in NoTRM step without waiting for TRP webhook or policy timeout. +Accept or reject destinations waiting for a Travel Rule message (missing TRM), without waiting for a TRP webhook or the missing-TRM policy timeout. You can submit before a destination enters the missing-TRM wait; if it can\'t be updated immediately, the decision is applied on the next processing attempt instead (status ACCEPTED). Check `status` in the response to see whether the decision has been applied. ### Example @@ -425,7 +426,10 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Decision applied successfully | - | +**200** | Decision applied (status APPLIED), accepted for the next processing attempt (status ACCEPTED), or accepted early (status PRE_ACCEPTED). | * X-Request-ID -
| +**404** | Customer integration not found or not owned by tenant (code 2125). | * X-Request-ID -
| +**409** | Manual decision already final for this transaction (code 2127) or transaction screening already completed (code 2129). | * X-Request-ID -
| +**425** | Too Early - screening has not started for this transaction yet. | * 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) @@ -913,6 +917,70 @@ 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) +# **getTRLinkManualDecision** +> TRLinkManualDecisionResponse getTRLinkManualDecision() + +Returns the current manual missing-TRM decision for a transaction. Use to follow a decision that is not yet applied, or to check status at any time. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TRLinkApiGetTRLinkManualDecisionRequest, TRLinkManualDecisionResponse } 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: TRLinkApiGetTRLinkManualDecisionRequest = { + // string | Customer integration unique identifier + customerIntegrationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6, + // string | Fireblocks transaction unique identifier + txId: b70701f4-d7b1-4795-a8ee-b09cdb5b850e, +}; + +fireblocks.trLink.getTRLinkManualDecision(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 +------------- | ------------- | ------------- | ------------- + **customerIntegrationId** | [**string**] | Customer integration unique identifier | defaults to undefined + **txId** | [**string**] | Fireblocks transaction unique identifier | defaults to undefined + + +### Return type + +**[TRLinkManualDecisionResponse](../models/TRLinkManualDecisionResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Current manual decision (status APPLIED, ACCEPTED, or PRE_ACCEPTED). | * X-Request-ID -
| +**404** | No manual decision for this transaction (code 2128), or customer integration not found or not owned by tenant (code 2125). | * 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) + # **getTRLinkPartners** > TRLinkPartnersListResponse getTRLinkPartners() diff --git a/docs/apis/VaultsApi.md b/docs/apis/VaultsApi.md index a31893b7..fe7f7216 100644 --- a/docs/apis/VaultsApi.md +++ b/docs/apis/VaultsApi.md @@ -312,7 +312,7 @@ No authorization required # **createMultipleAccounts** > JobCreated createMultipleAccounts(createMultipleAccountsRequest) -Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. +Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. ### Example diff --git a/docs/models/AddCosignerRequest.md b/docs/models/AddCosignerRequest.md index 32c85fe6..0be671cc 100644 --- a/docs/models/AddCosignerRequest.md +++ b/docs/models/AddCosignerRequest.md @@ -4,7 +4,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**apiKeyId** | **string** | The id of the API key to be paired with the cosigner | [default to undefined]| +|**apiUserId** | **string** | The id of the API user to be paired with the cosigner | [default to undefined]| |**name** | **string** | The name of the cosigner | [default to undefined]| |**existingCosigner** | **boolean** | Whether the cosigner already exists in another workspace | [optional] [default to false]| diff --git a/docs/models/AddCosignerResponse.md b/docs/models/AddCosignerResponse.md index d2585690..e55ac884 100644 --- a/docs/models/AddCosignerResponse.md +++ b/docs/models/AddCosignerResponse.md @@ -4,7 +4,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**apiKeyId** | **string** | The id of the API key to be paired with the cosigner | [default to undefined]| +|**apiUserId** | **string** | The id of the API user to be paired with the cosigner | [default to undefined]| |**name** | **string** | The name of the cosigner | [default to undefined]| |**pendingCosignerId** | **string** | The unique identifier of a pending cosigner | [default to undefined]| |**existingCosigner** | **boolean** | Whether the cosigner already exists in another workspace | [optional] [default to false]| diff --git a/docs/models/ApiKeysPaginatedResponse.md b/docs/models/ApiUsersPaginatedResponse.md similarity index 72% rename from docs/models/ApiKeysPaginatedResponse.md rename to docs/models/ApiUsersPaginatedResponse.md index 76f1fed8..2da2d839 100644 --- a/docs/models/ApiKeysPaginatedResponse.md +++ b/docs/models/ApiUsersPaginatedResponse.md @@ -1,10 +1,10 @@ -# ApiKeysPaginatedResponse +# ApiUsersPaginatedResponse ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**data** | [**Array<ApiKey>**](ApiKey.md) | The data of the current page | [default to undefined]| +|**data** | [**Array<CosignerApiUser>**](CosignerApiUser.md) | The data of the current page | [default to undefined]| |**next** | **string** | The ID of the next page | [optional] [default to undefined]| diff --git a/docs/models/ApiKey.md b/docs/models/CosignerApiUser.md similarity index 66% rename from docs/models/ApiKey.md rename to docs/models/CosignerApiUser.md index 166788b2..2d2c5c79 100644 --- a/docs/models/ApiKey.md +++ b/docs/models/CosignerApiUser.md @@ -1,11 +1,11 @@ -# ApiKey +# CosignerApiUser ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**id** | **string** | The unique identifier of the API key | [default to undefined]| -|**lastSeen** | **string** | The date the API key was last seen | [optional] [default to undefined]| +|**id** | **string** | The unique identifier of the API user | [default to undefined]| +|**lastSeen** | **string** | The date the API user was last seen | [optional] [default to undefined]| |**callbackHandler** | [**CallbackHandler**](CallbackHandler.md) | | [optional] [default to undefined]| diff --git a/docs/models/CreateMultipleAccountsRequest.md b/docs/models/CreateMultipleAccountsRequest.md index 3bfff1f2..dfb214e7 100644 --- a/docs/models/CreateMultipleAccountsRequest.md +++ b/docs/models/CreateMultipleAccountsRequest.md @@ -10,6 +10,17 @@ |**vaultAccountNamesStartingIndex** | **number** | Copy vault accounts names starting from this index. If names array is used it\'ll fail | [optional] [default to undefined]| |**prefix** | **string** | When copying from existing vault accounts (vaultAccountNamesStartingIndex) then adding a prefix to the names. If names array is used it\'ll fail | [optional] [default to undefined]| |**tagIds** | **Array<string>** | Optional list of tag IDs to attach to all created vault accounts | [optional] [default to undefined]| +|**vaultType** | **string** | Type of vault accounts to create. The default type is MPC. KEY_LINK creates Key Link vault accounts. It requires a Key Link workspace. With autoAssign set to true, the vault accounts are bound to the workspace\'s Key Link signing keys, assigned automatically from the available keys, and only one KEY_LINK bulk creation with autoAssign set to true can run per workspace at a time. With autoAssign set to false (the default), the vault accounts are created without keys. With KEY_LINK, names, vaultAccountNamesStartingIndex, prefix and tagIds work as they do for MPC, and baseAssetIds may be empty to create vault accounts without wallets. | [optional] [default to VaultTypeEnum_Mpc]| +|**autoAssign** | **boolean** | Applicable only when vaultType is KEY_LINK. For MPC, this parameter is ignored. If set to true, keys are assigned to every created vault account. If there are not enough available keys to assign, the request returns an error and no vault accounts are created. If set to false, the vault accounts are created without any keys, and baseAssetIds must be empty because wallets can only be created for vault accounts that have keys. | [optional] [default to false]| + + +## Enum: CreateMultipleAccountsRequestVaultTypeEnum + + +* `Mpc` (value: `'MPC'`) + +* `KeyLink` (value: `'KEY_LINK'`) + diff --git a/docs/models/CreateTempoTransferRequest.md b/docs/models/CreateTempoTransferRequest.md index 8ce21052..d592a481 100644 --- a/docs/models/CreateTempoTransferRequest.md +++ b/docs/models/CreateTempoTransferRequest.md @@ -26,7 +26,6 @@ |**feePayerAccountId** | **string** | Vault account ID of the fee payer sponsoring this transfer. | [optional] [default to undefined]| |**nonceStrategy** | **string** | Tempo\'s 2-dimensional nonce strategy: `SEQUENTIAL` runs under a single nonce lane (lane 0); `USER_DEFINED_LANE` runs in parallel under a specified lane (1–16), and requires `nonceLane`; `EXPIRING` marks the transaction with an expiry of up to 5 minutes (Tempo-defined) and does not use `nonceLane`. | [optional] [default to undefined]| |**nonceLane** | **number** | The nonce lane to use, 1–16. Required and only meaningful when nonceStrategy is USER_DEFINED_LANE; not used for SEQUENTIAL or EXPIRING. | [optional] [default to undefined]| -|**memo** | **string** | Beta. Tempo TIP-20 memo (max 32 bytes). | [optional] [default to undefined]| ## Enum: CreateTempoTransferRequestFeeLevelEnum diff --git a/docs/models/PairApiKeyRequest.md b/docs/models/PairApiUserRequest.md similarity index 95% rename from docs/models/PairApiKeyRequest.md rename to docs/models/PairApiUserRequest.md index f3fd739c..da80a3a5 100644 --- a/docs/models/PairApiKeyRequest.md +++ b/docs/models/PairApiUserRequest.md @@ -1,4 +1,4 @@ -# PairApiKeyRequest +# PairApiUserRequest ## Properties diff --git a/docs/models/PairApiKeyResponse.md b/docs/models/PairApiUserResponse.md similarity index 79% rename from docs/models/PairApiKeyResponse.md rename to docs/models/PairApiUserResponse.md index 6c2cbf56..3c193a18 100644 --- a/docs/models/PairApiKeyResponse.md +++ b/docs/models/PairApiUserResponse.md @@ -1,10 +1,10 @@ -# PairApiKeyResponse +# PairApiUserResponse ## Properties |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**id** | **string** | The unique identifier of the API key | [default to undefined]| +|**id** | **string** | The unique identifier of the API user | [default to undefined]| |**callbackHandler** | [**CallbackHandlerRequest**](CallbackHandlerRequest.md) | | [optional] [default to undefined]| diff --git a/docs/models/TRLinkManualDecisionDestinationDetail.md b/docs/models/TRLinkManualDecisionDestinationDetail.md index e17bfb2c..4f679081 100644 --- a/docs/models/TRLinkManualDecisionDestinationDetail.md +++ b/docs/models/TRLinkManualDecisionDestinationDetail.md @@ -6,7 +6,7 @@ |------------ | ------------- | ------------- | -------------| |**destinationScreeningId** | **string** | Destination screening record ID | [default to undefined]| |**applied** | **boolean** | Whether the decision was applied to this destination | [default to undefined]| -|**skipReason** | **string** | Reason if the destination was skipped | [optional] [default to undefined]| +|**skipReason** | **string** | Reason when applied is false. Common values: deferred apply (destination could not be updated immediately), already applied, status changed, trmId exists, destination not found. | [optional] [default to undefined]| diff --git a/docs/models/TRLinkManualDecisionResponse.md b/docs/models/TRLinkManualDecisionResponse.md index bbc369fe..3ed54a5c 100644 --- a/docs/models/TRLinkManualDecisionResponse.md +++ b/docs/models/TRLinkManualDecisionResponse.md @@ -4,6 +4,7 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| +|**status** | [**TRLinkManualDecisionResponseStatusEnum**](TRLinkManualDecisionResponseStatusEnum.md) | | [default to undefined]| |**action** | [**TRLinkManualDecisionAction**](TRLinkManualDecisionAction.md) | | [default to undefined]| |**source** | [**TRLinkManualDecisionSource**](TRLinkManualDecisionSource.md) | | [default to undefined]| |**txId** | **string** | Transaction ID | [default to undefined]| diff --git a/docs/models/TRLinkManualDecisionResponseStatusEnum.md b/docs/models/TRLinkManualDecisionResponseStatusEnum.md new file mode 100644 index 00000000..d6de716a --- /dev/null +++ b/docs/models/TRLinkManualDecisionResponseStatusEnum.md @@ -0,0 +1,14 @@ +# TRLinkManualDecisionResponseStatusEnum + +## Enum + + +* `Applied` (value: `'APPLIED'`) + +* `Accepted` (value: `'ACCEPTED'`) + +* `PreAccepted` (value: `'PRE_ACCEPTED'`) + + + +[[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/TRLinkManualDecisionSource.md b/docs/models/TRLinkManualDecisionSource.md index a37e2b40..725abfcb 100644 --- a/docs/models/TRLinkManualDecisionSource.md +++ b/docs/models/TRLinkManualDecisionSource.md @@ -3,9 +3,9 @@ ## Enum -* `Manual` (value: `'MANUAL'`) +* `Manual` (value: `'manual'`) -* `Policy` (value: `'POLICY'`) +* `Policy` (value: `'policy'`) diff --git a/docs/models/TempoTransferDestination.md b/docs/models/TempoTransferDestination.md index 220e256a..9042bebd 100644 --- a/docs/models/TempoTransferDestination.md +++ b/docs/models/TempoTransferDestination.md @@ -7,6 +7,7 @@ |**type** | **string** | The kind of destination. | [default to undefined]| |**id** | **string** | Required when type is VAULT_ACCOUNT or UNMANAGED_WALLET. | [optional] [default to undefined]| |**oneTimeAddress** | [**OneTimeAddress**](OneTimeAddress.md) | | [optional] [default to undefined]| +|**memo** | **string** | Tempo TIP-20 memo, sent on-chain with the transfer to this destination. Exactly 32 bytes once UTF-8 encoded. NOTES: - The memo is public and permanent on-chain, so do not put sensitive data in it. - A memo is currently supported only for a transfer with a single destination | [optional] [default to undefined]| ## Enum: TempoTransferDestinationTypeEnum diff --git a/docs/models/TypedMessageTransactionStatusEnum.md b/docs/models/TypedMessageTransactionStatusEnum.md index df68a596..470f9369 100644 --- a/docs/models/TypedMessageTransactionStatusEnum.md +++ b/docs/models/TypedMessageTransactionStatusEnum.md @@ -15,12 +15,16 @@ * `Pending3RdParty` (value: `'PENDING_3RD_PARTY'`) +* `Signed` (value: `'SIGNED'`) + * `Broadcasting` (value: `'BROADCASTING'`) * `PendingAmlScreening` (value: `'PENDING_AML_SCREENING'`) * `Confirming` (value: `'CONFIRMING'`) +* `Completed` (value: `'COMPLETED'`) + * `PartiallyCompleted` (value: `'PARTIALLY_COMPLETED'`) * `PendingEmailApproval` (value: `'PENDING_EMAIL_APPROVAL'`) diff --git a/docs/models/ValidationKeyDto.md b/docs/models/ValidationKeyDto.md index 0a82875b..2b631db2 100644 --- a/docs/models/ValidationKeyDto.md +++ b/docs/models/ValidationKeyDto.md @@ -9,6 +9,8 @@ |**daysTillExpired** | **number** | | [default to undefined]| |**enabled** | **boolean** | True if the validation key is enabled. | [default to undefined]| |**createdAt** | **number** | Creation date (timestamp) in milliseconds. | [default to undefined]| +|**expirationTime** | **number** | Expiration date (Unix timestamp) in milliseconds. | [default to undefined]| +|**revoked** | **boolean** | True if the validation key is revoked. | [default to false]| diff --git a/models/add-cosigner-request.ts b/models/add-cosigner-request.ts index 5bcf990d..eb2c0e09 100644 --- a/models/add-cosigner-request.ts +++ b/models/add-cosigner-request.ts @@ -21,11 +21,11 @@ */ export interface AddCosignerRequest { /** - * The id of the API key to be paired with the cosigner + * The id of the API user to be paired with the cosigner * @type {string} * @memberof AddCosignerRequest */ - 'apiKeyId': string; + 'apiUserId': string; /** * The name of the cosigner * @type {string} diff --git a/models/add-cosigner-response.ts b/models/add-cosigner-response.ts index 591e8f18..a666d6e0 100644 --- a/models/add-cosigner-response.ts +++ b/models/add-cosigner-response.ts @@ -21,11 +21,11 @@ */ export interface AddCosignerResponse { /** - * The id of the API key to be paired with the cosigner + * The id of the API user to be paired with the cosigner * @type {string} * @memberof AddCosignerResponse */ - 'apiKeyId': string; + 'apiUserId': string; /** * The name of the cosigner * @type {string} diff --git a/models/api-keys-paginated-response.ts b/models/api-users-paginated-response.ts similarity index 74% rename from models/api-keys-paginated-response.ts rename to models/api-users-paginated-response.ts index e225df70..e53813a6 100644 --- a/models/api-keys-paginated-response.ts +++ b/models/api-users-paginated-response.ts @@ -15,24 +15,24 @@ // May contain unused imports in some cases // @ts-ignore -import { ApiKey } from './api-key'; +import { CosignerApiUser } from './cosigner-api-user'; /** * * @export - * @interface ApiKeysPaginatedResponse + * @interface ApiUsersPaginatedResponse */ -export interface ApiKeysPaginatedResponse { +export interface ApiUsersPaginatedResponse { /** * The data of the current page - * @type {Array} - * @memberof ApiKeysPaginatedResponse + * @type {Array} + * @memberof ApiUsersPaginatedResponse */ - 'data': Array; + 'data': Array; /** * The ID of the next page * @type {string} - * @memberof ApiKeysPaginatedResponse + * @memberof ApiUsersPaginatedResponse */ 'next'?: string | null; } diff --git a/models/api-key.ts b/models/cosigner-api-user.ts similarity index 80% rename from models/api-key.ts rename to models/cosigner-api-user.ts index ecb0af00..3a447756 100644 --- a/models/api-key.ts +++ b/models/cosigner-api-user.ts @@ -20,25 +20,25 @@ import { CallbackHandler } from './callback-handler'; /** * * @export - * @interface ApiKey + * @interface CosignerApiUser */ -export interface ApiKey { +export interface CosignerApiUser { /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof ApiKey + * @memberof CosignerApiUser */ 'id': string; /** - * The date the API key was last seen + * The date the API user was last seen * @type {string} - * @memberof ApiKey + * @memberof CosignerApiUser */ 'lastSeen'?: string; /** * * @type {CallbackHandler} - * @memberof ApiKey + * @memberof CosignerApiUser */ 'callbackHandler'?: CallbackHandler; } diff --git a/models/create-multiple-accounts-request.ts b/models/create-multiple-accounts-request.ts index 0bd4c81b..66ad44f9 100644 --- a/models/create-multiple-accounts-request.ts +++ b/models/create-multiple-accounts-request.ts @@ -56,5 +56,25 @@ export interface CreateMultipleAccountsRequest { * @memberof CreateMultipleAccountsRequest */ 'tagIds'?: Array; + /** + * Type of vault accounts to create. The default type is MPC. KEY_LINK creates Key Link vault accounts. It requires a Key Link workspace. With autoAssign set to true, the vault accounts are bound to the workspace\'s Key Link signing keys, assigned automatically from the available keys, and only one KEY_LINK bulk creation with autoAssign set to true can run per workspace at a time. With autoAssign set to false (the default), the vault accounts are created without keys. With KEY_LINK, names, vaultAccountNamesStartingIndex, prefix and tagIds work as they do for MPC, and baseAssetIds may be empty to create vault accounts without wallets. + * @type {string} + * @memberof CreateMultipleAccountsRequest + */ + 'vaultType'?: CreateMultipleAccountsRequestVaultTypeEnum; + /** + * Applicable only when vaultType is KEY_LINK. For MPC, this parameter is ignored. If set to true, keys are assigned to every created vault account. If there are not enough available keys to assign, the request returns an error and no vault accounts are created. If set to false, the vault accounts are created without any keys, and baseAssetIds must be empty because wallets can only be created for vault accounts that have keys. + * @type {boolean} + * @memberof CreateMultipleAccountsRequest + */ + 'autoAssign'?: boolean; } +export const CreateMultipleAccountsRequestVaultTypeEnum = { + Mpc: 'MPC', + KeyLink: 'KEY_LINK' +} as const; + +export type CreateMultipleAccountsRequestVaultTypeEnum = typeof CreateMultipleAccountsRequestVaultTypeEnum[keyof typeof CreateMultipleAccountsRequestVaultTypeEnum]; + + diff --git a/models/create-tempo-transfer-request.ts b/models/create-tempo-transfer-request.ts index 444376eb..28e35e17 100644 --- a/models/create-tempo-transfer-request.ts +++ b/models/create-tempo-transfer-request.ts @@ -164,12 +164,6 @@ export interface CreateTempoTransferRequest { * @memberof CreateTempoTransferRequest */ 'nonceLane'?: number; - /** - * Beta. Tempo TIP-20 memo (max 32 bytes). - * @type {string} - * @memberof CreateTempoTransferRequest - */ - 'memo'?: string; } export const CreateTempoTransferRequestFeeLevelEnum = { diff --git a/models/index.ts b/models/index.ts index 1f86dd40..94751c34 100644 --- a/models/index.ts +++ b/models/index.ts @@ -94,8 +94,7 @@ export * from './amount-over-time-config'; export * from './amount-range'; export * from './amount-range-min-max'; export * from './amount-range-min-max2'; -export * from './api-key'; -export * from './api-keys-paginated-response'; +export * from './api-users-paginated-response'; export * from './approval-api-key'; export * from './approval-api-public-key'; export * from './approval-request'; @@ -299,6 +298,7 @@ export * from './conversion-validation-failure'; export * from './convert-assets-request'; export * from './convert-assets-response'; export * from './cosigner'; +export * from './cosigner-api-user'; export * from './cosigners-paginated-response'; export * from './counterparty-group'; export * from './counterparty-groups-paginated-response'; @@ -738,8 +738,8 @@ export * from './paginated-asset-wallet-response'; export * from './paginated-asset-wallet-response-paging'; export * from './paginated-assets-response'; export * from './paging'; -export * from './pair-api-key-request'; -export * from './pair-api-key-response'; +export * from './pair-api-user-request'; +export * from './pair-api-user-response'; export * from './parameter'; export * from './parameter-with-value'; export * from './parameter-with-value-list'; @@ -1084,6 +1084,7 @@ export * from './trlink-manual-decision-action'; export * from './trlink-manual-decision-destination-detail'; export * from './trlink-manual-decision-request'; export * from './trlink-manual-decision-response'; +export * from './trlink-manual-decision-response-status-enum'; export * from './trlink-manual-decision-source'; export * from './trlink-missing-trm-action'; export * from './trlink-missing-trm-action2'; diff --git a/models/pair-api-key-request.ts b/models/pair-api-user-request.ts similarity index 89% rename from models/pair-api-key-request.ts rename to models/pair-api-user-request.ts index d2bed3e5..664ece80 100644 --- a/models/pair-api-key-request.ts +++ b/models/pair-api-user-request.ts @@ -20,13 +20,13 @@ import { CallbackHandlerRequest } from './callback-handler-request'; /** * * @export - * @interface PairApiKeyRequest + * @interface PairApiUserRequest */ -export interface PairApiKeyRequest { +export interface PairApiUserRequest { /** * * @type {CallbackHandlerRequest} - * @memberof PairApiKeyRequest + * @memberof PairApiUserRequest */ 'callbackHandler'?: CallbackHandlerRequest; } diff --git a/models/pair-api-key-response.ts b/models/pair-api-user-response.ts similarity index 83% rename from models/pair-api-key-response.ts rename to models/pair-api-user-response.ts index 0b0f5908..483c4fc1 100644 --- a/models/pair-api-key-response.ts +++ b/models/pair-api-user-response.ts @@ -20,19 +20,19 @@ import { CallbackHandlerRequest } from './callback-handler-request'; /** * * @export - * @interface PairApiKeyResponse + * @interface PairApiUserResponse */ -export interface PairApiKeyResponse { +export interface PairApiUserResponse { /** - * The unique identifier of the API key + * The unique identifier of the API user * @type {string} - * @memberof PairApiKeyResponse + * @memberof PairApiUserResponse */ 'id': string; /** * * @type {CallbackHandlerRequest} - * @memberof PairApiKeyResponse + * @memberof PairApiUserResponse */ 'callbackHandler'?: CallbackHandlerRequest; } diff --git a/models/tempo-transfer-destination.ts b/models/tempo-transfer-destination.ts index 646a954f..806e9a6c 100644 --- a/models/tempo-transfer-destination.ts +++ b/models/tempo-transfer-destination.ts @@ -41,6 +41,12 @@ export interface TempoTransferDestination { * @memberof TempoTransferDestination */ 'oneTimeAddress'?: OneTimeAddress; + /** + * Tempo TIP-20 memo, sent on-chain with the transfer to this destination. Exactly 32 bytes once UTF-8 encoded. NOTES: - The memo is public and permanent on-chain, so do not put sensitive data in it. - A memo is currently supported only for a transfer with a single destination + * @type {string} + * @memberof TempoTransferDestination + */ + 'memo'?: string; } export const TempoTransferDestinationTypeEnum = { diff --git a/models/trlink-manual-decision-action.ts b/models/trlink-manual-decision-action.ts index 72968ff7..93609257 100644 --- a/models/trlink-manual-decision-action.ts +++ b/models/trlink-manual-decision-action.ts @@ -15,7 +15,7 @@ /** - * Decision action for destinations in NoTRM status + * Decision action for destinations waiting for a Travel Rule message (missing TRM) * @export * @enum {string} */ diff --git a/models/trlink-manual-decision-destination-detail.ts b/models/trlink-manual-decision-destination-detail.ts index 5a4360de..52ebc2be 100644 --- a/models/trlink-manual-decision-destination-detail.ts +++ b/models/trlink-manual-decision-destination-detail.ts @@ -33,7 +33,7 @@ export interface TRLinkManualDecisionDestinationDetail { */ 'applied': boolean; /** - * Reason if the destination was skipped + * Reason when applied is false. Common values: deferred apply (destination could not be updated immediately), already applied, status changed, trmId exists, destination not found. * @type {string} * @memberof TRLinkManualDecisionDestinationDetail */ diff --git a/models/trlink-manual-decision-request.ts b/models/trlink-manual-decision-request.ts index dd1f315f..95209ddc 100644 --- a/models/trlink-manual-decision-request.ts +++ b/models/trlink-manual-decision-request.ts @@ -18,7 +18,7 @@ import { TRLinkManualDecisionAction } from './trlink-manual-decision-action'; /** - * Request to manually accept or reject destinations stuck in NoTRM status + * Request to manually accept or reject destinations waiting for a Travel Rule message (missing TRM) * @export * @interface TRLinkManualDecisionRequest */ diff --git a/models/trlink-manual-decision-response-status-enum.ts b/models/trlink-manual-decision-response-status-enum.ts new file mode 100644 index 00000000..102792ad --- /dev/null +++ b/models/trlink-manual-decision-response-status-enum.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. + */ + + + +/** + * APPLIED - Decision applied to at least one destination immediately. ACCEPTED - Intent stored for deferred apply on the next processing attempt. PRE_ACCEPTED - Intent stored on the transaction before destinations entered the missing-TRM wait. + * @export + * @enum {string} + */ + +export const TRLinkManualDecisionResponseStatusEnum = { + Applied: 'APPLIED', + Accepted: 'ACCEPTED', + PreAccepted: 'PRE_ACCEPTED' +} as const; + +export type TRLinkManualDecisionResponseStatusEnum = typeof TRLinkManualDecisionResponseStatusEnum[keyof typeof TRLinkManualDecisionResponseStatusEnum]; + + + diff --git a/models/trlink-manual-decision-response.ts b/models/trlink-manual-decision-response.ts index 6dc966aa..8d58d15a 100644 --- a/models/trlink-manual-decision-response.ts +++ b/models/trlink-manual-decision-response.ts @@ -21,14 +21,23 @@ import { TRLinkManualDecisionAction } from './trlink-manual-decision-action'; import { TRLinkManualDecisionDestinationDetail } from './trlink-manual-decision-destination-detail'; // May contain unused imports in some cases // @ts-ignore +import { TRLinkManualDecisionResponseStatusEnum } from './trlink-manual-decision-response-status-enum'; +// May contain unused imports in some cases +// @ts-ignore import { TRLinkManualDecisionSource } from './trlink-manual-decision-source'; /** - * Response containing the result of the manual decision + * Response containing the result of a manual missing-TRM decision (POST write or GET read). * @export * @interface TRLinkManualDecisionResponse */ export interface TRLinkManualDecisionResponse { + /** + * + * @type {TRLinkManualDecisionResponseStatusEnum} + * @memberof TRLinkManualDecisionResponse + */ + 'status': TRLinkManualDecisionResponseStatusEnum; /** * * @type {TRLinkManualDecisionAction} diff --git a/models/trlink-manual-decision-source.ts b/models/trlink-manual-decision-source.ts index 2114388b..4e614682 100644 --- a/models/trlink-manual-decision-source.ts +++ b/models/trlink-manual-decision-source.ts @@ -15,14 +15,14 @@ /** - * Source of the manual decision + * Source of the manual decision. Values are lowercase. * @export * @enum {string} */ export const TRLinkManualDecisionSource = { - Manual: 'MANUAL', - Policy: 'POLICY' + Manual: 'manual', + Policy: 'policy' } as const; export type TRLinkManualDecisionSource = typeof TRLinkManualDecisionSource[keyof typeof TRLinkManualDecisionSource]; diff --git a/models/typed-message-transaction-status-enum.ts b/models/typed-message-transaction-status-enum.ts index 901a12c6..720f88a0 100644 --- a/models/typed-message-transaction-status-enum.ts +++ b/models/typed-message-transaction-status-enum.ts @@ -27,9 +27,11 @@ export const TypedMessageTransactionStatusEnum = { PendingAuthorization: 'PENDING_AUTHORIZATION', Pending3RdPartyManualApproval: 'PENDING_3RD_PARTY_MANUAL_APPROVAL', Pending3RdParty: 'PENDING_3RD_PARTY', + Signed: 'SIGNED', Broadcasting: 'BROADCASTING', PendingAmlScreening: 'PENDING_AML_SCREENING', Confirming: 'CONFIRMING', + Completed: 'COMPLETED', PartiallyCompleted: 'PARTIALLY_COMPLETED', PendingEmailApproval: 'PENDING_EMAIL_APPROVAL', Cancelled: 'CANCELLED', diff --git a/models/validation-key-dto.ts b/models/validation-key-dto.ts index c4b1460f..64862cdb 100644 --- a/models/validation-key-dto.ts +++ b/models/validation-key-dto.ts @@ -50,5 +50,17 @@ export interface ValidationKeyDto { * @memberof ValidationKeyDto */ 'createdAt': number; + /** + * Expiration date (Unix timestamp) in milliseconds. + * @type {number} + * @memberof ValidationKeyDto + */ + 'expirationTime': number; + /** + * True if the validation key is revoked. + * @type {boolean} + * @memberof ValidationKeyDto + */ + 'revoked': boolean; } diff --git a/package-lock.json b/package-lock.json index c6173d89..ea318f4e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@fireblocks/ts-sdk", - "version": "35.2.0", + "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@fireblocks/ts-sdk", - "version": "35.2.0", + "version": "0.0.0", "license": "MIT License", "dependencies": { "axios": "^1.15.2", @@ -1294,9 +1294,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.11.27", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.27.tgz", - "integrity": "sha512-ElY12DaROGuan+lMmZ8Cvo/ZUbXPe7Enc/9VU/b1T3Kp4dwytRcNdR8DoSJN5SNJT/CuvcCA0DHDVmMOCePdRQ==", + "version": "2.11.28", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.28.tgz", + "integrity": "sha512-br0LOmjJqr6Rt4AEkadbcNf67Zpo7EPwKsWbjnRrJIa1QYFHQBqM4C7F2WTbV8ahTEcg1Eo+Y0aWjjORInYFyA==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1378,11 +1378,11 @@ } }, "node_modules/bser": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz", - "integrity": "sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.2.tgz", + "integrity": "sha512-V2o8YS2EhrKMO9AumnkK0ynynfFlsajpYupwq7S46H5mhcanwxDkNTw3K67wPIcKTH1ffkA4vhMOtAc7gRmPZw==", "dev": true, - "license": "Apache-2.0", + "license": "MIT", "dependencies": { "node-int64": "^0.4.0" } @@ -1434,9 +1434,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001815", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001815.tgz", - "integrity": "sha512-uDybUEyfgbyJJ93J1vikTylBX31AkdVYeVPeffMQpf8XN7hSfr0oZOn4VFOIMNvtU5+rHvC5Udg2TgtJKHm23Q==", + "version": "1.0.30001816", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001816.tgz", + "integrity": "sha512-+8Yx7BXCoqk6IF8yTicjfUR6D/ldJzdlsodlEOiOSPmhK844WIgk67/zIQaGAOxNkZyyvBlrRFnLvqKIoqbAFw==", "dev": true, "funding": [ { @@ -1715,9 +1715,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.451", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.451.tgz", - "integrity": "sha512-vUNKPrUzw8ByEMOxloq0a71iD/mPuPxVkbDm3G5YhnxTzOw/I6qAg2MUS0cYj/c267lWmw26yW4Vv7foxTxPLg==", + "version": "1.5.456", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.456.tgz", + "integrity": "sha512-8hboqI6xesozteFb8aa7OGknvxUtTeRJLz0FoePysUEh/oWbddykIGdgpEJRbPRg/nIMfBf2DFos+H2MtvJl2A==", "dev": true, "license": "ISC" }, @@ -1888,13 +1888,13 @@ "license": "MIT" }, "node_modules/fb-watchman": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", - "integrity": "sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA==", + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.4.tgz", + "integrity": "sha512-tGQtaoYisPDriJBN0mT5yZSyNETnJGA1gTYxaVRAE5KUO3LI9kPUc9WIu8JXcxaIci+faIKlzXqXyPgrmubtBQ==", "dev": true, - "license": "Apache-2.0", + "license": "MIT", "dependencies": { - "bser": "2.1.1" + "bser": "2.1.2" } }, "node_modules/fill-range": { @@ -3371,9 +3371,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.57", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.57.tgz", - "integrity": "sha512-kQK9LGGFiHtrWiNhZtA7Qbw17AQz+dmsEKODRIVTXA9+e5MS/2gZEBhYJt13GrAz5/IOZKddH/0Z3TP/Zgo+yw==", + "version": "2.0.58", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.58.tgz", + "integrity": "sha512-BdiKAgbfRlvfMq/XzO/AF9NPmaA8a+YpLAyAFTVFBj3gARrAIfWvNq7Q7NE4se3KgFu0KkrvQMxTS0XVnsGzHg==", "dev": true, "license": "MIT", "engines": { @@ -3720,9 +3720,9 @@ } }, "node_modules/resolve.exports": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.3.tgz", - "integrity": "sha512-OcXjMsGdhL4XnbShKpAcSqPMzQoYkYyhbEaeSko47MjRP9NfEQMhZkXL1DoFlt9LWQn4YttrdnV6X2OiyzBi+A==", + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.4.tgz", + "integrity": "sha512-zepuGL0ulf+nt+XaFrlKeaiTJeyPFPLLY62+ncq1/VTHBdt3HsfXOH60priZ6tnXQozdGcDeIF5JVTanvIcYWQ==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index caaa3169..584251d5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fireblocks/ts-sdk", - "version": "35.2.0", + "version": "0.0.0", "description": "OpenAPI client for @fireblocks/ts-sdk", "author": "Fireblocks SDK Generator", "repository": { diff --git a/tests/client.spec.ts b/tests/client.spec.ts index dce0fdf5..2444dd5a 100644 --- a/tests/client.spec.ts +++ b/tests/client.spec.ts @@ -26,7 +26,7 @@ ContactsApi, ContractInteractionsApi, ContractTemplatesApi, ContractsApi, -CosignersBetaApi, +CosignersApi, DeployedContractsApi, EarnApi, EmbeddedWalletsApi, @@ -36,8 +36,8 @@ FiatAccountsApi, GasStationsApi, GenieBetaApi, InternalWalletsApi, -KeyLinkBetaApi, -KeysBetaApi, +KeyLinkApi, +KeysApi, NFTsApi, NetworkConnectionsApi, OTABetaApi, @@ -89,7 +89,7 @@ let mockContactsApi: jest.Mock; let mockContractInteractionsApi: jest.Mock; let mockContractTemplatesApi: jest.Mock; let mockContractsApi: jest.Mock; -let mockCosignersBetaApi: jest.Mock; +let mockCosignersApi: jest.Mock; let mockDeployedContractsApi: jest.Mock; let mockEarnApi: jest.Mock; let mockEmbeddedWalletsApi: jest.Mock; @@ -99,8 +99,8 @@ let mockFiatAccountsApi: jest.Mock; let mockGasStationsApi: jest.Mock; let mockGenieBetaApi: jest.Mock; let mockInternalWalletsApi: jest.Mock; -let mockKeyLinkBetaApi: jest.Mock; -let mockKeysBetaApi: jest.Mock; +let mockKeyLinkApi: jest.Mock; +let mockKeysApi: jest.Mock; let mockNFTsApi: jest.Mock; let mockNetworkConnectionsApi: jest.Mock; let mockOTABetaApi: jest.Mock; @@ -149,7 +149,7 @@ jest.mock('../api', () => { mockContractInteractionsApi = jest.fn(); mockContractTemplatesApi = jest.fn(); mockContractsApi = jest.fn(); - mockCosignersBetaApi = jest.fn(); + mockCosignersApi = jest.fn(); mockDeployedContractsApi = jest.fn(); mockEarnApi = jest.fn(); mockEmbeddedWalletsApi = jest.fn(); @@ -159,8 +159,8 @@ jest.mock('../api', () => { mockGasStationsApi = jest.fn(); mockGenieBetaApi = jest.fn(); mockInternalWalletsApi = jest.fn(); - mockKeyLinkBetaApi = jest.fn(); - mockKeysBetaApi = jest.fn(); + mockKeyLinkApi = jest.fn(); + mockKeysApi = jest.fn(); mockNFTsApi = jest.fn(); mockNetworkConnectionsApi = jest.fn(); mockOTABetaApi = jest.fn(); @@ -210,7 +210,7 @@ jest.mock('../api', () => { ContractInteractionsApi: mockContractInteractionsApi, ContractTemplatesApi: mockContractTemplatesApi, ContractsApi: mockContractsApi, - CosignersBetaApi: mockCosignersBetaApi, + CosignersApi: mockCosignersApi, DeployedContractsApi: mockDeployedContractsApi, EarnApi: mockEarnApi, EmbeddedWalletsApi: mockEmbeddedWalletsApi, @@ -220,8 +220,8 @@ jest.mock('../api', () => { GasStationsApi: mockGasStationsApi, GenieBetaApi: mockGenieBetaApi, InternalWalletsApi: mockInternalWalletsApi, - KeyLinkBetaApi: mockKeyLinkBetaApi, - KeysBetaApi: mockKeysBetaApi, + KeyLinkApi: mockKeyLinkApi, + KeysApi: mockKeysApi, NFTsApi: mockNFTsApi, NetworkConnectionsApi: mockNetworkConnectionsApi, OTABetaApi: mockOTABetaApi, @@ -392,9 +392,9 @@ describe("Fireblocks Client Tests", () => { expect(fireblocks.contracts).toBeInstanceOf(ContractsApi); expect(mockContractsApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); - it('Should return CosignersBetaApi', async () => { - expect(fireblocks.cosignersBeta).toBeInstanceOf(CosignersBetaApi); - expect(mockCosignersBetaApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); + it('Should return CosignersApi', async () => { + expect(fireblocks.cosigners).toBeInstanceOf(CosignersApi); + expect(mockCosignersApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); it('Should return DeployedContractsApi', async () => { expect(fireblocks.deployedContracts).toBeInstanceOf(DeployedContractsApi); @@ -432,13 +432,13 @@ describe("Fireblocks Client Tests", () => { expect(fireblocks.internalWallets).toBeInstanceOf(InternalWalletsApi); expect(mockInternalWalletsApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); - it('Should return KeyLinkBetaApi', async () => { - expect(fireblocks.keyLinkBeta).toBeInstanceOf(KeyLinkBetaApi); - expect(mockKeyLinkBetaApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); + it('Should return KeyLinkApi', async () => { + expect(fireblocks.keyLink).toBeInstanceOf(KeyLinkApi); + expect(mockKeyLinkApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); - it('Should return KeysBetaApi', async () => { - expect(fireblocks.keysBeta).toBeInstanceOf(KeysBetaApi); - expect(mockKeysBetaApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); + it('Should return KeysApi', async () => { + expect(fireblocks.keys).toBeInstanceOf(KeysApi); + expect(mockKeysApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); it('Should return NFTsApi', async () => { expect(fireblocks.nfts).toBeInstanceOf(NFTsApi); diff --git a/tests/lifecycleWarning.spec.ts b/tests/lifecycleWarning.spec.ts index 344532c8..ab2011f2 100644 --- a/tests/lifecycleWarning.spec.ts +++ b/tests/lifecycleWarning.spec.ts @@ -12,6 +12,8 @@ import { + BETA_STATE, + EA_STATE, LIFECYCLE_STATE_HEADER, LINK_HEADER, OPERATION_ID_CONFIG_KEY, @@ -20,6 +22,7 @@ import { buildLifecycleWarning, isSuppressed, operationIdFromConfig, + WARNING_STATES, warnOnLifecycleState, } from '../utils/lifecycleWarning'; @@ -59,20 +62,20 @@ describe('lifecycleWarning', () => { describe('emission', () => { it('emits one warning for a non-GA state', () => { - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); expect(consoleWarn).toHaveBeenCalledTimes(1); expect(consoleWarn.mock.calls[0][0]).toContain('createTransaction'); - expect(consoleWarn.mock.calls[0][0]).toContain('beta'); + expect(consoleWarn.mock.calls[0][0]).toContain('EA (Early Availability)'); }); it('emits per execution, not once per operation', () => { - warnOnLifecycleState(headers('beta'), 'createTransaction'); - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); expect(consoleWarn).toHaveBeenCalledTimes(2); }); it('emits for each distinct operation', () => { - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); warnOnLifecycleState(headers('closed'), 'getVaultAccount', 200); expect(consoleWarn).toHaveBeenCalledTimes(2); }); @@ -83,7 +86,8 @@ describe('lifecycleWarning', () => { 'ga', 'internal', 'unlisted', - 'private_beta', // the old name for beta: no longer recognised + 'beta', // retired names for ea: no longer recognised + 'private_beta', 'quantum_preview', '', ' ', @@ -106,13 +110,13 @@ describe('lifecycleWarning', () => { }); it('stays silent without an operation id', () => { - warnOnLifecycleState(headers('beta'), undefined); + warnOnLifecycleState(headers('ea'), undefined); expect(consoleWarn).not.toHaveBeenCalled(); }); it('does not throw when console.warn itself throws', () => { consoleWarn.mockImplementation(() => { throw new Error('console is patched badly'); }); - expect(() => warnOnLifecycleState(headers('beta'), 'op')).not.toThrow(); + expect(() => warnOnLifecycleState(headers('ea'), 'op')).not.toThrow(); }); }); @@ -127,13 +131,14 @@ describe('lifecycleWarning', () => { 'fireblocks-lifecycle-state', 'FIREBLOCKS-LIFECYCLE-STATE', ])('looks the header name up case-insensitively: %s', (name) => { - expect(buildLifecycleWarning({ [name]: 'beta' }, 'op')).toBeDefined(); + expect(buildLifecycleWarning({ [name]: 'ea' }, 'op')).toBeDefined(); }); - it('renders the state verbatim as snake_case', () => { - const message = buildLifecycleWarning(headers('beta'), 'op'); - expect(message).toContain("'beta'"); - expect(message).not.toContain('Private Beta'); + it('names the state as EA', () => { + const message = buildLifecycleWarning(headers('ea'), 'op'); + expect(message).toContain('EA (Early Availability)'); + expect(message).not.toContain("'ea'"); + expect(message?.toLowerCase()).not.toContain('beta'); }); }); @@ -273,21 +278,21 @@ describe('lifecycleWarning', () => { ); }); - describe('beta wording, closed handling and HTTP status', () => { - const BETA_TEXT = - "Operation 'op' is in 'beta' lifecycle state and is not generally available." - + ' It may change or be removed without notice.'; + describe('EA wording, closed handling and HTTP status', () => { + const EA_TEXT = + "Operation 'op' is in EA (Early Availability) and is not generally available." + + ' It may change or break before it reaches GA.'; const CLOSED_TEXT = "Operation 'op' has been closed and is no longer supported." + ' Your access is provided under a temporary exception and may be revoked.' + ' Contact your Customer Success Manager for migration support'; - it('uses the beta message text', () => { - expect(buildLifecycleWarning(headers('beta'), 'op')).toBe(BETA_TEXT); + it('uses the EA message text', () => { + expect(buildLifecycleWarning(headers('ea'), 'op')).toBe(EA_TEXT); }); - it.each([undefined, 200, 400, 403, 500])('beta warns for status %p', (status) => { - expect(buildLifecycleWarning(headers('beta'), 'op', status)).toBe(BETA_TEXT); + it.each([undefined, 200, 400, 403, 500])('EA warns for status %p', (status) => { + expect(buildLifecycleWarning(headers('ea'), 'op', status)).toBe(EA_TEXT); }); it('is silent for closed with 410', () => { @@ -350,20 +355,28 @@ describe('lifecycleWarning', () => { it.each(['1', 'true', 'yes'])('suppresses when set to %p', (value) => { process.env[SUPPRESS_ENV_VAR] = value; - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); expect(consoleWarn).not.toHaveBeenCalled(); }); it.each(['0', 'false', ''])('does not suppress when set to %p', (value) => { process.env[SUPPRESS_ENV_VAR] = value; - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); expect(consoleWarn).toHaveBeenCalledTimes(1); }); it('does not suppress when unset', () => { delete process.env[SUPPRESS_ENV_VAR]; - warnOnLifecycleState(headers('beta'), 'createTransaction'); + warnOnLifecycleState(headers('ea'), 'createTransaction'); expect(consoleWarn).toHaveBeenCalledTimes(1); }); }); }); + +describe('deprecated BETA_STATE alias', () => { + it('is still exported but no longer warns', () => { + expect(BETA_STATE).toBe('beta'); + expect(WARNING_STATES.has(BETA_STATE)).toBe(false); + expect(WARNING_STATES.has(EA_STATE)).toBe(true); + }); +}); diff --git a/utils/lifecycleWarning.ts b/utils/lifecycleWarning.ts index 13e106b1..d3acd14e 100644 --- a/utils/lifecycleWarning.ts +++ b/utils/lifecycleWarning.ts @@ -21,10 +21,12 @@ export const LINK_HEADER = 'link'; /** Key under which the param creator stamps the operation onto the request config. */ export const OPERATION_ID_CONFIG_KEY = 'fireblocksOperationId'; +export const EA_STATE = 'ea'; +/** @deprecated Use EA_STATE. The beta lifecycle state was renamed to ea and no longer warns. */ export const BETA_STATE = 'beta'; export const DEPRECATED_STATE = 'deprecated'; export const CLOSED_STATE = 'closed'; -export const WARNING_STATES: ReadonlySet = new Set([BETA_STATE, DEPRECATED_STATE, CLOSED_STATE]); +export const WARNING_STATES: ReadonlySet = new Set([EA_STATE, DEPRECATED_STATE, CLOSED_STATE]); // The gateway answers a closed operation with 410 Gone to every caller without a // temporary exception. That response already says what happened, so no warning. @@ -106,9 +108,9 @@ export function buildLifecycleWarning( return undefined; } - if (state === BETA_STATE) { - return `Operation '${operationId}' is in 'beta' lifecycle state and is not generally available.` - + ' It may change or be removed without notice.'; + if (state === EA_STATE) { + return `Operation '${operationId}' is in EA (Early Availability) and is not generally available.` + + ' It may change or break before it reaches GA.'; } if (state === CLOSED_STATE) {