diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 4d61cb0..8262d81 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -57,6 +57,7 @@ AddressRegistryAddVaultOptOutsRequestVaultAccountIdsInner.md AddressRegistryAddVaultOptOutsResponse.md AddressRegistryCreateProofOfOwnershipRequest.md AddressRegistryCreateProofOfOwnershipResponse.md +AddressRegistryCustomerRegistryResponse.md AddressRegistryGetVaultOptOutResponse.md AddressRegistryLegalEntity.md AddressRegistryListVaultOptOutsResponse.md @@ -851,6 +852,7 @@ PostalAddress.md PreScreening.md PrefundedSettlement.md PrefundedSettlementType.md +PricingSide.md ProgramCallConfig.md ProgramCallDecodedDataItem.md ProgramCallInstructionData.md @@ -1059,6 +1061,7 @@ SolanaInstruction.md SolanaInstructionWithValue.md SolanaRewardsBreakdown.md SolanaSimpleCreateParams.md +SorobanCallData.md SourceConfig.md SourceOfFunds.md SourceTransferPeerPath.md @@ -1564,6 +1567,7 @@ models/address-registry-add-vault-opt-outs-request.ts models/address-registry-add-vault-opt-outs-response.ts models/address-registry-create-proof-of-ownership-request.ts models/address-registry-create-proof-of-ownership-response.ts +models/address-registry-customer-registry-response.ts models/address-registry-get-vault-opt-out-response.ts models/address-registry-legal-entity.ts models/address-registry-list-vault-opt-outs-response.ts @@ -2324,6 +2328,7 @@ models/postal-address.ts models/pre-screening.ts models/prefunded-settlement-type.ts models/prefunded-settlement.ts +models/pricing-side.ts models/program-call-config.ts models/program-call-decoded-data-item.ts models/program-call-instruction-data.ts @@ -2527,6 +2532,7 @@ models/solana-instruction-with-value.ts models/solana-instruction.ts models/solana-rewards-breakdown.ts models/solana-simple-create-params.ts +models/soroban-call-data.ts models/source-config.ts models/source-of-funds.ts models/source-transfer-peer-path-response.ts diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 276ced6..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,258 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [v35.1.0](https://github.com/fireblocks/ts-sdk/compare/v19.0.0...v35.1.0) - 2026-10-20 - -### Merged - -- Generated SDK #2966549409 [`#214`](https://github.com/fireblocks/ts-sdk/pull/214) - -## [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 80d71a6..360cedd 100644 --- a/README.md +++ b/README.md @@ -198,7 +198,8 @@ Class | Method | HTTP request | Description *ComplianceApi* | [**deactivateByorkConfig**](docs/apis/ComplianceApi.md#deactivateByorkConfig) | **POST** /screening/byork/config/deactivate | Deactivate BYORK Light *ComplianceApi* | [**deleteCounterpartyGroup**](docs/apis/ComplianceApi.md#deleteCounterpartyGroup) | **DELETE** /counterparty_groups/{groupId} | Delete a counterparty group *ComplianceApi* | [**deleteLegalEntity**](docs/apis/ComplianceApi.md#deleteLegalEntity) | **DELETE** /legal_entities/{legalEntityId} | Delete a legal entity -*ComplianceApi* | [**getAddressRegistryTenantParticipationStatus**](docs/apis/ComplianceApi.md#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry participation status for the authenticated workspace +*ComplianceApi* | [**getAddressRegistryCustomerParticipationStatus**](docs/apis/ComplianceApi.md#getAddressRegistryCustomerParticipationStatus) | **GET** /address_registry/customer | Get your customer\'s address registry default +*ComplianceApi* | [**getAddressRegistryTenantParticipationStatus**](docs/apis/ComplianceApi.md#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry status for this workspace *ComplianceApi* | [**getAddressRegistryVaultOptOut**](docs/apis/ComplianceApi.md#getAddressRegistryVaultOptOut) | **GET** /address_registry/vaults/{vaultAccountId} | Get whether a vault account is opted out of the address registry *ComplianceApi* | [**getAmlPostScreeningPolicy**](docs/apis/ComplianceApi.md#getAmlPostScreeningPolicy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy *ComplianceApi* | [**getAmlScreeningPolicy**](docs/apis/ComplianceApi.md#getAmlScreeningPolicy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy @@ -214,8 +215,10 @@ Class | Method | HTTP request | Description *ComplianceApi* | [**listCounterpartyGroups**](docs/apis/ComplianceApi.md#listCounterpartyGroups) | **GET** /counterparty_groups | List counterparty groups *ComplianceApi* | [**listLegalEntities**](docs/apis/ComplianceApi.md#listLegalEntities) | **GET** /legal_entities | List legal entities (Paginated) *ComplianceApi* | [**listVaultsForLegalEntity**](docs/apis/ComplianceApi.md#listVaultsForLegalEntity) | **GET** /legal_entities/{legalEntityId}/vaults | List vault accounts for a legal entity (Paginated) -*ComplianceApi* | [**optInAddressRegistryTenant**](docs/apis/ComplianceApi.md#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt the workspace in to the address registry -*ComplianceApi* | [**optOutAddressRegistryTenant**](docs/apis/ComplianceApi.md#optOutAddressRegistryTenant) | **DELETE** /address_registry/tenant | Opt the workspace out of the address registry +*ComplianceApi* | [**optInAddressRegistryCustomer**](docs/apis/ComplianceApi.md#optInAddressRegistryCustomer) | **POST** /address_registry/customer | Opt your customer in to the address registry +*ComplianceApi* | [**optInAddressRegistryTenant**](docs/apis/ComplianceApi.md#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt this workspace in to the address registry +*ComplianceApi* | [**optOutAddressRegistryCustomer**](docs/apis/ComplianceApi.md#optOutAddressRegistryCustomer) | **DELETE** /address_registry/customer | Opt your customer out of the address registry +*ComplianceApi* | [**optOutAddressRegistryTenant**](docs/apis/ComplianceApi.md#optOutAddressRegistryTenant) | **DELETE** /address_registry/tenant | Opt this workspace out of the address registry *ComplianceApi* | [**registerLegalEntity**](docs/apis/ComplianceApi.md#registerLegalEntity) | **POST** /legal_entities | Register a new legal entity *ComplianceApi* | [**removeAddressRegistryVaultOptOut**](docs/apis/ComplianceApi.md#removeAddressRegistryVaultOptOut) | **DELETE** /address_registry/vaults/{vaultAccountId} | Remove a single vault account from the address registry opt-out list *ComplianceApi* | [**removeAllAddressRegistryVaultOptOuts**](docs/apis/ComplianceApi.md#removeAllAddressRegistryVaultOptOuts) | **DELETE** /address_registry/vaults | Remove all vault-level address registry opt-outs for the workspace @@ -708,6 +711,7 @@ Class | Method | HTTP request | Description - [AddressRegistryAddVaultOptOutsResponse](docs/models/AddressRegistryAddVaultOptOutsResponse.md) - [AddressRegistryCreateProofOfOwnershipRequest](docs/models/AddressRegistryCreateProofOfOwnershipRequest.md) - [AddressRegistryCreateProofOfOwnershipResponse](docs/models/AddressRegistryCreateProofOfOwnershipResponse.md) + - [AddressRegistryCustomerRegistryResponse](docs/models/AddressRegistryCustomerRegistryResponse.md) - [AddressRegistryGetVaultOptOutResponse](docs/models/AddressRegistryGetVaultOptOutResponse.md) - [AddressRegistryLegalEntity](docs/models/AddressRegistryLegalEntity.md) - [AddressRegistryListVaultOptOutsResponse](docs/models/AddressRegistryListVaultOptOutsResponse.md) @@ -1465,6 +1469,7 @@ Class | Method | HTTP request | Description - [PreScreening](docs/models/PreScreening.md) - [PrefundedSettlement](docs/models/PrefundedSettlement.md) - [PrefundedSettlementType](docs/models/PrefundedSettlementType.md) + - [PricingSide](docs/models/PricingSide.md) - [ProgramCallConfig](docs/models/ProgramCallConfig.md) - [ProgramCallDecodedDataItem](docs/models/ProgramCallDecodedDataItem.md) - [ProgramCallInstructionData](docs/models/ProgramCallInstructionData.md) @@ -1668,6 +1673,7 @@ Class | Method | HTTP request | Description - [SolanaInstructionWithValue](docs/models/SolanaInstructionWithValue.md) - [SolanaRewardsBreakdown](docs/models/SolanaRewardsBreakdown.md) - [SolanaSimpleCreateParams](docs/models/SolanaSimpleCreateParams.md) + - [SorobanCallData](docs/models/SorobanCallData.md) - [SourceConfig](docs/models/SourceConfig.md) - [SourceOfFunds](docs/models/SourceOfFunds.md) - [SourceTransferPeerPath](docs/models/SourceTransferPeerPath.md) diff --git a/api/compliance-api.ts b/api/compliance-api.ts index 03ca1a1..e9249bf 100644 --- a/api/compliance-api.ts +++ b/api/compliance-api.ts @@ -35,6 +35,8 @@ import { AddressRegistryCreateProofOfOwnershipRequest } from '../models'; // @ts-ignore import { AddressRegistryCreateProofOfOwnershipResponse } from '../models'; // @ts-ignore +import { AddressRegistryCustomerRegistryResponse } from '../models'; +// @ts-ignore import { AddressRegistryGetVaultOptOutResponse } from '../models'; // @ts-ignore import { AddressRegistryLegalEntity } from '../models'; @@ -524,8 +526,42 @@ export const ComplianceApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. - * @summary Get address registry participation status for the authenticated workspace + * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. + * @summary Get your customer\'s address registry default + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddressRegistryCustomerParticipationStatus: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/address_registry/customer`; + // 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 = 'getAddressRegistryCustomerParticipationStatus'; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. + * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1142,8 +1178,47 @@ export const ComplianceApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. - * @summary Opt the workspace in to the address registry + * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer in to the address registry + * @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} + */ + optInAddressRegistryCustomer: async (idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/address_registry/customer`; + // 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 = 'optInAddressRegistryCustomer'; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (idempotencyKey != null) { + localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. + * @summary Opt this workspace in to the address registry * @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} @@ -1181,8 +1256,42 @@ export const ComplianceApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. - * @summary Opt the workspace out of the address registry + * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer out of the address registry + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + optOutAddressRegistryCustomer: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/address_registry/customer`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + // 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 = 'optOutAddressRegistryCustomer'; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. + * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1955,8 +2064,20 @@ export const ComplianceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. - * @summary Get address registry participation status for the authenticated workspace + * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. + * @summary Get your customer\'s address registry default + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAddressRegistryCustomerParticipationStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAddressRegistryCustomerParticipationStatus(options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ComplianceApi.getAddressRegistryCustomerParticipationStatus']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. + * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2164,8 +2285,21 @@ export const ComplianceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. - * @summary Opt the workspace in to the address registry + * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer in to the address registry + * @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 optInAddressRegistryCustomer(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.optInAddressRegistryCustomer(idempotencyKey, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ComplianceApi.optInAddressRegistryCustomer']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. + * @summary Opt this workspace in to the address registry * @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} @@ -2177,8 +2311,20 @@ export const ComplianceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. - * @summary Opt the workspace out of the address registry + * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer out of the address registry + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async optOutAddressRegistryCustomer(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.optOutAddressRegistryCustomer(options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ComplianceApi.optOutAddressRegistryCustomer']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. + * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2493,8 +2639,17 @@ export const ComplianceApiFactory = function (configuration?: Configuration, bas return localVarFp.deleteLegalEntity(requestParameters.legalEntityId, options).then((request) => request(axios, basePath)); }, /** - * Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. - * @summary Get address registry participation status for the authenticated workspace + * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. + * @summary Get your customer\'s address registry default + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddressRegistryCustomerParticipationStatus(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAddressRegistryCustomerParticipationStatus(options).then((request) => request(axios, basePath)); + }, + /** + * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. + * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2647,8 +2802,18 @@ export const ComplianceApiFactory = function (configuration?: Configuration, bas return localVarFp.listVaultsForLegalEntity(requestParameters.legalEntityId, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath)); }, /** - * Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. - * @summary Opt the workspace in to the address registry + * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer in to the address registry + * @param {ComplianceApiOptInAddressRegistryCustomerRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + optInAddressRegistryCustomer(requestParameters: ComplianceApiOptInAddressRegistryCustomerRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.optInAddressRegistryCustomer(requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + }, + /** + * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. + * @summary Opt this workspace in to the address registry * @param {ComplianceApiOptInAddressRegistryTenantRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2657,8 +2822,17 @@ export const ComplianceApiFactory = function (configuration?: Configuration, bas return localVarFp.optInAddressRegistryTenant(requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. - * @summary Opt the workspace out of the address registry + * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer out of the address registry + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + optOutAddressRegistryCustomer(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.optOutAddressRegistryCustomer(options).then((request) => request(axios, basePath)); + }, + /** + * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. + * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3171,6 +3345,20 @@ export interface ComplianceApiListVaultsForLegalEntityRequest { readonly pageSize?: number } +/** + * Request parameters for optInAddressRegistryCustomer operation in ComplianceApi. + * @export + * @interface ComplianceApiOptInAddressRegistryCustomerRequest + */ +export interface ComplianceApiOptInAddressRegistryCustomerRequest { + /** + * 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 ComplianceApiOptInAddressRegistryCustomer + */ + readonly idempotencyKey?: string +} + /** * Request parameters for optInAddressRegistryTenant operation in ComplianceApi. * @export @@ -3586,8 +3774,19 @@ export class ComplianceApi extends BaseAPI { } /** - * Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. - * @summary Get address registry participation status for the authenticated workspace + * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. + * @summary Get your customer\'s address registry default + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ComplianceApi + */ + public getAddressRegistryCustomerParticipationStatus() { + return ComplianceApiFp(this.configuration).getAddressRegistryCustomerParticipationStatus().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. + * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi @@ -3772,8 +3971,20 @@ export class ComplianceApi extends BaseAPI { } /** - * Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. - * @summary Opt the workspace in to the address registry + * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer in to the address registry + * @param {ComplianceApiOptInAddressRegistryCustomerRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ComplianceApi + */ + public optInAddressRegistryCustomer(requestParameters: ComplianceApiOptInAddressRegistryCustomerRequest = {}) { + return ComplianceApiFp(this.configuration).optInAddressRegistryCustomer(requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. + * @summary Opt this workspace in to the address registry * @param {ComplianceApiOptInAddressRegistryTenantRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3784,8 +3995,19 @@ export class ComplianceApi extends BaseAPI { } /** - * Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. - * @summary Opt the workspace out of the address registry + * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + * @summary Opt your customer out of the address registry + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ComplianceApi + */ + public optOutAddressRegistryCustomer() { + return ComplianceApiFp(this.configuration).optOutAddressRegistryCustomer().then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + } + + /** + * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. + * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi diff --git a/api/trading-api.ts b/api/trading-api.ts index a4fb294..b97635f 100644 --- a/api/trading-api.ts +++ b/api/trading-api.ts @@ -109,7 +109,7 @@ export const TradingApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get quotes for each side the provider supports in a single call; providers that support only one side return that side only. Every returned quote carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Create a quote * @param {CreateQuote} createQuote * @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. @@ -153,7 +153,7 @@ export const TradingApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get offers for each side the provider supports in a single call; providers that support only one side return that side only. Every returned offer carries a concrete `BUY` or `SELL` side, never `BOTH`. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get all offers * @param {CreateOffersRequest} createOffersRequest * @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. @@ -197,7 +197,7 @@ export const TradingApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get rates * @param {RatesRequest} ratesRequest * @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. @@ -605,7 +605,7 @@ export const TradingApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get quotes for each side the provider supports in a single call; providers that support only one side return that side only. Every returned quote carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Create a quote * @param {CreateQuote} createQuote * @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. @@ -619,7 +619,7 @@ export const TradingApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get offers for each side the provider supports in a single call; providers that support only one side return that side only. Every returned offer carries a concrete `BUY` or `SELL` side, never `BOTH`. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get all offers * @param {CreateOffersRequest} createOffersRequest * @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. @@ -633,7 +633,7 @@ export const TradingApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get rates * @param {RatesRequest} ratesRequest * @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. @@ -772,7 +772,7 @@ export const TradingApiFactory = function (configuration?: Configuration, basePa return localVarFp.createOrder(requestParameters.createOrderRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get quotes for each side the provider supports in a single call; providers that support only one side return that side only. Every returned quote carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Create a quote * @param {TradingApiCreateQuoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -782,7 +782,7 @@ export const TradingApiFactory = function (configuration?: Configuration, basePa return localVarFp.createQuote(requestParameters.createQuote, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get offers for each side the provider supports in a single call; providers that support only one side return that side only. Every returned offer carries a concrete `BUY` or `SELL` side, never `BOTH`. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get all offers * @param {TradingApiFetchAllOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -792,7 +792,7 @@ export const TradingApiFactory = function (configuration?: Configuration, basePa return localVarFp.fetchAllOffers(requestParameters.createOffersRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get rates * @param {TradingApiFetchRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -1174,7 +1174,7 @@ export class TradingApi extends BaseAPI { } /** - * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get quotes for each side the provider supports in a single call; providers that support only one side return that side only. Every returned quote carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Create a quote * @param {TradingApiCreateQuoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -1186,7 +1186,7 @@ export class TradingApi extends BaseAPI { } /** - * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get offers for each side the provider supports in a single call; providers that support only one side return that side only. Every returned offer carries a concrete `BUY` or `SELL` side, never `BOTH`. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get all offers * @param {TradingApiFetchAllOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -1198,7 +1198,7 @@ export class TradingApi extends BaseAPI { } /** - * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). + * Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). * @summary Get rates * @param {TradingApiFetchRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/api/transactions-api.ts b/api/transactions-api.ts index a2a3063..6866e39 100644 --- a/api/transactions-api.ts +++ b/api/transactions-api.ts @@ -249,7 +249,7 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. + * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. * @summary Estimate transaction fee * @param {TransactionRequest} [transactionRequest] * @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. @@ -775,7 +775,7 @@ export const TransactionsApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. + * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. * @summary Estimate transaction fee * @param {TransactionRequest} [transactionRequest] * @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. @@ -967,7 +967,7 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b return localVarFp.estimateNetworkFee(requestParameters.assetId, options).then((request) => request(axios, basePath)); }, /** - * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. + * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. * @summary Estimate transaction fee * @param {TransactionsApiEstimateTransactionFeeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -1521,7 +1521,7 @@ export class TransactionsApi extends BaseAPI { } /** - * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. + * Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. * @summary Estimate transaction fee * @param {TransactionsApiEstimateTransactionFeeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/api/vaults-api.ts b/api/vaults-api.ts index c61947f..74e5d6b 100644 --- a/api/vaults-api.ts +++ b/api/vaults-api.ts @@ -790,7 +790,7 @@ export const VaultsApiAxiosParamCreator = function (configuration?: Configuratio /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction - * @param {string} vaultAccountId The ID of the vault account, or \'default\' for the default vault account + * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {boolean} [manualSignging] False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. * @param {Array} [includeAllLabels] Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager. This feature is currently in beta and might be subject to changes. @@ -2126,7 +2126,7 @@ export const VaultsApiFp = function(configuration?: Configuration) { /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction - * @param {string} vaultAccountId The ID of the vault account, or \'default\' for the default vault account + * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {boolean} [manualSignging] False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. * @param {Array} [includeAllLabels] Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager. This feature is currently in beta and might be subject to changes. @@ -3268,7 +3268,7 @@ export interface VaultsApiGetMaxBipIndexUsedRequest { */ export interface VaultsApiGetMaxSpendableAmountRequest { /** - * The ID of the vault account, or \'default\' for the default vault account + * The ID of the vault account * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ diff --git a/docs/apis/ComplianceApi.md b/docs/apis/ComplianceApi.md index e792941..b66bdc6 100644 --- a/docs/apis/ComplianceApi.md +++ b/docs/apis/ComplianceApi.md @@ -14,7 +14,8 @@ Method | HTTP request | Description [**deactivateByorkConfig**](#deactivateByorkConfig) | **POST** /screening/byork/config/deactivate | Deactivate BYORK Light [**deleteCounterpartyGroup**](#deleteCounterpartyGroup) | **DELETE** /counterparty_groups/{groupId} | Delete a counterparty group [**deleteLegalEntity**](#deleteLegalEntity) | **DELETE** /legal_entities/{legalEntityId} | Delete a legal entity -[**getAddressRegistryTenantParticipationStatus**](#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry participation status for the authenticated workspace +[**getAddressRegistryCustomerParticipationStatus**](#getAddressRegistryCustomerParticipationStatus) | **GET** /address_registry/customer | Get your customer\'s address registry default +[**getAddressRegistryTenantParticipationStatus**](#getAddressRegistryTenantParticipationStatus) | **GET** /address_registry/tenant | Get address registry status for this workspace [**getAddressRegistryVaultOptOut**](#getAddressRegistryVaultOptOut) | **GET** /address_registry/vaults/{vaultAccountId} | Get whether a vault account is opted out of the address registry [**getAmlPostScreeningPolicy**](#getAmlPostScreeningPolicy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy [**getAmlScreeningPolicy**](#getAmlScreeningPolicy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy @@ -30,8 +31,10 @@ Method | HTTP request | Description [**listCounterpartyGroups**](#listCounterpartyGroups) | **GET** /counterparty_groups | List counterparty groups [**listLegalEntities**](#listLegalEntities) | **GET** /legal_entities | List legal entities (Paginated) [**listVaultsForLegalEntity**](#listVaultsForLegalEntity) | **GET** /legal_entities/{legalEntityId}/vaults | List vault accounts for a legal entity (Paginated) -[**optInAddressRegistryTenant**](#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt the workspace in to the address registry -[**optOutAddressRegistryTenant**](#optOutAddressRegistryTenant) | **DELETE** /address_registry/tenant | Opt the workspace out of the address registry +[**optInAddressRegistryCustomer**](#optInAddressRegistryCustomer) | **POST** /address_registry/customer | Opt your customer in to the address registry +[**optInAddressRegistryTenant**](#optInAddressRegistryTenant) | **POST** /address_registry/tenant | Opt this workspace in to the address registry +[**optOutAddressRegistryCustomer**](#optOutAddressRegistryCustomer) | **DELETE** /address_registry/customer | Opt your customer out of the address registry +[**optOutAddressRegistryTenant**](#optOutAddressRegistryTenant) | **DELETE** /address_registry/tenant | Opt this workspace out of the address registry [**registerLegalEntity**](#registerLegalEntity) | **POST** /legal_entities | Register a new legal entity [**removeAddressRegistryVaultOptOut**](#removeAddressRegistryVaultOptOut) | **DELETE** /address_registry/vaults/{vaultAccountId} | Remove a single vault account from the address registry opt-out list [**removeAllAddressRegistryVaultOptOuts**](#removeAllAddressRegistryVaultOptOuts) | **DELETE** /address_registry/vaults | Remove all vault-level address registry opt-outs for the workspace @@ -678,10 +681,64 @@ 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) +# **getAddressRegistryCustomerParticipationStatus** +> AddressRegistryCustomerRegistryResponse getAddressRegistryCustomerParticipationStatus() + +Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, AddressRegistryCustomerRegistryResponse } from '@fireblocks/ts-sdk'; + +// Set the environment variables for authentication +process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1" +process.env.FIREBLOCKS_API_KEY = "my-api-key"; +process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8"); + +const fireblocks = new Fireblocks(); + +let body:any = {}; + +fireblocks.compliance.getAddressRegistryCustomerParticipationStatus(body).then((res: FireblocksResponse) => { + console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); +}).catch((error:any) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**[AddressRegistryCustomerRegistryResponse](../models/AddressRegistryCustomerRegistryResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Customer registry status in the response body | * 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) + # **getAddressRegistryTenantParticipationStatus** > AddressRegistryTenantRegistryResponse getAddressRegistryTenantParticipationStatus() -Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. +Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. ### Example @@ -1632,10 +1689,71 @@ 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) +# **optInAddressRegistryCustomer** +> AddressRegistryCustomerRegistryResponse optInAddressRegistryCustomer() + +Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, ComplianceApiOptInAddressRegistryCustomerRequest, AddressRegistryCustomerRegistryResponse } 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: ComplianceApiOptInAddressRegistryCustomerRequest = { + // 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.compliance.optInAddressRegistryCustomer(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 +------------- | ------------- | ------------- | ------------- + **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 + +**[AddressRegistryCustomerRegistryResponse](../models/AddressRegistryCustomerRegistryResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success; response body includes status OPTED_IN | * X-Request-ID -
| +**404** | The customer for this workspace could not be determined (error code 2147) | * 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) + # **optInAddressRegistryTenant** > AddressRegistryTenantRegistryResponse optInAddressRegistryTenant() -Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. +Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. ### Example @@ -1692,10 +1810,65 @@ 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) +# **optOutAddressRegistryCustomer** +> AddressRegistryCustomerRegistryResponse optOutAddressRegistryCustomer() + +Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. + +### Example + + +```typescript +import { readFileSync } from 'fs'; +import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, AddressRegistryCustomerRegistryResponse } from '@fireblocks/ts-sdk'; + +// Set the environment variables for authentication +process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1" +process.env.FIREBLOCKS_API_KEY = "my-api-key"; +process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8"); + +const fireblocks = new Fireblocks(); + +let body:any = {}; + +fireblocks.compliance.optOutAddressRegistryCustomer(body).then((res: FireblocksResponse) => { + console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); +}).catch((error:any) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**[AddressRegistryCustomerRegistryResponse](../models/AddressRegistryCustomerRegistryResponse.md)** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success; response body includes status OPTED_OUT | * X-Request-ID -
| +**404** | The customer for this workspace could not be determined (error code 2147) | * 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) + # **optOutAddressRegistryTenant** > AddressRegistryTenantRegistryResponse optOutAddressRegistryTenant() -Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. +Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. ### Example diff --git a/docs/apis/TradingApi.md b/docs/apis/TradingApi.md index e4a5202..17e2eb6 100644 --- a/docs/apis/TradingApi.md +++ b/docs/apis/TradingApi.md @@ -88,7 +88,7 @@ No authorization required # **createQuote** > QuotesResponse createQuote(createQuote) -Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). +Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get quotes for each side the provider supports in a single call; providers that support only one side return that side only. Every returned quote carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). ### Example @@ -156,7 +156,7 @@ No authorization required # **fetchAllOffers** > OffersResponse fetchAllOffers(createOffersRequest) -Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). +Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get offers for each side the provider supports in a single call; providers that support only one side return that side only. Every returned offer carries a concrete `BUY` or `SELL` side, never `BOTH`. If no slippageBps is provided, it defaults to 50 bps (0.5%). Slippage and settlement configuration do not affect the returned rate. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). ### Example @@ -224,7 +224,7 @@ No authorization required # **fetchRates** > RatesResponse fetchRates(ratesRequest) -Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). +Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. If `side` is omitted it defaults to `SELL`. Use `side: BOTH` to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete `BUY` or `SELL` side, never `BOTH`. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). ### Example diff --git a/docs/apis/TransactionsApi.md b/docs/apis/TransactionsApi.md index 6df2738..2d465c6 100644 --- a/docs/apis/TransactionsApi.md +++ b/docs/apis/TransactionsApi.md @@ -283,7 +283,7 @@ No authorization required # **estimateTransactionFee** > EstimatedTransactionFeeResponse estimateTransactionFee() -Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. +Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee). Endpoint Permission: Admin, Signer, Approver, Editor. ### Example diff --git a/docs/apis/VaultsApi.md b/docs/apis/VaultsApi.md index eb3056b..a31893b 100644 --- a/docs/apis/VaultsApi.md +++ b/docs/apis/VaultsApi.md @@ -1043,7 +1043,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); let body: VaultsApiGetMaxSpendableAmountRequest = { - // string | The ID of the vault account, or \'default\' for the default vault account + // string | The ID of the vault account vaultAccountId: vaultAccountId_example, // string | The ID of the asset assetId: assetId_example, @@ -1073,7 +1073,7 @@ fireblocks.vaults.getMaxSpendableAmount(body).then((res: FireblocksResponse=6.9.0" @@ -483,16 +483,16 @@ } }, "node_modules/@babel/traverse": { - "version": "7.29.8", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.8.tgz", - "integrity": "sha512-I5z7H3bf/41ktsNVLtpN0wAa336HkqIHQ5BuPLEhTkt1jVSyZpeNKIzTgEWmlxjdg81R0IgUCcaE+Ok3NvrfZg==", + "version": "7.29.10", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.10.tgz", + "integrity": "sha512-B3lYAs2nkKskbgQ1nfy8Ma9ao9Q1rntTAQHrzzyDuj+TSO+X3le6PfWwqDvodsb+OumE10eMFfuMCTQSQ5iuIQ==", "dev": true, "license": "MIT", "dependencies": { "@babel/code-frame": "^7.29.7", "@babel/generator": "^7.29.8", "@babel/helper-globals": "^7.29.7", - "@babel/parser": "^7.29.8", + "@babel/parser": "^7.29.9", "@babel/template": "^7.29.7", "@babel/types": "^7.29.8", "debug": "^4.3.1" @@ -1294,9 +1294,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.11.26", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.26.tgz", - "integrity": "sha512-GLQdD3y6UF8iVuMJl5fHgE4jdn/ua7n+toKfLgNlg3BqQtOZjpy68T8Tup8/wGWZCDlm7KMg7tPb4MPn7oN0TQ==", + "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==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1434,9 +1434,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001813", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001813.tgz", - "integrity": "sha512-zfjJo4rM0+fUomGDBW/xcDjhIwz/210DGvip2MAMDZ8KHcRPnOHmEgHPZP0UHlZoxr8fYKVJOqcORhYQcG4FKQ==", + "version": "1.0.30001815", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001815.tgz", + "integrity": "sha512-uDybUEyfgbyJJ93J1vikTylBX31AkdVYeVPeffMQpf8XN7hSfr0oZOn4VFOIMNvtU5+rHvC5Udg2TgtJKHm23Q==", "dev": true, "funding": [ { @@ -1715,9 +1715,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.441", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.441.tgz", - "integrity": "sha512-b84H5dyxtHtXYbJRJPLvbS+iud4ys2GVZ61BH7/9lJrfCcIL+Sk+Vh2AW6beaErTdstvjZLgEwkE2j0fZlmwRA==", + "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==", "dev": true, "license": "ISC" }, @@ -3675,14 +3675,14 @@ } }, "node_modules/resolve": { - "version": "1.22.12", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.12.tgz", - "integrity": "sha512-TyeJ1zif53BPfHootBGwPRYT1RUt6oGWsaQr8UyZW/eAm9bKoijtvruSDEmZHm92CwS9nj7/fWttqPCgzep8CA==", + "version": "1.22.13", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.13.tgz", + "integrity": "sha512-Dj/cW9zBV2aRj6XzCxuGIs3ESZKv02jixne3q6jFZYZ3/Tg09gHHviSMDL4kObh9pqSahdRHEnDoaP2gn8YLhA==", "dev": true, "license": "MIT", "dependencies": { "es-errors": "^1.3.0", - "is-core-module": "^2.16.1", + "is-core-module": "^2.17.0", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -4078,9 +4078,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.3.tgz", - "integrity": "sha512-pJ2sYawQS0R/WI928Gj5GlPhTGzbMelq0+4INtSYNDV9ErKJcX6xjGWkoG/VnB3dpUm00zALaqkrUD77pO5TDQ==", + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.4.tgz", + "integrity": "sha512-t8wonIOdQyOjtPd2VktlBu6QjTVTks6v8bSi7kd0r2Vll8TK1JYDZtRRdbmCHOAMphkZgrzK+L+vXK4pyZ8t4A==", "dev": true, "funding": [ { diff --git a/package.json b/package.json index b2d8041..584251d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fireblocks/ts-sdk", - "version": "35.1.0", + "version": "0.0.0", "description": "OpenAPI client for @fireblocks/ts-sdk", "author": "Fireblocks SDK Generator", "repository": {