From 2731342c5854a7754bb76c4c0e1aa17647a6ad4a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 24 Feb 2025 18:37:36 +0200 Subject: [PATCH] Generated SDK #9833 (#120) Co-authored-by: fireblocks_dx_team --- .openapi-generator/FILES | 46 +- CHANGELOG.md | 99 ---- README.md | 34 +- api.ts | 2 +- ...el-rule-beta-api.ts => travel-rule-api.ts} | 538 ++++++++++-------- client/client.ts | 8 +- ...{TravelRuleBetaApi.md => TravelRuleApi.md} | 152 ++--- docs/models/TravelRuleAddress.md | 8 +- .../TravelRuleCreateTransactionRequest.md | 33 +- docs/models/TravelRuleDateAndPlaceOfBirth.md | 13 + docs/models/TravelRuleFieldsEnum.md | 11 + docs/models/TravelRuleGeographicAddress.md | 27 + docs/models/TravelRuleGetAllVASPsResponse.md | 4 +- docs/models/TravelRuleLegalPerson.md | 17 + .../TravelRuleLegalPersonNameIdentifier.md | 13 + .../TravelRuleNationalIdentification.md | 15 + .../models/TravelRuleNaturalNameIdentifier.md | 14 + docs/models/TravelRuleNaturalPerson.md | 18 + .../TravelRuleNaturalPersonNameIdentifier.md | 14 + docs/models/TravelRuleNotationEnum.md | 11 + docs/models/TravelRuleOwnershipProof.md | 9 +- docs/models/TravelRulePerson.md | 13 + docs/models/TravelRulePiiIVMS.md | 12 +- .../TravelRuleTransactionBlockchainInfo.md | 6 +- docs/models/TravelRuleVASP.md | 90 +-- .../TravelRuleValidateDateAndPlaceOfBirth.md | 13 + ...ravelRuleValidateFullTransactionRequest.md | 51 +- .../TravelRuleValidateGeographicAddress.md | 38 ++ docs/models/TravelRuleValidateLegalPerson.md | 17 + ...elRuleValidateLegalPersonNameIdentifier.md | 24 + ...ravelRuleValidateNationalIdentification.md | 28 + ...TravelRuleValidateNaturalNameIdentifier.md | 29 + .../models/TravelRuleValidateNaturalPerson.md | 18 + ...RuleValidateNaturalPersonNameIdentifier.md | 14 + docs/models/TravelRuleValidatePerson.md | 13 + docs/models/TravelRuleValidatePiiIVMS.md | 14 + .../TravelRuleValidateTransactionRequest.md | 5 +- .../TravelRuleValidateTransactionResponse.md | 28 + models/index.ts | 21 + models/travel-rule-address.ts | 8 +- .../travel-rule-create-transaction-request.ts | 72 ++- models/travel-rule-date-and-place-of-birth.ts | 36 ++ models/travel-rule-fields-enum.ts | 24 + models/travel-rule-geographic-address.ts | 120 ++++ models/travel-rule-get-all-vasps-response.ts | 16 +- ...ravel-rule-legal-person-name-identifier.ts | 36 ++ models/travel-rule-legal-person.ts | 69 +++ models/travel-rule-national-identification.ts | 48 ++ models/travel-rule-natural-name-identifier.ts | 42 ++ ...vel-rule-natural-person-name-identifier.ts | 45 ++ models/travel-rule-natural-person.ts | 78 +++ models/travel-rule-notation-enum.ts | 24 + models/travel-rule-ownership-proof.ts | 36 +- models/travel-rule-person.ts | 42 ++ models/travel-rule-pii-ivms.ts | 59 +- ...travel-rule-transaction-blockchain-info.ts | 8 +- ...l-rule-validate-date-and-place-of-birth.ts | 36 ++ ...-rule-validate-full-transaction-request.ts | 124 ++-- ...travel-rule-validate-geographic-address.ts | 129 +++++ ...e-validate-legal-person-name-identifier.ts | 45 ++ models/travel-rule-validate-legal-person.ts | 69 +++ ...l-rule-validate-national-identification.ts | 58 ++ ...l-rule-validate-natural-name-identifier.ts | 53 ++ ...validate-natural-person-name-identifier.ts | 45 ++ models/travel-rule-validate-natural-person.ts | 78 +++ models/travel-rule-validate-person.ts | 42 ++ models/travel-rule-validate-pii-ivms.ts | 45 ++ ...ravel-rule-validate-transaction-request.ts | 10 +- ...avel-rule-validate-transaction-response.ts | 23 +- models/travel-rule-vasp.ts | 180 +++--- package-lock.json | 272 +++++++-- package.json | 2 +- tests/client.spec.ts | 14 +- 73 files changed, 2685 insertions(+), 823 deletions(-) delete mode 100644 CHANGELOG.md rename api/{travel-rule-beta-api.ts => travel-rule-api.ts} (53%) rename docs/apis/{TravelRuleBetaApi.md => TravelRuleApi.md} (62%) create mode 100644 docs/models/TravelRuleDateAndPlaceOfBirth.md create mode 100644 docs/models/TravelRuleFieldsEnum.md create mode 100644 docs/models/TravelRuleGeographicAddress.md create mode 100644 docs/models/TravelRuleLegalPerson.md create mode 100644 docs/models/TravelRuleLegalPersonNameIdentifier.md create mode 100644 docs/models/TravelRuleNationalIdentification.md create mode 100644 docs/models/TravelRuleNaturalNameIdentifier.md create mode 100644 docs/models/TravelRuleNaturalPerson.md create mode 100644 docs/models/TravelRuleNaturalPersonNameIdentifier.md create mode 100644 docs/models/TravelRuleNotationEnum.md create mode 100644 docs/models/TravelRulePerson.md create mode 100644 docs/models/TravelRuleValidateDateAndPlaceOfBirth.md create mode 100644 docs/models/TravelRuleValidateGeographicAddress.md create mode 100644 docs/models/TravelRuleValidateLegalPerson.md create mode 100644 docs/models/TravelRuleValidateLegalPersonNameIdentifier.md create mode 100644 docs/models/TravelRuleValidateNationalIdentification.md create mode 100644 docs/models/TravelRuleValidateNaturalNameIdentifier.md create mode 100644 docs/models/TravelRuleValidateNaturalPerson.md create mode 100644 docs/models/TravelRuleValidateNaturalPersonNameIdentifier.md create mode 100644 docs/models/TravelRuleValidatePerson.md create mode 100644 docs/models/TravelRuleValidatePiiIVMS.md create mode 100644 models/travel-rule-date-and-place-of-birth.ts create mode 100644 models/travel-rule-fields-enum.ts create mode 100644 models/travel-rule-geographic-address.ts create mode 100644 models/travel-rule-legal-person-name-identifier.ts create mode 100644 models/travel-rule-legal-person.ts create mode 100644 models/travel-rule-national-identification.ts create mode 100644 models/travel-rule-natural-name-identifier.ts create mode 100644 models/travel-rule-natural-person-name-identifier.ts create mode 100644 models/travel-rule-natural-person.ts create mode 100644 models/travel-rule-notation-enum.ts create mode 100644 models/travel-rule-person.ts create mode 100644 models/travel-rule-validate-date-and-place-of-birth.ts create mode 100644 models/travel-rule-validate-geographic-address.ts create mode 100644 models/travel-rule-validate-legal-person-name-identifier.ts create mode 100644 models/travel-rule-validate-legal-person.ts create mode 100644 models/travel-rule-validate-national-identification.ts create mode 100644 models/travel-rule-validate-natural-name-identifier.ts create mode 100644 models/travel-rule-validate-natural-person-name-identifier.ts create mode 100644 models/travel-rule-validate-natural-person.ts create mode 100644 models/travel-rule-validate-person.ts create mode 100644 models/travel-rule-validate-pii-ivms.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index f3aec85..a855866 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -521,18 +521,39 @@ TransferPeerPathSubType.md TransferPeerPathType.md TransferValidationFailure.md TravelRuleAddress.md -TravelRuleBetaApi.md +TravelRuleApi.md TravelRuleCreateTransactionRequest.md +TravelRuleDateAndPlaceOfBirth.md +TravelRuleFieldsEnum.md +TravelRuleGeographicAddress.md TravelRuleGetAllVASPsResponse.md TravelRuleIssuer.md TravelRuleIssuers.md +TravelRuleLegalPerson.md +TravelRuleLegalPersonNameIdentifier.md +TravelRuleNationalIdentification.md +TravelRuleNaturalNameIdentifier.md +TravelRuleNaturalPerson.md +TravelRuleNaturalPersonNameIdentifier.md +TravelRuleNotationEnum.md TravelRuleOwnershipProof.md +TravelRulePerson.md TravelRulePiiIVMS.md TravelRulePolicyRuleResponse.md TravelRuleTransactionBlockchainInfo.md TravelRuleUpdateVASPDetails.md TravelRuleVASP.md +TravelRuleValidateDateAndPlaceOfBirth.md TravelRuleValidateFullTransactionRequest.md +TravelRuleValidateGeographicAddress.md +TravelRuleValidateLegalPerson.md +TravelRuleValidateLegalPersonNameIdentifier.md +TravelRuleValidateNationalIdentification.md +TravelRuleValidateNaturalNameIdentifier.md +TravelRuleValidateNaturalPerson.md +TravelRuleValidateNaturalPersonNameIdentifier.md +TravelRuleValidatePerson.md +TravelRuleValidatePiiIVMS.md TravelRuleValidateTransactionRequest.md TravelRuleValidateTransactionResponse.md TravelRuleVaspForVault.md @@ -626,7 +647,7 @@ api/smart-transfer-api.ts api/staking-api.ts api/tokenization-api.ts api/transactions-api.ts -api/travel-rule-beta-api.ts +api/travel-rule-api.ts api/user-groups-beta-api.ts api/users-api.ts api/vaults-api.ts @@ -1130,15 +1151,36 @@ models/transfer-peer-path-type.ts models/transfer-validation-failure.ts models/travel-rule-address.ts models/travel-rule-create-transaction-request.ts +models/travel-rule-date-and-place-of-birth.ts +models/travel-rule-fields-enum.ts +models/travel-rule-geographic-address.ts models/travel-rule-get-all-vasps-response.ts models/travel-rule-issuer.ts models/travel-rule-issuers.ts +models/travel-rule-legal-person-name-identifier.ts +models/travel-rule-legal-person.ts +models/travel-rule-national-identification.ts +models/travel-rule-natural-name-identifier.ts +models/travel-rule-natural-person-name-identifier.ts +models/travel-rule-natural-person.ts +models/travel-rule-notation-enum.ts models/travel-rule-ownership-proof.ts +models/travel-rule-person.ts models/travel-rule-pii-ivms.ts models/travel-rule-policy-rule-response.ts models/travel-rule-transaction-blockchain-info.ts models/travel-rule-update-vaspdetails.ts +models/travel-rule-validate-date-and-place-of-birth.ts models/travel-rule-validate-full-transaction-request.ts +models/travel-rule-validate-geographic-address.ts +models/travel-rule-validate-legal-person-name-identifier.ts +models/travel-rule-validate-legal-person.ts +models/travel-rule-validate-national-identification.ts +models/travel-rule-validate-natural-name-identifier.ts +models/travel-rule-validate-natural-person-name-identifier.ts +models/travel-rule-validate-natural-person.ts +models/travel-rule-validate-person.ts +models/travel-rule-validate-pii-ivms.ts models/travel-rule-validate-transaction-request.ts models/travel-rule-validate-transaction-response.ts models/travel-rule-vasp-for-vault.ts diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index c641fbc..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,99 +0,0 @@ -### Changelog - -All notable changes to this project will be documented in this file. Dates are displayed in UTC. - -#### [v8.0.1](https://github.com/fireblocks/ts-sdk/compare/v8.0.0...v8.0.1) - -> 12 February 2025 - -- 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) - -> 2 February 2025 - -- 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) - -> 8 January 2025 - -- 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) - -> 5 December 2024 - -- 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) - -> 31 October 2024 - -- 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) - -> 17 September 2024 - -- 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) - -> 25 July 2024 - -- 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) - -> 17 July 2024 - -- 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) - -> 4 June 2024 - -- 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) - -> 8 May 2024 - -- 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) - -> 17 April 2024 - -- 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) - -> 7 April 2024 - -- Generated SDK for version v1.0.1 [`#32`](https://github.com/fireblocks/ts-sdk/pull/32) - -#### v1.0.0 - -> 7 April 2024 - -- 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 253cec1..07f88f0 100644 --- a/README.md +++ b/README.md @@ -332,13 +332,12 @@ Class | Method | HTTP request | Description *TransactionsApi* | [**setTransactionConfirmationThreshold**](docs/apis/TransactionsApi.md#setTransactionConfirmationThreshold) | **POST** /transactions/{txId}/set_confirmation_threshold | Set confirmation threshold by transaction ID *TransactionsApi* | [**unfreezeTransaction**](docs/apis/TransactionsApi.md#unfreezeTransaction) | **POST** /transactions/{txId}/unfreeze | Unfreeze a transaction *TransactionsApi* | [**validateAddress**](docs/apis/TransactionsApi.md#validateAddress) | **GET** /transactions/validate_address/{assetId}/{address} | Validate destination address -*TravelRuleBetaApi* | [**getVASPByDID**](docs/apis/TravelRuleBetaApi.md#getVASPByDID) | **GET** /screening/travel_rule/vasp/{did} | Get VASP details -*TravelRuleBetaApi* | [**getVASPs**](docs/apis/TravelRuleBetaApi.md#getVASPs) | **GET** /screening/travel_rule/vasp | Get All VASPs -*TravelRuleBetaApi* | [**getVaspForVault**](docs/apis/TravelRuleBetaApi.md#getVaspForVault) | **GET** /screening/travel_rule/vault/{vaultAccountId}/vasp | Get assigned VASP to vault -*TravelRuleBetaApi* | [**setVaspForVault**](docs/apis/TravelRuleBetaApi.md#setVaspForVault) | **POST** /screening/travel_rule/vault/{vaultAccountId}/vasp | Assign VASP to vault -*TravelRuleBetaApi* | [**updateVasp**](docs/apis/TravelRuleBetaApi.md#updateVasp) | **PUT** /screening/travel_rule/vasp/update | Add jsonDidKey to VASP details -*TravelRuleBetaApi* | [**validateFullTravelRuleTransaction**](docs/apis/TravelRuleBetaApi.md#validateFullTravelRuleTransaction) | **POST** /screening/travel_rule/transaction/validate/full | Validate Full Travel Rule Transaction -*TravelRuleBetaApi* | [**validateTravelRuleTransaction**](docs/apis/TravelRuleBetaApi.md#validateTravelRuleTransaction) | **POST** /screening/travel_rule/transaction/validate | Validate Travel Rule Transaction +*TravelRuleApi* | [**getVASPByDID**](docs/apis/TravelRuleApi.md#getVASPByDID) | **GET** /screening/travel_rule/vasp/{did} | Get VASP details +*TravelRuleApi* | [**getVASPs**](docs/apis/TravelRuleApi.md#getVASPs) | **GET** /screening/travel_rule/vasp | Get All VASPs +*TravelRuleApi* | [**getVaspForVault**](docs/apis/TravelRuleApi.md#getVaspForVault) | **GET** /screening/travel_rule/vault/{vaultAccountId}/vasp | Get assigned VASP to vault +*TravelRuleApi* | [**setVaspForVault**](docs/apis/TravelRuleApi.md#setVaspForVault) | **POST** /screening/travel_rule/vault/{vaultAccountId}/vasp | Assign VASP to vault +*TravelRuleApi* | [**updateVasp**](docs/apis/TravelRuleApi.md#updateVasp) | **PUT** /screening/travel_rule/vasp/update | Add jsonDidKey to VASP details +*TravelRuleApi* | [**validateFullTravelRuleTransaction**](docs/apis/TravelRuleApi.md#validateFullTravelRuleTransaction) | **POST** /screening/travel_rule/transaction/validate/full | Validate Full Travel Rule Transaction *UserGroupsBetaApi* | [**createUserGroup**](docs/apis/UserGroupsBetaApi.md#createUserGroup) | **POST** /management/user_groups | Create user group *UserGroupsBetaApi* | [**deleteUserGroup**](docs/apis/UserGroupsBetaApi.md#deleteUserGroup) | **DELETE** /management/user_groups/{groupId} | Delete user group *UserGroupsBetaApi* | [**getUserGroup**](docs/apis/UserGroupsBetaApi.md#getUserGroup) | **GET** /management/user_groups/{groupId} | Get user group @@ -876,16 +875,37 @@ Class | Method | HTTP request | Description - [TransferValidationFailure](docs/models/TransferValidationFailure.md) - [TravelRuleAddress](docs/models/TravelRuleAddress.md) - [TravelRuleCreateTransactionRequest](docs/models/TravelRuleCreateTransactionRequest.md) + - [TravelRuleDateAndPlaceOfBirth](docs/models/TravelRuleDateAndPlaceOfBirth.md) + - [TravelRuleFieldsEnum](docs/models/TravelRuleFieldsEnum.md) + - [TravelRuleGeographicAddress](docs/models/TravelRuleGeographicAddress.md) - [TravelRuleGetAllVASPsResponse](docs/models/TravelRuleGetAllVASPsResponse.md) - [TravelRuleIssuer](docs/models/TravelRuleIssuer.md) - [TravelRuleIssuers](docs/models/TravelRuleIssuers.md) + - [TravelRuleLegalPerson](docs/models/TravelRuleLegalPerson.md) + - [TravelRuleLegalPersonNameIdentifier](docs/models/TravelRuleLegalPersonNameIdentifier.md) + - [TravelRuleNationalIdentification](docs/models/TravelRuleNationalIdentification.md) + - [TravelRuleNaturalNameIdentifier](docs/models/TravelRuleNaturalNameIdentifier.md) + - [TravelRuleNaturalPerson](docs/models/TravelRuleNaturalPerson.md) + - [TravelRuleNaturalPersonNameIdentifier](docs/models/TravelRuleNaturalPersonNameIdentifier.md) + - [TravelRuleNotationEnum](docs/models/TravelRuleNotationEnum.md) - [TravelRuleOwnershipProof](docs/models/TravelRuleOwnershipProof.md) + - [TravelRulePerson](docs/models/TravelRulePerson.md) - [TravelRulePiiIVMS](docs/models/TravelRulePiiIVMS.md) - [TravelRulePolicyRuleResponse](docs/models/TravelRulePolicyRuleResponse.md) - [TravelRuleTransactionBlockchainInfo](docs/models/TravelRuleTransactionBlockchainInfo.md) - [TravelRuleUpdateVASPDetails](docs/models/TravelRuleUpdateVASPDetails.md) - [TravelRuleVASP](docs/models/TravelRuleVASP.md) + - [TravelRuleValidateDateAndPlaceOfBirth](docs/models/TravelRuleValidateDateAndPlaceOfBirth.md) - [TravelRuleValidateFullTransactionRequest](docs/models/TravelRuleValidateFullTransactionRequest.md) + - [TravelRuleValidateGeographicAddress](docs/models/TravelRuleValidateGeographicAddress.md) + - [TravelRuleValidateLegalPerson](docs/models/TravelRuleValidateLegalPerson.md) + - [TravelRuleValidateLegalPersonNameIdentifier](docs/models/TravelRuleValidateLegalPersonNameIdentifier.md) + - [TravelRuleValidateNationalIdentification](docs/models/TravelRuleValidateNationalIdentification.md) + - [TravelRuleValidateNaturalNameIdentifier](docs/models/TravelRuleValidateNaturalNameIdentifier.md) + - [TravelRuleValidateNaturalPerson](docs/models/TravelRuleValidateNaturalPerson.md) + - [TravelRuleValidateNaturalPersonNameIdentifier](docs/models/TravelRuleValidateNaturalPersonNameIdentifier.md) + - [TravelRuleValidatePerson](docs/models/TravelRuleValidatePerson.md) + - [TravelRuleValidatePiiIVMS](docs/models/TravelRuleValidatePiiIVMS.md) - [TravelRuleValidateTransactionRequest](docs/models/TravelRuleValidateTransactionRequest.md) - [TravelRuleValidateTransactionResponse](docs/models/TravelRuleValidateTransactionResponse.md) - [TravelRuleVaspForVault](docs/models/TravelRuleVaspForVault.md) diff --git a/api.ts b/api.ts index 808419b..5b0445c 100644 --- a/api.ts +++ b/api.ts @@ -47,7 +47,7 @@ export * from './api/smart-transfer-api'; export * from './api/staking-api'; export * from './api/tokenization-api'; export * from './api/transactions-api'; -export * from './api/travel-rule-beta-api'; +export * from './api/travel-rule-api'; export * from './api/user-groups-beta-api'; export * from './api/users-api'; export * from './api/vaults-api'; diff --git a/api/travel-rule-beta-api.ts b/api/travel-rule-api.ts similarity index 53% rename from api/travel-rule-beta-api.ts rename to api/travel-rule-api.ts index 2dca297..88688cb 100644 --- a/api/travel-rule-beta-api.ts +++ b/api/travel-rule-api.ts @@ -37,26 +37,24 @@ import { TravelRuleVASP } from '../models'; // @ts-ignore import { TravelRuleValidateFullTransactionRequest } from '../models'; // @ts-ignore -import { TravelRuleValidateTransactionRequest } from '../models'; -// @ts-ignore import { TravelRuleValidateTransactionResponse } from '../models'; // @ts-ignore import { TravelRuleVaspForVault } from '../models'; /** - * TravelRuleBetaApi - axios parameter creator + * TravelRuleApi - axios parameter creator * @export */ -export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Configuration) { +export const TravelRuleApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Get VASP Details. Returns information about a VASP that has the specified DID. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get VASP Details. Returns information about a VASP that has the specified DID. * @summary Get VASP details * @param {string} did - * @param {string} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {Array} [fields] A CSV of fields to return. Choose from the following options: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVASPByDID: async (did: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise => { + getVASPByDID: async (did: string, fields?: Array, options: RawAxiosRequestConfig = {}): Promise => { assertParamExistsAndNotEmpty('getVASPByDID', 'did', did) const localVarPath = `/screening/travel_rule/vasp/{did}` .replace(`{${"did"}}`, encodeURIComponent(String(did))); @@ -71,7 +69,7 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (fields !== undefined) { + if (fields) { localVarQueryParameter['fields'] = fields; } @@ -87,16 +85,18 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. * @summary Get All VASPs - * @param {string} [order] Field to order by - * @param {number} [perPage] Records per page - * @param {number} [page] Page number - * @param {string} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {GetVASPsOrderEnum} [order] Field to order by + * @param {number} [pageSize] Records per page + * @param {Array} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {string} [search] Search query + * @param {GetVASPsReviewValueEnum} [reviewValue] Filter by the VASP\'s review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status). + * @param {string} [pageCursor] Cursor for pagination. When provided, the response will include the next page of results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVASPs: async (order?: string, perPage?: number, page?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise => { + getVASPs: async (order?: GetVASPsOrderEnum, pageSize?: number, fields?: Array, search?: string, reviewValue?: GetVASPsReviewValueEnum, pageCursor?: string, options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/screening/travel_rule/vasp`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -113,16 +113,24 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf localVarQueryParameter['order'] = order; } - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; } - if (page !== undefined) { - localVarQueryParameter['page'] = page; + if (fields) { + localVarQueryParameter['fields'] = fields; } - if (fields !== undefined) { - localVarQueryParameter['fields'] = fields; + if (search !== undefined) { + localVarQueryParameter['search'] = search; + } + + if (reviewValue !== undefined) { + localVarQueryParameter['reviewValue'] = reviewValue; + } + + if (pageCursor !== undefined) { + localVarQueryParameter['pageCursor'] = pageCursor; } @@ -213,7 +221,7 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. * @summary Add jsonDidKey to VASP details * @param {TravelRuleUpdateVASPDetails} travelRuleUpdateVASPDetails * @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. @@ -253,14 +261,15 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction * @param {TravelRuleValidateFullTransactionRequest} travelRuleValidateFullTransactionRequest + * @param {Array} [notation] Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly. * @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} */ - validateFullTravelRuleTransaction: async (travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { + validateFullTravelRuleTransaction: async (travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, notation?: Array, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { assertParamExists('validateFullTravelRuleTransaction', 'travelRuleValidateFullTransactionRequest', travelRuleValidateFullTransactionRequest) const localVarPath = `/screening/travel_rule/transaction/validate/full`; // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -274,46 +283,10 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { - localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); + if (notation) { + localVarQueryParameter['notation'] = notation; } - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(travelRuleValidateFullTransactionRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary\'s jurisdiction. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). - * @summary Validate Travel Rule Transaction - * @param {TravelRuleValidateTransactionRequest} travelRuleValidateTransactionRequest - * @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} - */ - validateTravelRuleTransaction: async (travelRuleValidateTransactionRequest: TravelRuleValidateTransactionRequest, idempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise => { - assertParamExists('validateTravelRuleTransaction', 'travelRuleValidateTransactionRequest', travelRuleValidateTransactionRequest) - const localVarPath = `/screening/travel_rule/transaction/validate`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - if (idempotencyKey != null) { localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey); } @@ -325,7 +298,7 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(travelRuleValidateTransactionRequest, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(travelRuleValidateFullTransactionRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -336,40 +309,42 @@ export const TravelRuleBetaApiAxiosParamCreator = function (configuration?: Conf }; /** - * TravelRuleBetaApi - functional programming interface + * TravelRuleApi - functional programming interface * @export */ -export const TravelRuleBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TravelRuleBetaApiAxiosParamCreator(configuration) +export const TravelRuleApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TravelRuleApiAxiosParamCreator(configuration) return { /** - * Get VASP Details. Returns information about a VASP that has the specified DID. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get VASP Details. Returns information about a VASP that has the specified DID. * @summary Get VASP details * @param {string} did - * @param {string} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {Array} [fields] A CSV of fields to return. Choose from the following options: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getVASPByDID(did: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getVASPByDID(did: string, fields?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getVASPByDID(did, fields, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.getVASPByDID']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.getVASPByDID']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. * @summary Get All VASPs - * @param {string} [order] Field to order by - * @param {number} [perPage] Records per page - * @param {number} [page] Page number - * @param {string} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {GetVASPsOrderEnum} [order] Field to order by + * @param {number} [pageSize] Records per page + * @param {Array} [fields] CSV of fields to return (all, \"blank\" or see list of all field names below) + * @param {string} [search] Search query + * @param {GetVASPsReviewValueEnum} [reviewValue] Filter by the VASP\'s review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status). + * @param {string} [pageCursor] Cursor for pagination. When provided, the response will include the next page of results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getVASPs(order?: string, perPage?: number, page?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getVASPs(order, perPage, page, fields, options); + async getVASPs(order?: GetVASPsOrderEnum, pageSize?: number, fields?: Array, search?: string, reviewValue?: GetVASPsReviewValueEnum, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getVASPs(order, pageSize, fields, search, reviewValue, pageCursor, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.getVASPs']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.getVASPs']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -382,7 +357,7 @@ export const TravelRuleBetaApiFp = function(configuration?: Configuration) { async getVaspForVault(vaultAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getVaspForVault(vaultAccountId, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.getVaspForVault']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.getVaspForVault']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** @@ -397,11 +372,11 @@ export const TravelRuleBetaApiFp = function(configuration?: Configuration) { async setVaspForVault(travelRuleVaspForVault: TravelRuleVaspForVault, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.setVaspForVault(travelRuleVaspForVault, vaultAccountId, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.setVaspForVault']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.setVaspForVault']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. * @summary Add jsonDidKey to VASP details * @param {TravelRuleUpdateVASPDetails} travelRuleUpdateVASPDetails * @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. @@ -411,370 +386,465 @@ export const TravelRuleBetaApiFp = function(configuration?: Configuration) { async updateVasp(travelRuleUpdateVASPDetails: TravelRuleUpdateVASPDetails, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateVasp(travelRuleUpdateVASPDetails, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.updateVasp']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.updateVasp']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction * @param {TravelRuleValidateFullTransactionRequest} travelRuleValidateFullTransactionRequest + * @param {Array} [notation] Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly. * @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 validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest, idempotencyKey, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.validateFullTravelRuleTransaction']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary\'s jurisdiction. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). - * @summary Validate Travel Rule Transaction - * @param {TravelRuleValidateTransactionRequest} travelRuleValidateTransactionRequest - * @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 validateTravelRuleTransaction(travelRuleValidateTransactionRequest: TravelRuleValidateTransactionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateTravelRuleTransaction(travelRuleValidateTransactionRequest, idempotencyKey, options); + async validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, notation?: Array, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest, notation, idempotencyKey, options); const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TravelRuleBetaApi.validateTravelRuleTransaction']?.[index]?.url; + const operationBasePath = operationServerMap['TravelRuleApi.validateFullTravelRuleTransaction']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, } }; /** - * TravelRuleBetaApi - factory interface + * TravelRuleApi - factory interface * @export */ -export const TravelRuleBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TravelRuleBetaApiFp(configuration) +export const TravelRuleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TravelRuleApiFp(configuration) return { /** - * Get VASP Details. Returns information about a VASP that has the specified DID. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get VASP Details. Returns information about a VASP that has the specified DID. * @summary Get VASP details - * @param {TravelRuleBetaApiGetVASPByDIDRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVASPByDIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVASPByDID(requestParameters: TravelRuleBetaApiGetVASPByDIDRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getVASPByDID(requestParameters: TravelRuleApiGetVASPByDIDRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getVASPByDID(requestParameters.did, requestParameters.fields, options).then((request) => request(axios, basePath)); }, /** - * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. * @summary Get All VASPs - * @param {TravelRuleBetaApiGetVASPsRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVASPsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVASPs(requestParameters: TravelRuleBetaApiGetVASPsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getVASPs(requestParameters.order, requestParameters.perPage, requestParameters.page, requestParameters.fields, options).then((request) => request(axios, basePath)); + getVASPs(requestParameters: TravelRuleApiGetVASPsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getVASPs(requestParameters.order, requestParameters.pageSize, requestParameters.fields, requestParameters.search, requestParameters.reviewValue, requestParameters.pageCursor, options).then((request) => request(axios, basePath)); }, /** * Get assigned VASP Did for a specific vault. Returns empty string vaspDid value in response if none assigned. * @summary Get assigned VASP to vault - * @param {TravelRuleBetaApiGetVaspForVaultRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVaspForVault(requestParameters: TravelRuleBetaApiGetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise { + getVaspForVault(requestParameters: TravelRuleApiGetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getVaspForVault(requestParameters.vaultAccountId, options).then((request) => request(axios, basePath)); }, /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault - * @param {TravelRuleBetaApiSetVaspForVaultRequest} requestParameters Request parameters. + * @param {TravelRuleApiSetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setVaspForVault(requestParameters: TravelRuleBetaApiSetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise { + setVaspForVault(requestParameters: TravelRuleApiSetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.setVaspForVault(requestParameters.travelRuleVaspForVault, requestParameters.vaultAccountId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. * @summary Add jsonDidKey to VASP details - * @param {TravelRuleBetaApiUpdateVaspRequest} requestParameters Request parameters. + * @param {TravelRuleApiUpdateVaspRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateVasp(requestParameters: TravelRuleBetaApiUpdateVaspRequest, options?: RawAxiosRequestConfig): AxiosPromise { + updateVasp(requestParameters: TravelRuleApiUpdateVaspRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateVasp(requestParameters.travelRuleUpdateVASPDetails, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction - * @param {TravelRuleBetaApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - validateFullTravelRuleTransaction(requestParameters: TravelRuleBetaApiValidateFullTravelRuleTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateFullTravelRuleTransaction(requestParameters.travelRuleValidateFullTransactionRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); - }, - /** - * Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary\'s jurisdiction. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). - * @summary Validate Travel Rule Transaction - * @param {TravelRuleBetaApiValidateTravelRuleTransactionRequest} requestParameters Request parameters. + * @param {TravelRuleApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateTravelRuleTransaction(requestParameters: TravelRuleBetaApiValidateTravelRuleTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateTravelRuleTransaction(requestParameters.travelRuleValidateTransactionRequest, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); + validateFullTravelRuleTransaction(requestParameters: TravelRuleApiValidateFullTravelRuleTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.validateFullTravelRuleTransaction(requestParameters.travelRuleValidateFullTransactionRequest, requestParameters.notation, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for getVASPByDID operation in TravelRuleBetaApi. + * Request parameters for getVASPByDID operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiGetVASPByDIDRequest + * @interface TravelRuleApiGetVASPByDIDRequest */ -export interface TravelRuleBetaApiGetVASPByDIDRequest { +export interface TravelRuleApiGetVASPByDIDRequest { /** * * @type {string} - * @memberof TravelRuleBetaApiGetVASPByDID + * @memberof TravelRuleApiGetVASPByDID */ readonly did: string /** - * CSV of fields to return (all, \"blank\" or see list of all field names below) - * @type {string} - * @memberof TravelRuleBetaApiGetVASPByDID + * A CSV of fields to return. Choose from the following options: + * @type {TravelRuleFieldsEnum} + * @memberof TravelRuleApiGetVASPByDID */ - readonly fields?: string + readonly fields?: Array } /** - * Request parameters for getVASPs operation in TravelRuleBetaApi. + * Request parameters for getVASPs operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiGetVASPsRequest + * @interface TravelRuleApiGetVASPsRequest */ -export interface TravelRuleBetaApiGetVASPsRequest { +export interface TravelRuleApiGetVASPsRequest { /** * Field to order by - * @type {string} - * @memberof TravelRuleBetaApiGetVASPs + * @type {'ASC' | 'DESC'} + * @memberof TravelRuleApiGetVASPs */ - readonly order?: string + readonly order?: GetVASPsOrderEnum /** * Records per page * @type {number} - * @memberof TravelRuleBetaApiGetVASPs + * @memberof TravelRuleApiGetVASPs */ - readonly perPage?: number + readonly pageSize?: number /** - * Page number - * @type {number} - * @memberof TravelRuleBetaApiGetVASPs + * CSV of fields to return (all, \"blank\" or see list of all field names below) + * @type {TravelRuleFieldsEnum} + * @memberof TravelRuleApiGetVASPs */ - readonly page?: number + readonly fields?: Array /** - * CSV of fields to return (all, \"blank\" or see list of all field names below) + * Search query * @type {string} - * @memberof TravelRuleBetaApiGetVASPs + * @memberof TravelRuleApiGetVASPs + */ + readonly search?: string + + /** + * Filter by the VASP\'s review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status). + * @type {'TRUSTED' | 'BLOCKED' | 'MANUAL' | 'null'} + * @memberof TravelRuleApiGetVASPs */ - readonly fields?: string + readonly reviewValue?: GetVASPsReviewValueEnum + + /** + * Cursor for pagination. When provided, the response will include the next page of results. + * @type {string} + * @memberof TravelRuleApiGetVASPs + */ + readonly pageCursor?: string } /** - * Request parameters for getVaspForVault operation in TravelRuleBetaApi. + * Request parameters for getVaspForVault operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiGetVaspForVaultRequest + * @interface TravelRuleApiGetVaspForVaultRequest */ -export interface TravelRuleBetaApiGetVaspForVaultRequest { +export interface TravelRuleApiGetVaspForVaultRequest { /** * The ID of the vault account * @type {string} - * @memberof TravelRuleBetaApiGetVaspForVault + * @memberof TravelRuleApiGetVaspForVault */ readonly vaultAccountId: string } /** - * Request parameters for setVaspForVault operation in TravelRuleBetaApi. + * Request parameters for setVaspForVault operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiSetVaspForVaultRequest + * @interface TravelRuleApiSetVaspForVaultRequest */ -export interface TravelRuleBetaApiSetVaspForVaultRequest { +export interface TravelRuleApiSetVaspForVaultRequest { /** * * @type {TravelRuleVaspForVault} - * @memberof TravelRuleBetaApiSetVaspForVault + * @memberof TravelRuleApiSetVaspForVault */ readonly travelRuleVaspForVault: TravelRuleVaspForVault /** * The ID of the vault account * @type {string} - * @memberof TravelRuleBetaApiSetVaspForVault + * @memberof TravelRuleApiSetVaspForVault */ readonly vaultAccountId: 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 TravelRuleBetaApiSetVaspForVault + * @memberof TravelRuleApiSetVaspForVault */ readonly idempotencyKey?: string } /** - * Request parameters for updateVasp operation in TravelRuleBetaApi. + * Request parameters for updateVasp operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiUpdateVaspRequest + * @interface TravelRuleApiUpdateVaspRequest */ -export interface TravelRuleBetaApiUpdateVaspRequest { +export interface TravelRuleApiUpdateVaspRequest { /** * * @type {TravelRuleUpdateVASPDetails} - * @memberof TravelRuleBetaApiUpdateVasp + * @memberof TravelRuleApiUpdateVasp */ readonly travelRuleUpdateVASPDetails: TravelRuleUpdateVASPDetails /** * 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 TravelRuleBetaApiUpdateVasp + * @memberof TravelRuleApiUpdateVasp */ readonly idempotencyKey?: string } /** - * Request parameters for validateFullTravelRuleTransaction operation in TravelRuleBetaApi. + * Request parameters for validateFullTravelRuleTransaction operation in TravelRuleApi. * @export - * @interface TravelRuleBetaApiValidateFullTravelRuleTransactionRequest + * @interface TravelRuleApiValidateFullTravelRuleTransactionRequest */ -export interface TravelRuleBetaApiValidateFullTravelRuleTransactionRequest { +export interface TravelRuleApiValidateFullTravelRuleTransactionRequest { /** * * @type {TravelRuleValidateFullTransactionRequest} - * @memberof TravelRuleBetaApiValidateFullTravelRuleTransaction + * @memberof TravelRuleApiValidateFullTravelRuleTransaction */ readonly travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest /** - * 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 TravelRuleBetaApiValidateFullTravelRuleTransaction + * Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly. + * @type {TravelRuleNotationEnum} + * @memberof TravelRuleApiValidateFullTravelRuleTransaction */ - readonly idempotencyKey?: string -} - -/** - * Request parameters for validateTravelRuleTransaction operation in TravelRuleBetaApi. - * @export - * @interface TravelRuleBetaApiValidateTravelRuleTransactionRequest - */ -export interface TravelRuleBetaApiValidateTravelRuleTransactionRequest { - /** - * - * @type {TravelRuleValidateTransactionRequest} - * @memberof TravelRuleBetaApiValidateTravelRuleTransaction - */ - readonly travelRuleValidateTransactionRequest: TravelRuleValidateTransactionRequest + readonly notation?: Array /** * 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 TravelRuleBetaApiValidateTravelRuleTransaction + * @memberof TravelRuleApiValidateFullTravelRuleTransaction */ readonly idempotencyKey?: string } /** - * TravelRuleBetaApi - object-oriented interface + * TravelRuleApi - object-oriented interface * @export - * @class TravelRuleBetaApi + * @class TravelRuleApi * @extends {BaseAPI} */ -export class TravelRuleBetaApi extends BaseAPI { +export class TravelRuleApi extends BaseAPI { /** - * Get VASP Details. Returns information about a VASP that has the specified DID. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get VASP Details. Returns information about a VASP that has the specified DID. * @summary Get VASP details - * @param {TravelRuleBetaApiGetVASPByDIDRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVASPByDIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public getVASPByDID(requestParameters: TravelRuleBetaApiGetVASPByDIDRequest) { - return TravelRuleBetaApiFp(this.configuration).getVASPByDID(requestParameters.did, requestParameters.fields).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getVASPByDID(requestParameters: TravelRuleApiGetVASPByDIDRequest) { + return TravelRuleApiFp(this.configuration).getVASPByDID(requestParameters.did, requestParameters.fields).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. * @summary Get All VASPs - * @param {TravelRuleBetaApiGetVASPsRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVASPsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public getVASPs(requestParameters: TravelRuleBetaApiGetVASPsRequest = {}) { - return TravelRuleBetaApiFp(this.configuration).getVASPs(requestParameters.order, requestParameters.perPage, requestParameters.page, requestParameters.fields).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getVASPs(requestParameters: TravelRuleApiGetVASPsRequest = {}) { + return TravelRuleApiFp(this.configuration).getVASPs(requestParameters.order, requestParameters.pageSize, requestParameters.fields, requestParameters.search, requestParameters.reviewValue, requestParameters.pageCursor).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Get assigned VASP Did for a specific vault. Returns empty string vaspDid value in response if none assigned. * @summary Get assigned VASP to vault - * @param {TravelRuleBetaApiGetVaspForVaultRequest} requestParameters Request parameters. + * @param {TravelRuleApiGetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public getVaspForVault(requestParameters: TravelRuleBetaApiGetVaspForVaultRequest) { - return TravelRuleBetaApiFp(this.configuration).getVaspForVault(requestParameters.vaultAccountId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public getVaspForVault(requestParameters: TravelRuleApiGetVaspForVaultRequest) { + return TravelRuleApiFp(this.configuration).getVaspForVault(requestParameters.vaultAccountId).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault - * @param {TravelRuleBetaApiSetVaspForVaultRequest} requestParameters Request parameters. + * @param {TravelRuleApiSetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public setVaspForVault(requestParameters: TravelRuleBetaApiSetVaspForVaultRequest) { - return TravelRuleBetaApiFp(this.configuration).setVaspForVault(requestParameters.travelRuleVaspForVault, requestParameters.vaultAccountId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public setVaspForVault(requestParameters: TravelRuleApiSetVaspForVaultRequest) { + return TravelRuleApiFp(this.configuration).setVaspForVault(requestParameters.travelRuleVaspForVault, requestParameters.vaultAccountId, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. * @summary Add jsonDidKey to VASP details - * @param {TravelRuleBetaApiUpdateVaspRequest} requestParameters Request parameters. + * @param {TravelRuleApiUpdateVaspRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public updateVasp(requestParameters: TravelRuleBetaApiUpdateVaspRequest) { - return TravelRuleBetaApiFp(this.configuration).updateVasp(requestParameters.travelRuleUpdateVASPDetails, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public updateVasp(requestParameters: TravelRuleApiUpdateVaspRequest) { + return TravelRuleApiFp(this.configuration).updateVasp(requestParameters.travelRuleUpdateVASPDetails, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } /** - * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). + * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction - * @param {TravelRuleBetaApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TravelRuleBetaApi - */ - public validateFullTravelRuleTransaction(requestParameters: TravelRuleBetaApiValidateFullTravelRuleTransactionRequest) { - return TravelRuleBetaApiFp(this.configuration).validateFullTravelRuleTransaction(requestParameters.travelRuleValidateFullTransactionRequest, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); - } - - /** - * Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary\'s jurisdiction. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). - * @summary Validate Travel Rule Transaction - * @param {TravelRuleBetaApiValidateTravelRuleTransactionRequest} requestParameters Request parameters. + * @param {TravelRuleApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TravelRuleBetaApi + * @memberof TravelRuleApi */ - public validateTravelRuleTransaction(requestParameters: TravelRuleBetaApiValidateTravelRuleTransactionRequest) { - return TravelRuleBetaApiFp(this.configuration).validateTravelRuleTransaction(requestParameters.travelRuleValidateTransactionRequest, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); + public validateFullTravelRuleTransaction(requestParameters: TravelRuleApiValidateFullTravelRuleTransactionRequest) { + return TravelRuleApiFp(this.configuration).validateFullTravelRuleTransaction(requestParameters.travelRuleValidateFullTransactionRequest, requestParameters.notation, requestParameters.idempotencyKey).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } } +/** + * @export + */ +export const GetVASPByDIDFieldsEnum = { + Did: 'did', + Name: 'name', + VerificationStatus: 'verificationStatus', + AddressLine1: 'addressLine1', + AddressLine2: 'addressLine2', + City: 'city', + Country: 'country', + EmailDomains: 'emailDomains', + Website: 'website', + Logo: 'logo', + LegalStructure: 'legalStructure', + LegalName: 'legalName', + YearFounded: 'yearFounded', + IncorporationCountry: 'incorporationCountry', + IsRegulated: 'isRegulated', + OtherNames: 'otherNames', + IdentificationType: 'identificationType', + IdentificationCountry: 'identificationCountry', + BusinessNumber: 'businessNumber', + RegulatoryAuthorities: 'regulatoryAuthorities', + Jurisdictions: 'jurisdictions', + Street: 'street', + Number: 'number', + Unit: 'unit', + PostCode: 'postCode', + State: 'state', + Certificates: 'certificates', + Description: 'description', + TravelRuleOpenvasp: 'travelRule_OPENVASP', + TravelRuleSygna: 'travelRule_SYGNA', + TravelRuleTrisa: 'travelRule_TRISA', + TravelRuleTrlight: 'travelRule_TRLIGHT', + TravelRuleEmail: 'travelRule_EMAIL', + TravelRuleTrp: 'travelRule_TRP', + TravelRuleShyft: 'travelRule_SHYFT', + TravelRuleUstravelrulewg: 'travelRule_USTRAVELRULEWG', + CreatedAt: 'createdAt', + CreatedBy: 'createdBy', + UpdatedAt: 'updatedAt', + UpdatedBy: 'updatedBy', + LastSentDate: 'lastSentDate', + LastReceivedDate: 'lastReceivedDate', + Documents: 'documents', + HasAdmin: 'hasAdmin', + IsNotifiable: 'isNotifiable', + Issuers: 'issuers' +} as const; +export type GetVASPByDIDFieldsEnum = typeof GetVASPByDIDFieldsEnum[keyof typeof GetVASPByDIDFieldsEnum]; +/** + * @export + */ +export const GetVASPsOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; +export type GetVASPsOrderEnum = typeof GetVASPsOrderEnum[keyof typeof GetVASPsOrderEnum]; +/** + * @export + */ +export const GetVASPsFieldsEnum = { + Did: 'did', + Name: 'name', + VerificationStatus: 'verificationStatus', + AddressLine1: 'addressLine1', + AddressLine2: 'addressLine2', + City: 'city', + Country: 'country', + EmailDomains: 'emailDomains', + Website: 'website', + Logo: 'logo', + LegalStructure: 'legalStructure', + LegalName: 'legalName', + YearFounded: 'yearFounded', + IncorporationCountry: 'incorporationCountry', + IsRegulated: 'isRegulated', + OtherNames: 'otherNames', + IdentificationType: 'identificationType', + IdentificationCountry: 'identificationCountry', + BusinessNumber: 'businessNumber', + RegulatoryAuthorities: 'regulatoryAuthorities', + Jurisdictions: 'jurisdictions', + Street: 'street', + Number: 'number', + Unit: 'unit', + PostCode: 'postCode', + State: 'state', + Certificates: 'certificates', + Description: 'description', + TravelRuleOpenvasp: 'travelRule_OPENVASP', + TravelRuleSygna: 'travelRule_SYGNA', + TravelRuleTrisa: 'travelRule_TRISA', + TravelRuleTrlight: 'travelRule_TRLIGHT', + TravelRuleEmail: 'travelRule_EMAIL', + TravelRuleTrp: 'travelRule_TRP', + TravelRuleShyft: 'travelRule_SHYFT', + TravelRuleUstravelrulewg: 'travelRule_USTRAVELRULEWG', + CreatedAt: 'createdAt', + CreatedBy: 'createdBy', + UpdatedAt: 'updatedAt', + UpdatedBy: 'updatedBy', + LastSentDate: 'lastSentDate', + LastReceivedDate: 'lastReceivedDate', + Documents: 'documents', + HasAdmin: 'hasAdmin', + IsNotifiable: 'isNotifiable', + Issuers: 'issuers' +} as const; +export type GetVASPsFieldsEnum = typeof GetVASPsFieldsEnum[keyof typeof GetVASPsFieldsEnum]; +/** + * @export + */ +export const GetVASPsReviewValueEnum = { + Trusted: 'TRUSTED', + Blocked: 'BLOCKED', + Manual: 'MANUAL', + Null: 'null' +} as const; +export type GetVASPsReviewValueEnum = typeof GetVASPsReviewValueEnum[keyof typeof GetVASPsReviewValueEnum]; +/** + * @export + */ +export const ValidateFullTravelRuleTransactionNotationEnum = { + Fireblocks: 'fireblocks', + Notabene: 'notabene' +} as const; +export type ValidateFullTravelRuleTransactionNotationEnum = typeof ValidateFullTravelRuleTransactionNotationEnum[keyof typeof ValidateFullTravelRuleTransactionNotationEnum]; diff --git a/client/client.ts b/client/client.ts index 2b1ecc5..50be7a1 100644 --- a/client/client.ts +++ b/client/client.ts @@ -45,7 +45,7 @@ import { ApiUserApi, StakingApi, TokenizationApi, TransactionsApi, - TravelRuleBetaApi, + TravelRuleApi, UserGroupsBetaApi, UsersApi, VaultsApi, @@ -94,7 +94,7 @@ export class Fireblocks { private _staking?: StakingApi; private _tokenization?: TokenizationApi; private _transactions?: TransactionsApi; - private _travelRuleBeta?: TravelRuleBetaApi; + private _travelRule?: TravelRuleApi; private _userGroupsBeta?: UserGroupsBetaApi; private _users?: UsersApi; private _vaults?: VaultsApi; @@ -223,8 +223,8 @@ export class Fireblocks { get transactions(): TransactionsApi { return this._transactions ?? new TransactionsApi(this.config, undefined, this.axiosManager.axios); } - get travelRuleBeta(): TravelRuleBetaApi { - return this._travelRuleBeta ?? new TravelRuleBetaApi(this.config, undefined, this.axiosManager.axios); + get travelRule(): TravelRuleApi { + return this._travelRule ?? new TravelRuleApi(this.config, undefined, this.axiosManager.axios); } get userGroupsBeta(): UserGroupsBetaApi { return this._userGroupsBeta ?? new UserGroupsBetaApi(this.config, undefined, this.axiosManager.axios); diff --git a/docs/apis/TravelRuleBetaApi.md b/docs/apis/TravelRuleApi.md similarity index 62% rename from docs/apis/TravelRuleBetaApi.md rename to docs/apis/TravelRuleApi.md index dcf2136..aedb591 100644 --- a/docs/apis/TravelRuleBetaApi.md +++ b/docs/apis/TravelRuleApi.md @@ -1,4 +1,4 @@ -# TravelRuleBetaApi +# TravelRuleApi All URIs are relative to https://developers.fireblocks.com/reference/ @@ -10,13 +10,12 @@ Method | HTTP request | Description [**setVaspForVault**](#setVaspForVault) | **POST** /screening/travel_rule/vault/{vaultAccountId}/vasp | Assign VASP to vault [**updateVasp**](#updateVasp) | **PUT** /screening/travel_rule/vasp/update | Add jsonDidKey to VASP details [**validateFullTravelRuleTransaction**](#validateFullTravelRuleTransaction) | **POST** /screening/travel_rule/transaction/validate/full | Validate Full Travel Rule Transaction -[**validateTravelRuleTransaction**](#validateTravelRuleTransaction) | **POST** /screening/travel_rule/transaction/validate | Validate Travel Rule Transaction # **getVASPByDID** > TravelRuleVASP getVASPByDID() -Get VASP Details. Returns information about a VASP that has the specified DID. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). +Get VASP Details. Returns information about a VASP that has the specified DID. ### Example @@ -24,7 +23,7 @@ Get VASP Details. Returns information about a VASP that has the specified DID. ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiGetVASPByDIDRequest, TravelRuleVASP } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiGetVASPByDIDRequest, TravelRuleVASP } 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" @@ -33,14 +32,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiGetVASPByDIDRequest = { +let body: TravelRuleApiGetVASPByDIDRequest = { // string did: did_example, - // string | CSV of fields to return (all, \"blank\" or see list of all field names below) (optional) - fields: fields_example, + // TravelRuleFieldsEnum | A CSV of fields to return. Choose from the following options: (optional) + fields: param_value, }; -fireblocks.travelRuleBeta.getVASPByDID(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.getVASPByDID(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -51,7 +50,7 @@ fireblocks.travelRuleBeta.getVASPByDID(body).then((res: FireblocksResponse** | A CSV of fields to return. Choose from the following options: | (optional) defaults to undefined ### Return type @@ -80,7 +79,7 @@ No authorization required # **getVASPs** > TravelRuleGetAllVASPsResponse getVASPs() -Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). +Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. ### Example @@ -88,7 +87,7 @@ Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and re ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiGetVASPsRequest, TravelRuleGetAllVASPsResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiGetVASPsRequest, TravelRuleGetAllVASPsResponse } 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" @@ -97,18 +96,22 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiGetVASPsRequest = { - // string | Field to order by (optional) - order: order_example, +let body: TravelRuleApiGetVASPsRequest = { + // 'ASC' | 'DESC' | Field to order by (optional) + order: ASC, // number | Records per page (optional) - perPage: 8.14, - // number | Page number (optional) - page: 8.14, - // string | CSV of fields to return (all, \"blank\" or see list of all field names below) (optional) - fields: fields_example, + pageSize: 10, + // TravelRuleFieldsEnum | CSV of fields to return (all, \"blank\" or see list of all field names below) (optional) + fields: param_value, + // string | Search query (optional) + search: Fireblocks, + // 'TRUSTED' | 'BLOCKED' | 'MANUAL' | 'null' | Filter by the VASP\'s review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status). (optional) + reviewValue: TRUSTED, + // string | Cursor for pagination. When provided, the response will include the next page of results. (optional) + pageCursor: 100, }; -fireblocks.travelRuleBeta.getVASPs(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.getVASPs(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -118,10 +121,12 @@ fireblocks.travelRuleBeta.getVASPs(body).then((res: FireblocksResponse** | Field to order by | (optional) defaults to undefined + **pageSize** | [**number**] | Records per page | (optional) defaults to 500 + **fields** | **Array<'did' | 'name' | 'verificationStatus' | 'addressLine1' | 'addressLine2' | 'city' | 'country' | 'emailDomains' | 'website' | 'logo' | 'legalStructure' | 'legalName' | 'yearFounded' | 'incorporationCountry' | 'isRegulated' | 'otherNames' | 'identificationType' | 'identificationCountry' | 'businessNumber' | 'regulatoryAuthorities' | 'jurisdictions' | 'street' | 'number' | 'unit' | 'postCode' | 'state' | 'certificates' | 'description' | 'travelRule_OPENVASP' | 'travelRule_SYGNA' | 'travelRule_TRISA' | 'travelRule_TRLIGHT' | 'travelRule_EMAIL' | 'travelRule_TRP' | 'travelRule_SHYFT' | 'travelRule_USTRAVELRULEWG' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy' | 'lastSentDate' | 'lastReceivedDate' | 'documents' | 'hasAdmin' | 'isNotifiable' | 'issuers'>** | CSV of fields to return (all, \"blank\" or see list of all field names below) | (optional) defaults to undefined + **search** | [**string**] | Search query | (optional) defaults to undefined + **reviewValue** | [**'TRUSTED' | 'BLOCKED' | 'MANUAL' | 'null'**]**Array<'TRUSTED' | 'BLOCKED' | 'MANUAL' | 'null'>** | Filter by the VASP\'s review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status). | (optional) defaults to undefined + **pageCursor** | [**string**] | Cursor for pagination. When provided, the response will include the next page of results. | (optional) defaults to undefined ### Return type @@ -142,6 +147,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Get all VASPs | - | +**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) @@ -156,7 +162,7 @@ Get assigned VASP Did for a specific vault. Returns empty string vaspDid value i ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiGetVaspForVaultRequest, TravelRuleVaspForVault } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiGetVaspForVaultRequest, TravelRuleVaspForVault } 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,12 +171,12 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiGetVaspForVaultRequest = { +let body: TravelRuleApiGetVaspForVaultRequest = { // string | The ID of the vault account vaultAccountId: 1, }; -fireblocks.travelRuleBeta.getVaspForVault(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.getVaspForVault(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -216,7 +222,7 @@ Sets the VASP Did for a specific vault. Pass empty string to remove existing one ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiSetVaspForVaultRequest, TravelRuleVaspForVault } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiSetVaspForVaultRequest, TravelRuleVaspForVault } 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" @@ -225,7 +231,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiSetVaspForVaultRequest = { +let body: TravelRuleApiSetVaspForVaultRequest = { // TravelRuleVaspForVault travelRuleVaspForVault: param_value, // string | The ID of the vault account @@ -234,7 +240,7 @@ let body: TravelRuleBetaApiSetVaspForVaultRequest = { idempotencyKey: idempotencyKey_example, }; -fireblocks.travelRuleBeta.setVaspForVault(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.setVaspForVault(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -274,7 +280,7 @@ No authorization required # **updateVasp** > TravelRuleUpdateVASPDetails updateVasp(travelRuleUpdateVASPDetails) -Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). +Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene. ### Example @@ -282,7 +288,7 @@ Update VASP Details. Updates a VASP with the provided parameters. Use this endp ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiUpdateVaspRequest, TravelRuleUpdateVASPDetails } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiUpdateVaspRequest, TravelRuleUpdateVASPDetails } 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,14 +297,14 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiUpdateVaspRequest = { +let body: TravelRuleApiUpdateVaspRequest = { // TravelRuleUpdateVASPDetails travelRuleUpdateVASPDetails: 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.travelRuleBeta.updateVasp(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.updateVasp(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -338,7 +344,7 @@ No authorization required # **validateFullTravelRuleTransaction** > TravelRuleValidateTransactionResponse validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest) -Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). +Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. ### Example @@ -346,7 +352,7 @@ Validate Full Travel Rule transactions. Checks for all required information on ```typescript import { readFileSync } from 'fs'; import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiValidateFullTravelRuleTransactionRequest, TravelRuleValidateTransactionResponse } from '@fireblocks/ts-sdk'; +import type { FireblocksResponse, TravelRuleApiValidateFullTravelRuleTransactionRequest, TravelRuleValidateTransactionResponse } 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" @@ -355,14 +361,16 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf const fireblocks = new Fireblocks(); -let body: TravelRuleBetaApiValidateFullTravelRuleTransactionRequest = { +let body: TravelRuleApiValidateFullTravelRuleTransactionRequest = { // TravelRuleValidateFullTransactionRequest travelRuleValidateFullTransactionRequest: param_value, + // TravelRuleNotationEnum | Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - ``: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly. (optional) + notation: 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.travelRuleBeta.validateFullTravelRuleTransaction(body).then((res: FireblocksResponse) => { +fireblocks.travelRule.validateFullTravelRuleTransaction(body).then((res: FireblocksResponse) => { console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2)); }).catch((error:any) => console.error(error)); ``` @@ -373,6 +381,7 @@ fireblocks.travelRuleBeta.validateFullTravelRuleTransaction(body).then((res: Fir Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **travelRuleValidateFullTransactionRequest** | **[TravelRuleValidateFullTransactionRequest](../models/TravelRuleValidateFullTransactionRequest.md)**| | + **notation** | **Array<'fireblocks' | 'notabene'>** | Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly. | (optional) 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 @@ -394,72 +403,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Transaction validated successfully | - | -**400** | Invalid request body | - | -**500** | Internal server error | - | - -[[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) - -# **validateTravelRuleTransaction** -> TravelRuleValidateTransactionResponse validateTravelRuleTransaction(travelRuleValidateTransactionRequest) - -Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary\'s jurisdiction. **Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren\'t yet generally available. To enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com). - -### Example - - -```typescript -import { readFileSync } from 'fs'; -import { Fireblocks, BasePath } from '@fireblocks/ts-sdk'; -import type { FireblocksResponse, TravelRuleBetaApiValidateTravelRuleTransactionRequest, TravelRuleValidateTransactionResponse } 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: TravelRuleBetaApiValidateTravelRuleTransactionRequest = { - // TravelRuleValidateTransactionRequest - travelRuleValidateTransactionRequest: 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.travelRuleBeta.validateTravelRuleTransaction(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 -------------- | ------------- | ------------- | ------------- - **travelRuleValidateTransactionRequest** | **[TravelRuleValidateTransactionRequest](../models/TravelRuleValidateTransactionRequest.md)**| | - **idempotencyKey** | [**string**] | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | (optional) defaults to undefined - - -### Return type - -**[TravelRuleValidateTransactionResponse](../models/TravelRuleValidateTransactionResponse.md)** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Transaction validated successfully | - | -**400** | Invalid request body | - | -**500** | Internal server error | - | +**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/models/TravelRuleAddress.md b/docs/models/TravelRuleAddress.md index b631627..2cc1732 100644 --- a/docs/models/TravelRuleAddress.md +++ b/docs/models/TravelRuleAddress.md @@ -4,10 +4,10 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**street** | **string** | Street address | [default to undefined]| -|**city** | **string** | City | [default to undefined]| -|**state** | **string** | State or province | [default to undefined]| -|**postalCode** | **string** | Postal or ZIP code | [default to undefined]| +|**street** | **string** | Street address | [optional] [default to undefined]| +|**city** | **string** | City | [optional] [default to undefined]| +|**state** | **string** | State or province | [optional] [default to undefined]| +|**postalCode** | **string** | Postal or ZIP code | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleCreateTransactionRequest.md b/docs/models/TravelRuleCreateTransactionRequest.md index bdbccc4..dbf6f2a 100644 --- a/docs/models/TravelRuleCreateTransactionRequest.md +++ b/docs/models/TravelRuleCreateTransactionRequest.md @@ -4,19 +4,26 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**originator** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Information about the originator of the transaction | [default to undefined]| -|**beneficiary** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Information about the beneficiary of the transaction | [default to undefined]| -|**originatorVASPdid** | **string** | The VASP ID of the transaction originator | [optional] [default to undefined]| -|**beneficiaryVASPdid** | **string** | The VASP ID of the transaction beneficiary | [optional] [default to undefined]| -|**beneficiaryVASPname** | **string** | The name of the VASP acting as the beneficiary | [optional] [default to undefined]| -|**transactionBlockchainInfo** | [**TravelRuleTransactionBlockchainInfo**](TravelRuleTransactionBlockchainInfo.md) | Information about the blockchain transaction | [optional] [default to undefined]| -|**encrypted** | **string** | Encrypted data related to the transaction | [optional] [default to undefined]| -|**protocol** | **string** | The protocol used to perform the travel rule | [optional] [default to undefined]| -|**skipBeneficiaryDataValidation** | **boolean** | Whether to skip validation of beneficiary data | [optional] [default to undefined]| -|**travelRuleBehavior** | **boolean** | Whether to check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction | [optional] [default to undefined]| -|**originatorProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | Ownership proof related to the originator of the transaction | [optional] [default to undefined]| -|**beneficiaryProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | Ownership proof related to the beneficiary of the transaction | [optional] [default to undefined]| -|**pii** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Personal identifiable information related to the transaction | [optional] [default to undefined]| +|**originator** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | | [default to undefined]| +|**beneficiary** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | | [default to undefined]| +|**originatorVASPdid** | **string** | The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. | [optional] [default to undefined]| +|**beneficiaryVASPdid** | **string** | The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. | [optional] [default to undefined]| +|**originatorVASPname** | **string** | The name of the VASP acting as the transaction originator. | [optional] [default to undefined]| +|**beneficiaryVASPname** | **string** | The name of the VASP acting as the transaction beneficiary. | [optional] [default to undefined]| +|**beneficiaryVASPwebsite** | **string** | The website of the VASP acting as the transaction beneficiary. | [optional] [default to undefined]| +|**transactionBlockchainInfo** | [**TravelRuleTransactionBlockchainInfo**](TravelRuleTransactionBlockchainInfo.md) | | [optional] [default to undefined]| +|**encrypted** | **string** | Encrypted data related to the transaction. | [optional] [default to undefined]| +|**protocol** | **string** | The protocol used to perform the travel rule. | [optional] [default to undefined]| +|**skipBeneficiaryDataValidation** | **boolean** | Whether to skip validation of beneficiary data. | [optional] [default to undefined]| +|**travelRuleBehavior** | **boolean** | Whether to check if the transaction complies with the travel rule in the beneficiary VASP\'s jurisdiction. | [optional] [default to undefined]| +|**originatorRef** | **string** | A reference ID related to the originator of the transaction. | [optional] [default to undefined]| +|**beneficiaryRef** | **string** | A reference ID related to the beneficiary of the transaction. | [optional] [default to undefined]| +|**travelRuleBehaviorRef** | **string** | A reference ID related to the travel rule behavior. | [optional] [default to undefined]| +|**originatorProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | | [optional] [default to undefined]| +|**beneficiaryProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | | [optional] [default to undefined]| +|**beneficiaryDid** | **string** | The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. | [optional] [default to undefined]| +|**originatorDid** | **string** | The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. | [optional] [default to undefined]| +|**isNonCustodial** | **boolean** | Indicates if the transaction involves a non-custodial wallet. | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleDateAndPlaceOfBirth.md b/docs/models/TravelRuleDateAndPlaceOfBirth.md new file mode 100644 index 0000000..3c5c0e6 --- /dev/null +++ b/docs/models/TravelRuleDateAndPlaceOfBirth.md @@ -0,0 +1,13 @@ +# TravelRuleDateAndPlaceOfBirth + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**dateOfBirth** | **string** | Date of birth. The value must be encrypted. | [optional] [default to undefined]| +|**placeOfBirth** | **string** | Place of birth. The value must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleFieldsEnum.md b/docs/models/TravelRuleFieldsEnum.md new file mode 100644 index 0000000..f0f27c4 --- /dev/null +++ b/docs/models/TravelRuleFieldsEnum.md @@ -0,0 +1,11 @@ +# TravelRuleFieldsEnum + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleGeographicAddress.md b/docs/models/TravelRuleGeographicAddress.md new file mode 100644 index 0000000..3acda0d --- /dev/null +++ b/docs/models/TravelRuleGeographicAddress.md @@ -0,0 +1,27 @@ +# TravelRuleGeographicAddress + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**streetName** | **string** | Name of a street or thoroughfare. The value must be encrypted. | [optional] [default to undefined]| +|**townName** | **string** | Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted. | [optional] [default to undefined]| +|**country** | **string** | Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted. | [optional] [default to undefined]| +|**buildingNumber** | **string** | Number that identifies the position of a building on a street. The value must be encrypted. | [optional] [default to undefined]| +|**postCode** | **string** | Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted. | [optional] [default to undefined]| +|**addressType** | **string** | Specifies the type of address. Acceptable values are: - \'HOME\': Residential, the home address - \'BIZZ\': Business, the business address - \'GEOG\': Geographic, an unspecified physical (geographical) address The value must be encrypted. | [optional] [default to undefined]| +|**department** | **string** | Identification of a division of a large organisation or building. The value must be encrypted. | [optional] [default to undefined]| +|**subDepartment** | **string** | Identification of a sub-division of a large organisation or building. The value must be encrypted. | [optional] [default to undefined]| +|**buildingName** | **string** | Name of the building or house. The value must be encrypted. | [optional] [default to undefined]| +|**floor** | **string** | Floor or storey within a building. The value must be encrypted. | [optional] [default to undefined]| +|**postBox** | **string** | Numbered box in a post office. The value must be encrypted. | [optional] [default to undefined]| +|**room** | **string** | Building room number. The value must be encrypted. | [optional] [default to undefined]| +|**townLocationName** | **string** | Specific location name within the town. The value must be encrypted. | [optional] [default to undefined]| +|**districtName** | **string** | Identifies a subdivision within a country subdivision. The value must be encrypted. | [optional] [default to undefined]| +|**countrySubDivision** | **string** | Identifies a subdivision of a country such as state, region, or province. The value must be encrypted. | [optional] [default to undefined]| +|**addressLine** | **Array<string>** | Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleGetAllVASPsResponse.md b/docs/models/TravelRuleGetAllVASPsResponse.md index 7ade7bd..f078be7 100644 --- a/docs/models/TravelRuleGetAllVASPsResponse.md +++ b/docs/models/TravelRuleGetAllVASPsResponse.md @@ -4,7 +4,9 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**vasps** | [**Array<TravelRuleVASP>**](TravelRuleVASP.md) | | [default to undefined]| +|**data** | [**Array<TravelRuleVASP>**](TravelRuleVASP.md) | An array of VASP objects, referencing the TravelRuleVASP schema. | [default to undefined]| +|**total** | **number** | The total number of VASPs. | [optional] [default to undefined]| +|**next** | **string** | The URL for the next page of results. | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleLegalPerson.md b/docs/models/TravelRuleLegalPerson.md new file mode 100644 index 0000000..34f7fcb --- /dev/null +++ b/docs/models/TravelRuleLegalPerson.md @@ -0,0 +1,17 @@ +# TravelRuleLegalPerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**name** | [**TravelRuleLegalPersonNameIdentifier**](TravelRuleLegalPersonNameIdentifier.md) | | [optional] [default to undefined]| +|**geographicAddress** | [**Array<TravelRuleGeographicAddress>**](TravelRuleGeographicAddress.md) | The array of geographic addresses associated with the legal person. | [optional] [default to undefined]| +|**nationalIdentification** | [**TravelRuleNationalIdentification**](TravelRuleNationalIdentification.md) | | [optional] [default to undefined]| +|**customerIdentification** | **string** | A unique identifier that identifies the customer in the organization\'s context. The value must be encrypted. | [optional] [default to undefined]| +|**customerNumber** | **string** | A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted. | [optional] [default to undefined]| +|**countryOfRegistration** | **string** | The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleLegalPersonNameIdentifier.md b/docs/models/TravelRuleLegalPersonNameIdentifier.md new file mode 100644 index 0000000..17fd5fd --- /dev/null +++ b/docs/models/TravelRuleLegalPersonNameIdentifier.md @@ -0,0 +1,13 @@ +# TravelRuleLegalPersonNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**legalPersonName** | **string** | Name by which the legal person is known. The value must be encrypted. | [optional] [default to undefined]| +|**legalPersonNameIdentifierType** | **string** | Specifies the type of name for a legal person. Acceptable values are: - \'REGISTERED\': The official registered name. - \'TRADE\': A trading name or DBA (Doing Business As) name. - \'OTHER\': Any other type of name. The value must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleNationalIdentification.md b/docs/models/TravelRuleNationalIdentification.md new file mode 100644 index 0000000..b73893d --- /dev/null +++ b/docs/models/TravelRuleNationalIdentification.md @@ -0,0 +1,15 @@ +# TravelRuleNationalIdentification + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**countryOfIssue** | **string** | Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted. | [optional] [default to undefined]| +|**nationalIdentifier** | **string** | National identifier (max 35 characters). The value must be encrypted. | [optional] [default to undefined]| +|**nationalIdentifierType** | **string** | Type of national identifier. Acceptable values include: - \'PASSPORT\': Passport number - \'NATIONAL_ID\': National identification number - \'TAX_ID\': Tax identification number - \'SOCIAL_SECURITY\': Social security number The value must be encrypted. | [optional] [default to undefined]| +|**registrationAuthority** | **string** | Registration authority (format -> RA followed by 6 digits). The value must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleNaturalNameIdentifier.md b/docs/models/TravelRuleNaturalNameIdentifier.md new file mode 100644 index 0000000..bd80c76 --- /dev/null +++ b/docs/models/TravelRuleNaturalNameIdentifier.md @@ -0,0 +1,14 @@ +# TravelRuleNaturalNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**primaryIdentifier** | **string** | The primary identifier of the name. The value must be encrypted. | [optional] [default to undefined]| +|**secondaryIdentifier** | **string** | The secondary identifier of the name. The value must be encrypted. | [optional] [default to undefined]| +|**nameIdentifierType** | **string** | The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR]. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleNaturalPerson.md b/docs/models/TravelRuleNaturalPerson.md new file mode 100644 index 0000000..0326ed1 --- /dev/null +++ b/docs/models/TravelRuleNaturalPerson.md @@ -0,0 +1,18 @@ +# TravelRuleNaturalPerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**name** | [**Array<TravelRuleNaturalPersonNameIdentifier>**](TravelRuleNaturalPersonNameIdentifier.md) | An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema. | [optional] [default to undefined]| +|**geographicAddress** | [**Array<TravelRuleGeographicAddress>**](TravelRuleGeographicAddress.md) | An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema. | [optional] [default to undefined]| +|**nationalIdentification** | [**TravelRuleNationalIdentification**](TravelRuleNationalIdentification.md) | | [optional] [default to undefined]| +|**dateAndPlaceOfBirth** | [**TravelRuleDateAndPlaceOfBirth**](TravelRuleDateAndPlaceOfBirth.md) | | [optional] [default to undefined]| +|**customerIdentification** | **string** | A unique identifier for the customer within the organization\'s context. The value must be encrypted. | [optional] [default to undefined]| +|**countryOfResidence** | **string** | The ISO-3166 Alpha-2 country code of the natural person\'s residence. The value must be encrypted. | [optional] [default to undefined]| +|**customerNumber** | **string** | A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleNaturalPersonNameIdentifier.md b/docs/models/TravelRuleNaturalPersonNameIdentifier.md new file mode 100644 index 0000000..9aadecb --- /dev/null +++ b/docs/models/TravelRuleNaturalPersonNameIdentifier.md @@ -0,0 +1,14 @@ +# TravelRuleNaturalPersonNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**nameIdentifier** | [**Array<TravelRuleNaturalNameIdentifier>**](TravelRuleNaturalNameIdentifier.md) | | [optional] [default to undefined]| +|**localNameIdentifier** | [**Array<TravelRuleNaturalNameIdentifier>**](TravelRuleNaturalNameIdentifier.md) | | [optional] [default to undefined]| +|**phoneticNameIdentifier** | [**Array<TravelRuleNaturalNameIdentifier>**](TravelRuleNaturalNameIdentifier.md) | | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleNotationEnum.md b/docs/models/TravelRuleNotationEnum.md new file mode 100644 index 0000000..1c292c5 --- /dev/null +++ b/docs/models/TravelRuleNotationEnum.md @@ -0,0 +1,11 @@ +# TravelRuleNotationEnum + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleOwnershipProof.md b/docs/models/TravelRuleOwnershipProof.md index 0f830b4..6430d18 100644 --- a/docs/models/TravelRuleOwnershipProof.md +++ b/docs/models/TravelRuleOwnershipProof.md @@ -4,8 +4,13 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**type** | **string** | Type of ownership proof | [optional] [default to undefined]| -|**proof** | **string** | Identification number | [optional] [default to undefined]| +|**type** | **string** | The type of ownership proof. Example values: - `eip-191`: Ethereum signature proof - `eip-712`: Ethereum typed data signature proof - `bip-137`: Bitcoin signature proof - `microtransfer`: Microtransaction (Satoshi test) - `screenshot`: Uploaded screenshot of the wallet - `self-declaration`: Checkbox attestation of ownership | [optional] [default to undefined]| +|**proof** | **string** | The cryptographic signature, transaction hash, or other proof depending on the type. Examples: - For `eip-191`: `0x3dd4a17a...ce4a2bcd1b` - For `microtransfer`: The transaction hash `H3V8GXBy39Dz...tr3TSTkY=` | [optional] [default to undefined]| +|**attestation** | **string** | A human-readable statement of wallet ownership. Required for signature proofs and self-declarations. Examples: - `I certify that ETH account 0x896B...0b9b belongs to me.` - `I hereby declare that the blockchain address 0xa437bEed902AF9338B7DEB23848e195d85019510 is under my control.` | [optional] [default to undefined]| +|**address** | **string** | The wallet address being verified. Examples: - For Ethereum: `0x896B...0b9b` - For Bitcoin: `1442...dxhsQ` | [optional] [default to undefined]| +|**wallet_provider** | **string** | The wallet provider or method used for verification. Examples: - For Metamask: `Metamask` - For manual signature: `manual` | [optional] [default to undefined]| +|**url** | **string** | The URL for the uploaded screenshot (for `screenshot` proof types only). Example: `https://example.com/uploaded_image.png` | [optional] [default to undefined]| +|**confirmed** | **boolean** | Whether the user confirmed ownership of the wallet (for `self-declaration` proofs). Example: `true` | [optional] [default to undefined]| diff --git a/docs/models/TravelRulePerson.md b/docs/models/TravelRulePerson.md new file mode 100644 index 0000000..5da41ce --- /dev/null +++ b/docs/models/TravelRulePerson.md @@ -0,0 +1,13 @@ +# TravelRulePerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**naturalPerson** | [**TravelRuleNaturalPerson**](TravelRuleNaturalPerson.md) | | [optional] [default to undefined]| +|**legalPerson** | [**TravelRuleLegalPerson**](TravelRuleLegalPerson.md) | | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRulePiiIVMS.md b/docs/models/TravelRulePiiIVMS.md index 4dd8b03..49fe853 100644 --- a/docs/models/TravelRulePiiIVMS.md +++ b/docs/models/TravelRulePiiIVMS.md @@ -4,15 +4,9 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**fullName** | **string** | | [optional] [default to undefined]| -|**dateOfBirth** | **string** | | [optional] [default to undefined]| -|**placeOfBirth** | **string** | | [optional] [default to undefined]| -|**address** | **string** | | [optional] [default to undefined]| -|**identificationNumber** | **string** | | [optional] [default to undefined]| -|**nationality** | **string** | | [optional] [default to undefined]| -|**countryOfResidence** | **string** | | [optional] [default to undefined]| -|**taxIdentificationNumber** | **string** | | [optional] [default to undefined]| -|**customerNumber** | **string** | | [optional] [default to undefined]| +|**originatorPersons** | [**Array<TravelRulePerson>**](TravelRulePerson.md) | Information about the originator of the transaction | [optional] [default to undefined]| +|**beneficiaryPersons** | [**Array<TravelRulePerson>**](TravelRulePerson.md) | Information about the beneficiary of the transaction | [optional] [default to undefined]| +|**accountNumber** | **Array<string>** | Beneficiary account number. The value must be encrypted. | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleTransactionBlockchainInfo.md b/docs/models/TravelRuleTransactionBlockchainInfo.md index 7019482..3cdf94a 100644 --- a/docs/models/TravelRuleTransactionBlockchainInfo.md +++ b/docs/models/TravelRuleTransactionBlockchainInfo.md @@ -4,9 +4,9 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**txHash** | **string** | | [optional] [default to undefined]| -|**origin** | **string** | | [optional] [default to undefined]| -|**destination** | **string** | | [optional] [default to undefined]| +|**txHash** | **string** | The hash of the transaction | [optional] [default to undefined]| +|**origin** | **string** | The origin address of the transaction | [optional] [default to undefined]| +|**destination** | **string** | The destination address of the transaction | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleVASP.md b/docs/models/TravelRuleVASP.md index ab48c56..ba2491b 100644 --- a/docs/models/TravelRuleVASP.md +++ b/docs/models/TravelRuleVASP.md @@ -4,52 +4,52 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**did** | **string** | | [default to undefined]| -|**name** | **string** | | [default to undefined]| -|**verificationStatus** | **string** | | [default to undefined]| -|**addressLine1** | **string** | | [default to undefined]| -|**addressLine2** | **string** | | [default to undefined]| -|**city** | **string** | | [default to undefined]| -|**country** | **string** | | [default to undefined]| -|**emailDomains** | **string** | | [default to undefined]| -|**website** | **string** | | [default to undefined]| -|**logo** | **string** | | [default to undefined]| -|**legalStructure** | **string** | | [default to undefined]| -|**legalName** | **string** | | [default to undefined]| -|**yearFounded** | **string** | | [default to undefined]| -|**incorporationCountry** | **string** | | [default to undefined]| -|**isRegulated** | **string** | | [default to undefined]| -|**otherNames** | **string** | | [default to undefined]| -|**identificationType** | **string** | | [default to undefined]| -|**identificationCountry** | **string** | | [default to undefined]| -|**businessNumber** | **string** | | [default to undefined]| -|**regulatoryAuthorities** | **string** | | [default to undefined]| -|**jurisdictions** | **string** | | [default to undefined]| -|**street** | **string** | | [default to undefined]| -|**number** | **string** | | [default to undefined]| -|**unit** | **string** | | [default to undefined]| -|**postCode** | **string** | | [default to undefined]| -|**state** | **string** | | [default to undefined]| -|**certificates** | **string** | | [default to undefined]| -|**description** | **string** | | [default to undefined]| -|**travelRule_OPENVASP** | **string** | | [default to undefined]| -|**travelRule_SYGNA** | **string** | | [default to undefined]| -|**travelRule_TRISA** | **string** | | [default to undefined]| -|**travelRule_TRLIGHT** | **string** | | [default to undefined]| -|**travelRule_EMAIL** | **string** | | [default to undefined]| -|**travelRule_TRP** | **string** | | [default to undefined]| -|**travelRule_SHYFT** | **string** | | [default to undefined]| -|**travelRule_USTRAVELRULEWG** | **string** | | [default to undefined]| -|**createdAt** | **string** | | [default to undefined]| -|**createdBy** | **string** | | [default to undefined]| -|**updatedAt** | **string** | | [default to undefined]| -|**updatedBy** | **string** | | [default to undefined]| -|**lastSentDate** | **string** | | [default to undefined]| -|**lastReceivedDate** | **string** | | [default to undefined]| -|**documents** | **string** | | [default to undefined]| -|**hasAdmin** | **boolean** | | [default to undefined]| -|**isNotifiable** | **boolean** | | [default to undefined]| +|**did** | **string** | The Decentralized Identifier (DID) of the VASP. | [default to undefined]| +|**name** | **string** | The name of the VASP. | [default to undefined]| +|**verificationStatus** | **string** | The current verification status of the VASP. | [default to undefined]| +|**addressLine1** | **string** | The first line of the VASP\'s address. | [default to undefined]| +|**city** | **string** | The city where the VASP is located. | [default to undefined]| +|**country** | **string** | The country where the VASP is registered (ISO-3166 Alpha-2 code). | [default to undefined]| +|**emailDomains** | **string** | Comma-separated list of email domains associated with the VASP. | [default to undefined]| +|**website** | **string** | The official website of the VASP. | [default to undefined]| +|**legalStructure** | **string** | The legal structure of the VASP (e.g., Corporation, LLC). | [default to undefined]| +|**legalName** | **string** | The legal name of the VASP. | [default to undefined]| +|**yearFounded** | **string** | The year the VASP was founded. | [default to undefined]| +|**incorporationCountry** | **string** | The country where the VASP is incorporated (ISO-3166 Alpha-2 code). | [default to undefined]| +|**isRegulated** | **string** | Indicates whether the VASP is regulated. | [default to undefined]| +|**jurisdictions** | **string** | The jurisdictions where the VASP operates. | [default to undefined]| +|**travelRule_TRLIGHT** | **string** | Travel rule compliance status for TRLight. | [default to undefined]| +|**createdAt** | **string** | Timestamp when the VASP record was created. | [default to undefined]| +|**hasAdmin** | **boolean** | Indicates if the VASP has an admin. | [default to undefined]| +|**isNotifiable** | **boolean** | Indicates if the VASP is notifiable for compliance reasons. | [default to undefined]| |**issuers** | [**TravelRuleIssuers**](TravelRuleIssuers.md) | | [default to undefined]| +|**addressLine2** | **string** | The second line of the VASP\'s address (if applicable). | [optional] [default to undefined]| +|**logo** | **string** | URL to the logo of the VASP. | [optional] [default to undefined]| +|**otherNames** | **string** | Other names the VASP is known by. | [optional] [default to undefined]| +|**identificationType** | **string** | The type of identification used by the VASP. | [optional] [default to undefined]| +|**identificationCountry** | **string** | The country of identification for the VASP (ISO-3166 Alpha-2 code). | [optional] [default to undefined]| +|**businessNumber** | **string** | The business registration number of the VASP. | [optional] [default to undefined]| +|**regulatoryAuthorities** | **string** | The regulatory authorities overseeing the VASP. | [optional] [default to undefined]| +|**street** | **string** | The street name where the VASP is located. | [optional] [default to undefined]| +|**number** | **string** | The building number of the VASP\'s address. | [optional] [default to undefined]| +|**unit** | **string** | The unit or suite number of the VASP\'s address. | [optional] [default to undefined]| +|**postCode** | **string** | The postal code of the VASP\'s location. | [optional] [default to undefined]| +|**state** | **string** | The state or region where the VASP is located. | [optional] [default to undefined]| +|**certificates** | **string** | Certificates or licenses held by the VASP. | [optional] [default to undefined]| +|**description** | **string** | A brief description of the VASP. | [optional] [default to undefined]| +|**travelRule_OPENVASP** | **string** | Travel rule compliance status for OpenVASP. | [optional] [default to undefined]| +|**travelRule_SYGNA** | **string** | Travel rule compliance status for Sygna. | [optional] [default to undefined]| +|**travelRule_TRISA** | **string** | Travel rule compliance status for TRISA. | [optional] [default to undefined]| +|**travelRule_EMAIL** | **string** | Travel rule compliance status for EMAIL. | [optional] [default to undefined]| +|**travelRule_TRP** | **string** | Travel rule compliance status for TRP. | [optional] [default to undefined]| +|**travelRule_SHYFT** | **string** | Travel rule compliance status for Shyft. | [optional] [default to undefined]| +|**travelRule_USTRAVELRULEWG** | **string** | Travel rule compliance status for US Travel Rule WG. | [optional] [default to undefined]| +|**createdBy** | **string** | User or system that created the VASP record. | [optional] [default to undefined]| +|**updatedAt** | **string** | Timestamp of the last update to the VASP record. | [optional] [default to undefined]| +|**updatedBy** | **string** | User or system that last updated the VASP record. | [optional] [default to undefined]| +|**lastSentDate** | **string** | The last date a transaction was sent by the VASP. | [optional] [default to undefined]| +|**lastReceivedDate** | **string** | The last date a transaction was received by the VASP. | [optional] [default to undefined]| +|**documents** | **string** | Documents associated with the VASP. | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleValidateDateAndPlaceOfBirth.md b/docs/models/TravelRuleValidateDateAndPlaceOfBirth.md new file mode 100644 index 0000000..42e6d18 --- /dev/null +++ b/docs/models/TravelRuleValidateDateAndPlaceOfBirth.md @@ -0,0 +1,13 @@ +# TravelRuleValidateDateAndPlaceOfBirth + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**dateOfBirth** | **string** | Date of birth in ISO 8601 format (YYYY-MM-DD) | [optional] [default to undefined]| +|**placeOfBirth** | **string** | Place of birth | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidateFullTransactionRequest.md b/docs/models/TravelRuleValidateFullTransactionRequest.md index 3275a84..2bdaf5f 100644 --- a/docs/models/TravelRuleValidateFullTransactionRequest.md +++ b/docs/models/TravelRuleValidateFullTransactionRequest.md @@ -4,24 +4,41 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**originator** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Information about the originator of the transaction | [default to undefined]| -|**beneficiary** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Information about the beneficiary of the transaction | [default to undefined]| -|**transactionAsset** | **string** | The asset involved in the transaction | [optional] [default to undefined]| -|**transactionAmount** | **string** | The amount of the transaction | [optional] [default to undefined]| -|**originatorDid** | **string** | The DID of the transaction originator | [optional] [default to undefined]| -|**beneficiaryDid** | **string** | The DID of the transaction beneficiary | [optional] [default to undefined]| -|**originatorVASPdid** | **string** | The VASP ID of the transaction originator | [optional] [default to undefined]| -|**beneficiaryVASPdid** | **string** | The VASP ID of the transaction beneficiary | [optional] [default to undefined]| -|**beneficiaryVASPname** | **string** | The name of the VASP acting as the beneficiary | [optional] [default to undefined]| -|**transactionBlockchainInfo** | [**TravelRuleTransactionBlockchainInfo**](TravelRuleTransactionBlockchainInfo.md) | Information about the blockchain transaction | [optional] [default to undefined]| -|**encrypted** | **string** | Encrypted data related to the transaction | [optional] [default to undefined]| -|**protocol** | **string** | The protocol used to perform the travel rule | [optional] [default to undefined]| +|**originator** | [**TravelRuleValidatePiiIVMS**](TravelRuleValidatePiiIVMS.md) | | [default to undefined]| +|**beneficiary** | [**TravelRuleValidatePiiIVMS**](TravelRuleValidatePiiIVMS.md) | | [default to undefined]| +|**originatorVASPdid** | **string** | The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. | [optional] [default to undefined]| +|**beneficiaryVASPdid** | **string** | The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. | [optional] [default to undefined]| +|**transactionAsset** | **string** | Transaction asset symbol (e.g., BTC, ETH, USDC). By using the `notation` query string, users can select the type of asset notation: - `fireblocks`: Converts asset symbols to Fireblocks notation. - `notabene`: Retains the original Notabene asset symbol format. | [optional] [default to undefined]| +|**transactionAmount** | **string** | Transaction amount in the transaction asset. For example, if the asset is BTC, the amount is the value in BTC units. By using the `notation` query string, users can select the type of amount notation: - `fireblocks`: Converts the amount to Fireblocks notation (e.g., adjusted for decimals). - `notabene`: Retains the original Notabene amount format. | [optional] [default to undefined]| +|**originatorVASPname** | **string** | The name of the VASP acting as the transaction originator. | [optional] [default to undefined]| +|**beneficiaryVASPname** | **string** | The name of the VASP acting as the transaction beneficiary. | [optional] [default to undefined]| +|**transactionBlockchainInfo** | [**TravelRuleTransactionBlockchainInfo**](TravelRuleTransactionBlockchainInfo.md) | | [optional] [default to undefined]| +|**encrypted** | **string** | Encrypted data related to the transaction. | [optional] [default to undefined]| +|**protocol** | **string** | The protocol used to perform the travel rule. | [optional] [default to undefined]| +|**skipBeneficiaryDataValidation** | **boolean** | Whether to skip validation of beneficiary data. | [optional] [default to undefined]| +|**travelRuleBehavior** | **boolean** | Whether to check if the transaction complies with the travel rule in the beneficiary VASP\'s jurisdiction. | [optional] [default to undefined]| +|**originatorRef** | **string** | A reference ID related to the originator of the transaction. | [optional] [default to undefined]| +|**beneficiaryRef** | **string** | A reference ID related to the beneficiary of the transaction. | [optional] [default to undefined]| +|**travelRuleBehaviorRef** | **string** | A reference ID related to the travel rule behavior. | [optional] [default to undefined]| +|**originatorProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | | [optional] [default to undefined]| +|**beneficiaryProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | | [optional] [default to undefined]| +|**beneficiaryDid** | **string** | The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. | [optional] [default to undefined]| +|**originatorDid** | **string** | The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. | [optional] [default to undefined]| +|**isNonCustodial** | **boolean** | Indicates if the transaction involves a non-custodial wallet. | [optional] [default to undefined]| |**notificationEmail** | **string** | The email address where a notification should be sent upon completion of the travel rule | [optional] [default to undefined]| -|**skipBeneficiaryDataValidation** | **boolean** | Whether to skip validation of beneficiary data | [optional] [default to undefined]| -|**travelRuleBehavior** | **boolean** | Whether to check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction | [optional] [default to undefined]| -|**originatorProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | Ownership proof related to the originator of the transaction | [optional] [default to undefined]| -|**beneficiaryProof** | [**TravelRuleOwnershipProof**](TravelRuleOwnershipProof.md) | Ownership proof related to the beneficiary of the transaction | [optional] [default to undefined]| -|**pii** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | Personal identifiable information related to the transaction | [optional] [default to undefined]| +|**pii** | [**TravelRulePiiIVMS**](TravelRulePiiIVMS.md) | | [optional] [default to undefined]| +|**pii_url** | **string** | The URL of the personal identifiable information related to the transaction | [optional] [default to undefined]| + + +## Enum: TravelRuleValidateFullTransactionRequestProtocolEnum + + +* `TrLight` (value: `'TRLight'`) + +* `Trp` (value: `'TRP'`) + +* `OpenVasp` (value: `'OpenVASP'`) + diff --git a/docs/models/TravelRuleValidateGeographicAddress.md b/docs/models/TravelRuleValidateGeographicAddress.md new file mode 100644 index 0000000..0d78849 --- /dev/null +++ b/docs/models/TravelRuleValidateGeographicAddress.md @@ -0,0 +1,38 @@ +# TravelRuleValidateGeographicAddress + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**streetName** | **string** | Name of a street or thoroughfare | [optional] [default to undefined]| +|**townName** | **string** | Name of a built-up area, with defined boundaries, and a local government | [optional] [default to undefined]| +|**country** | **string** | Nation with its own government (ISO-3166 Alpha-2 country code) | [optional] [default to undefined]| +|**buildingNumber** | **string** | Number that identifies the position of a building on a street | [optional] [default to undefined]| +|**postCode** | **string** | Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail | [optional] [default to undefined]| +|**addressType** | **string** | Specifies the type of address. Acceptable values are: - \'HOME\': Residential, the home address - \'BIZZ\': Business, the business address - \'GEOG\': Geographic, an unspecified physical (geographical) address | [optional] [default to undefined]| +|**department** | **string** | Identification of a division of a large organisation or building | [optional] [default to undefined]| +|**subDepartment** | **string** | Identification of a sub-division of a large organisation or building | [optional] [default to undefined]| +|**buildingName** | **string** | Name of the building or house | [optional] [default to undefined]| +|**floor** | **string** | Floor or storey within a building | [optional] [default to undefined]| +|**postBox** | **string** | Numbered box in a post office | [optional] [default to undefined]| +|**room** | **string** | Building room number | [optional] [default to undefined]| +|**townLocationName** | **string** | Specific location name within the town | [optional] [default to undefined]| +|**districtName** | **string** | Identifies a subdivision within a country subdivision | [optional] [default to undefined]| +|**countrySubDivision** | **string** | Identifies a subdivision of a country such as state, region, or province | [optional] [default to undefined]| +|**addressLine** | **Array<string>** | Information that locates and identifies a specific address, presented in free format text | [optional] [default to undefined]| + + +## Enum: TravelRuleValidateGeographicAddressAddressTypeEnum + + +* `Home` (value: `'HOME'`) + +* `Bizz` (value: `'BIZZ'`) + +* `Geog` (value: `'GEOG'`) + + + + + +[[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/TravelRuleValidateLegalPerson.md b/docs/models/TravelRuleValidateLegalPerson.md new file mode 100644 index 0000000..708badc --- /dev/null +++ b/docs/models/TravelRuleValidateLegalPerson.md @@ -0,0 +1,17 @@ +# TravelRuleValidateLegalPerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**name** | [**TravelRuleValidateLegalPersonNameIdentifier**](TravelRuleValidateLegalPersonNameIdentifier.md) | | [optional] [default to undefined]| +|**geographicAddress** | [**Array<TravelRuleValidateGeographicAddress>**](TravelRuleValidateGeographicAddress.md) | The array of geographic addresses associated with the legal person. | [optional] [default to undefined]| +|**nationalIdentification** | [**TravelRuleValidateNationalIdentification**](TravelRuleValidateNationalIdentification.md) | | [optional] [default to undefined]| +|**customerIdentification** | **string** | A unique identifier that identifies the customer in the organization\'s context. | [optional] [default to undefined]| +|**customerNumber** | **string** | A distinct identifier that uniquely identifies the customer within the organization. | [optional] [default to undefined]| +|**countryOfRegistration** | **string** | The ISO-3166 Alpha-2 country code where the legal person is registered. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidateLegalPersonNameIdentifier.md b/docs/models/TravelRuleValidateLegalPersonNameIdentifier.md new file mode 100644 index 0000000..e9e47ba --- /dev/null +++ b/docs/models/TravelRuleValidateLegalPersonNameIdentifier.md @@ -0,0 +1,24 @@ +# TravelRuleValidateLegalPersonNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**legalPersonName** | **string** | Name by which the legal person is known. | [optional] [default to undefined]| +|**legalPersonNameIdentifierType** | **string** | Specifies the type of name for a legal person. Acceptable values are: - \'REGISTERED\': The official registered name. - \'TRADE\': A trading name or DBA (Doing Business As) name. - \'OTHER\': Any other type of name. | [optional] [default to undefined]| + + +## Enum: TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum + + +* `Registered` (value: `'REGISTERED'`) + +* `Trade` (value: `'TRADE'`) + +* `Other` (value: `'OTHER'`) + + + + + +[[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/TravelRuleValidateNationalIdentification.md b/docs/models/TravelRuleValidateNationalIdentification.md new file mode 100644 index 0000000..38b8b50 --- /dev/null +++ b/docs/models/TravelRuleValidateNationalIdentification.md @@ -0,0 +1,28 @@ +# TravelRuleValidateNationalIdentification + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**countryOfIssue** | **string** | Country that issued the national identifier (ISO-3166 Alpha-2 country code) | [optional] [default to undefined]| +|**nationalIdentifier** | **string** | National identifier (max 35 characters) | [optional] [default to undefined]| +|**nationalIdentifierType** | **string** | Type of national identifier. Acceptable values include: - \'PASSPORT\': Passport number - \'NATIONAL_ID\': National identification number - \'TAX_ID\': Tax identification number - \'SOCIAL_SECURITY\': Social security number | [optional] [default to undefined]| +|**registrationAuthority** | **string** | Registration authority (format -> RA followed by 6 digits) | [optional] [default to undefined]| + + +## Enum: TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum + + +* `Passport` (value: `'PASSPORT'`) + +* `NationalId` (value: `'NATIONAL_ID'`) + +* `TaxId` (value: `'TAX_ID'`) + +* `SocialSecurity` (value: `'SOCIAL_SECURITY'`) + + + + + +[[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/TravelRuleValidateNaturalNameIdentifier.md b/docs/models/TravelRuleValidateNaturalNameIdentifier.md new file mode 100644 index 0000000..56286ae --- /dev/null +++ b/docs/models/TravelRuleValidateNaturalNameIdentifier.md @@ -0,0 +1,29 @@ +# TravelRuleValidateNaturalNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**primaryIdentifier** | **string** | The primary identifier of the name | [optional] [default to undefined]| +|**secondaryIdentifier** | **string** | The secondary identifier of the name | [optional] [default to undefined]| +|**nameIdentifierType** | **string** | Specifies the type of name for a natural person. Acceptable values are: - \'ALIA\': Alias name, a name other than the legal name by which a natural person is also known. - \'BIRT\': Name at birth, the name given to a natural person at birth. - \'MAID\': Maiden name, the original name of a natural person who has changed their name after marriage. - \'LEGL\': Legal name, the name that identifies a natural person for legal, official, or administrative purposes. - \'MISC\': Unspecified, a name by which a natural person may be known but cannot otherwise be categorized. | [optional] [default to undefined]| + + +## Enum: TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum + + +* `Alia` (value: `'ALIA'`) + +* `Birt` (value: `'BIRT'`) + +* `Maid` (value: `'MAID'`) + +* `Legl` (value: `'LEGL'`) + +* `Misc` (value: `'MISC'`) + + + + + +[[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/TravelRuleValidateNaturalPerson.md b/docs/models/TravelRuleValidateNaturalPerson.md new file mode 100644 index 0000000..9e57174 --- /dev/null +++ b/docs/models/TravelRuleValidateNaturalPerson.md @@ -0,0 +1,18 @@ +# TravelRuleValidateNaturalPerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**name** | [**Array<TravelRuleValidateNaturalPersonNameIdentifier>**](TravelRuleValidateNaturalPersonNameIdentifier.md) | An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema. | [optional] [default to undefined]| +|**geographicAddress** | [**Array<TravelRuleValidateGeographicAddress>**](TravelRuleValidateGeographicAddress.md) | An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema. | [optional] [default to undefined]| +|**nationalIdentification** | [**TravelRuleValidateNationalIdentification**](TravelRuleValidateNationalIdentification.md) | | [optional] [default to undefined]| +|**dateAndPlaceOfBirth** | [**TravelRuleValidateDateAndPlaceOfBirth**](TravelRuleValidateDateAndPlaceOfBirth.md) | | [optional] [default to undefined]| +|**customerIdentification** | **string** | A unique identifier for the customer within the organization\'s context. | [optional] [default to undefined]| +|**countryOfResidence** | **string** | The ISO-3166 Alpha-2 country code of the natural person\'s residence. | [optional] [default to undefined]| +|**customerNumber** | **string** | A distinct identifier that uniquely identifies the customer within the organization. | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidateNaturalPersonNameIdentifier.md b/docs/models/TravelRuleValidateNaturalPersonNameIdentifier.md new file mode 100644 index 0000000..7223454 --- /dev/null +++ b/docs/models/TravelRuleValidateNaturalPersonNameIdentifier.md @@ -0,0 +1,14 @@ +# TravelRuleValidateNaturalPersonNameIdentifier + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**nameIdentifier** | [**Array<TravelRuleValidateNaturalNameIdentifier>**](TravelRuleValidateNaturalNameIdentifier.md) | | [optional] [default to undefined]| +|**localNameIdentifier** | [**Array<TravelRuleValidateNaturalNameIdentifier>**](TravelRuleValidateNaturalNameIdentifier.md) | | [optional] [default to undefined]| +|**phoneticNameIdentifier** | [**Array<TravelRuleValidateNaturalNameIdentifier>**](TravelRuleValidateNaturalNameIdentifier.md) | | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidatePerson.md b/docs/models/TravelRuleValidatePerson.md new file mode 100644 index 0000000..8385b4f --- /dev/null +++ b/docs/models/TravelRuleValidatePerson.md @@ -0,0 +1,13 @@ +# TravelRuleValidatePerson + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**naturalPerson** | [**TravelRuleValidateNaturalPerson**](TravelRuleValidateNaturalPerson.md) | | [optional] [default to undefined]| +|**legalPerson** | [**TravelRuleValidateLegalPerson**](TravelRuleValidateLegalPerson.md) | | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidatePiiIVMS.md b/docs/models/TravelRuleValidatePiiIVMS.md new file mode 100644 index 0000000..816dceb --- /dev/null +++ b/docs/models/TravelRuleValidatePiiIVMS.md @@ -0,0 +1,14 @@ +# TravelRuleValidatePiiIVMS + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**originatorPersons** | [**Array<TravelRuleValidatePerson>**](TravelRuleValidatePerson.md) | Information about the originator of the transaction | [optional] [default to undefined]| +|**beneficiaryPersons** | [**Array<TravelRuleValidatePerson>**](TravelRuleValidatePerson.md) | Information about the beneficiary of the transaction | [optional] [default to undefined]| +|**accountNumber** | **Array<string>** | Beneficiary account number | [optional] [default to undefined]| + + + + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/docs/models/TravelRuleValidateTransactionRequest.md b/docs/models/TravelRuleValidateTransactionRequest.md index b91649a..df430b8 100644 --- a/docs/models/TravelRuleValidateTransactionRequest.md +++ b/docs/models/TravelRuleValidateTransactionRequest.md @@ -4,17 +4,18 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -|**transactionAsset** | **string** | Transaction asset symbol BTC,ETH) | [default to undefined]| +|**transactionAsset** | **string** | Transaction asset symbol (BTC,ETH) | [default to undefined]| |**destination** | **string** | Transaction destination address | [default to undefined]| |**transactionAmount** | **string** | Transaction amount in the transaction asset | [default to undefined]| |**originatorVASPdid** | **string** | This is the identifier assigned to your VASP | [default to undefined]| |**originatorEqualsBeneficiary** | **boolean** | \"True\" if the originator and beneficiary is the same person and you therefore do not need to collect any information. \"False\" if it is a third-party transfer. | [default to undefined]| +|**transactionAssetDecimals** | **number** | Number of decimals in the transaction asset. This is used to convert the transaction amount to the smallest unit of the asset | [optional] [default to undefined]| |**travelRuleBehavior** | **boolean** | This will also check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction | [optional] [default to undefined]| |**beneficiaryVASPdid** | **string** | This is the identifier assigned to the VASP the funds are being sent to | [optional] [default to undefined]| |**beneficiaryVASPname** | **string** | Beneficiary VASP name | [optional] [default to undefined]| |**beneficiaryName** | **string** | Beneficiary name | [optional] [default to undefined]| |**beneficiaryAccountNumber** | **string** | Beneficiary name | [optional] [default to undefined]| -|**beneficiaryAddress** | [**TravelRuleAddress**](TravelRuleAddress.md) | Beneficiary name | [optional] [default to undefined]| +|**beneficiaryAddress** | [**TravelRuleAddress**](TravelRuleAddress.md) | | [optional] [default to undefined]| diff --git a/docs/models/TravelRuleValidateTransactionResponse.md b/docs/models/TravelRuleValidateTransactionResponse.md index 4e5292d..a26f8c0 100644 --- a/docs/models/TravelRuleValidateTransactionResponse.md +++ b/docs/models/TravelRuleValidateTransactionResponse.md @@ -13,6 +13,34 @@ |**warnings** | **Array<string>** | \"errors/warnings\" will tell you what information about the beneficiary you need to collect from the sender. | [default to undefined]| +## Enum: TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum + + +* `Unknown` (value: `'UNKNOWN'`) + +* `Hosted` (value: `'HOSTED'`) + +* `Unhosted` (value: `'UNHOSTED'`) + + + +## Enum: TravelRuleValidateTransactionResponseAddressSourceEnum + + +* `Unknown` (value: `'UNKNOWN'`) + +* `AddressHash` (value: `'ADDRESS_HASH'`) + +* `AddressGraph` (value: `'ADDRESS_GRAPH'`) + +* `Chainalysis` (value: `'CHAINALYSIS'`) + +* `Elliptic` (value: `'ELLIPTIC'`) + +* `Crystal` (value: `'CRYSTAL'`) + + + [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) diff --git a/models/index.ts b/models/index.ts index 5e3aa1b..4b0af6c 100644 --- a/models/index.ts +++ b/models/index.ts @@ -484,16 +484,37 @@ export * from './transfer-peer-path-type'; export * from './transfer-validation-failure'; export * from './travel-rule-address'; export * from './travel-rule-create-transaction-request'; +export * from './travel-rule-date-and-place-of-birth'; +export * from './travel-rule-fields-enum'; +export * from './travel-rule-geographic-address'; export * from './travel-rule-get-all-vasps-response'; export * from './travel-rule-issuer'; export * from './travel-rule-issuers'; +export * from './travel-rule-legal-person'; +export * from './travel-rule-legal-person-name-identifier'; +export * from './travel-rule-national-identification'; +export * from './travel-rule-natural-name-identifier'; +export * from './travel-rule-natural-person'; +export * from './travel-rule-natural-person-name-identifier'; +export * from './travel-rule-notation-enum'; export * from './travel-rule-ownership-proof'; +export * from './travel-rule-person'; export * from './travel-rule-pii-ivms'; export * from './travel-rule-policy-rule-response'; export * from './travel-rule-transaction-blockchain-info'; export * from './travel-rule-update-vaspdetails'; export * from './travel-rule-vasp'; +export * from './travel-rule-validate-date-and-place-of-birth'; export * from './travel-rule-validate-full-transaction-request'; +export * from './travel-rule-validate-geographic-address'; +export * from './travel-rule-validate-legal-person'; +export * from './travel-rule-validate-legal-person-name-identifier'; +export * from './travel-rule-validate-national-identification'; +export * from './travel-rule-validate-natural-name-identifier'; +export * from './travel-rule-validate-natural-person'; +export * from './travel-rule-validate-natural-person-name-identifier'; +export * from './travel-rule-validate-person'; +export * from './travel-rule-validate-pii-ivms'; export * from './travel-rule-validate-transaction-request'; export * from './travel-rule-validate-transaction-response'; export * from './travel-rule-vasp-for-vault'; diff --git a/models/travel-rule-address.ts b/models/travel-rule-address.ts index 3089211..777623a 100644 --- a/models/travel-rule-address.ts +++ b/models/travel-rule-address.ts @@ -25,24 +25,24 @@ export interface TravelRuleAddress { * @type {string} * @memberof TravelRuleAddress */ - 'street': string; + 'street'?: string; /** * City * @type {string} * @memberof TravelRuleAddress */ - 'city': string; + 'city'?: string; /** * State or province * @type {string} * @memberof TravelRuleAddress */ - 'state': string; + 'state'?: string; /** * Postal or ZIP code * @type {string} * @memberof TravelRuleAddress */ - 'postalCode': string; + 'postalCode'?: string; } diff --git a/models/travel-rule-create-transaction-request.ts b/models/travel-rule-create-transaction-request.ts index 95deab9..fe503f0 100644 --- a/models/travel-rule-create-transaction-request.ts +++ b/models/travel-rule-create-transaction-request.ts @@ -30,82 +30,124 @@ import { TravelRuleTransactionBlockchainInfo } from './travel-rule-transaction-b */ export interface TravelRuleCreateTransactionRequest { /** - * Information about the originator of the transaction + * * @type {TravelRulePiiIVMS} * @memberof TravelRuleCreateTransactionRequest */ 'originator': TravelRulePiiIVMS; /** - * Information about the beneficiary of the transaction + * * @type {TravelRulePiiIVMS} * @memberof TravelRuleCreateTransactionRequest */ 'beneficiary': TravelRulePiiIVMS; /** - * The VASP ID of the transaction originator + * The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. * @type {string} * @memberof TravelRuleCreateTransactionRequest */ 'originatorVASPdid'?: string; /** - * The VASP ID of the transaction beneficiary + * The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. * @type {string} * @memberof TravelRuleCreateTransactionRequest */ 'beneficiaryVASPdid'?: string; /** - * The name of the VASP acting as the beneficiary + * The name of the VASP acting as the transaction originator. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'originatorVASPname'?: string; + /** + * The name of the VASP acting as the transaction beneficiary. * @type {string} * @memberof TravelRuleCreateTransactionRequest */ 'beneficiaryVASPname'?: string; /** - * Information about the blockchain transaction + * The website of the VASP acting as the transaction beneficiary. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'beneficiaryVASPwebsite'?: string; + /** + * * @type {TravelRuleTransactionBlockchainInfo} * @memberof TravelRuleCreateTransactionRequest */ 'transactionBlockchainInfo'?: TravelRuleTransactionBlockchainInfo; /** - * Encrypted data related to the transaction + * Encrypted data related to the transaction. * @type {string} * @memberof TravelRuleCreateTransactionRequest */ 'encrypted'?: string; /** - * The protocol used to perform the travel rule + * The protocol used to perform the travel rule. * @type {string} * @memberof TravelRuleCreateTransactionRequest */ 'protocol'?: string; /** - * Whether to skip validation of beneficiary data + * Whether to skip validation of beneficiary data. * @type {boolean} * @memberof TravelRuleCreateTransactionRequest */ 'skipBeneficiaryDataValidation'?: boolean; /** - * Whether to check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction + * Whether to check if the transaction complies with the travel rule in the beneficiary VASP\'s jurisdiction. * @type {boolean} * @memberof TravelRuleCreateTransactionRequest */ 'travelRuleBehavior'?: boolean; /** - * Ownership proof related to the originator of the transaction + * A reference ID related to the originator of the transaction. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'originatorRef'?: string; + /** + * A reference ID related to the beneficiary of the transaction. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'beneficiaryRef'?: string; + /** + * A reference ID related to the travel rule behavior. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'travelRuleBehaviorRef'?: string; + /** + * * @type {TravelRuleOwnershipProof} * @memberof TravelRuleCreateTransactionRequest */ 'originatorProof'?: TravelRuleOwnershipProof; /** - * Ownership proof related to the beneficiary of the transaction + * * @type {TravelRuleOwnershipProof} * @memberof TravelRuleCreateTransactionRequest */ 'beneficiaryProof'?: TravelRuleOwnershipProof; /** - * Personal identifiable information related to the transaction - * @type {TravelRulePiiIVMS} + * The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'beneficiaryDid'?: string; + /** + * The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. + * @type {string} + * @memberof TravelRuleCreateTransactionRequest + */ + 'originatorDid'?: string; + /** + * Indicates if the transaction involves a non-custodial wallet. + * @type {boolean} * @memberof TravelRuleCreateTransactionRequest */ - 'pii'?: TravelRulePiiIVMS; + 'isNonCustodial'?: boolean; } diff --git a/models/travel-rule-date-and-place-of-birth.ts b/models/travel-rule-date-and-place-of-birth.ts new file mode 100644 index 0000000..3938d3d --- /dev/null +++ b/models/travel-rule-date-and-place-of-birth.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@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. + */ + + + +/** + * Represents the date and place of birth for a natural person + * @export + * @interface TravelRuleDateAndPlaceOfBirth + */ +export interface TravelRuleDateAndPlaceOfBirth { + /** + * Date of birth. The value must be encrypted. + * @type {string} + * @memberof TravelRuleDateAndPlaceOfBirth + */ + 'dateOfBirth'?: string; + /** + * Place of birth. The value must be encrypted. + * @type {string} + * @memberof TravelRuleDateAndPlaceOfBirth + */ + 'placeOfBirth'?: string; +} + diff --git a/models/travel-rule-fields-enum.ts b/models/travel-rule-fields-enum.ts new file mode 100644 index 0000000..b12441f --- /dev/null +++ b/models/travel-rule-fields-enum.ts @@ -0,0 +1,24 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleFieldsEnum + */ +export interface TravelRuleFieldsEnum extends Array { +} + diff --git a/models/travel-rule-geographic-address.ts b/models/travel-rule-geographic-address.ts new file mode 100644 index 0000000..ae92a15 --- /dev/null +++ b/models/travel-rule-geographic-address.ts @@ -0,0 +1,120 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleGeographicAddress + */ +export interface TravelRuleGeographicAddress { + /** + * Name of a street or thoroughfare. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'streetName'?: string; + /** + * Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'townName'?: string; + /** + * Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'country'?: string; + /** + * Number that identifies the position of a building on a street. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'buildingNumber'?: string; + /** + * Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'postCode'?: string; + /** + * Specifies the type of address. Acceptable values are: - \'HOME\': Residential, the home address - \'BIZZ\': Business, the business address - \'GEOG\': Geographic, an unspecified physical (geographical) address The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'addressType'?: string; + /** + * Identification of a division of a large organisation or building. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'department'?: string; + /** + * Identification of a sub-division of a large organisation or building. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'subDepartment'?: string; + /** + * Name of the building or house. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'buildingName'?: string; + /** + * Floor or storey within a building. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'floor'?: string; + /** + * Numbered box in a post office. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'postBox'?: string; + /** + * Building room number. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'room'?: string; + /** + * Specific location name within the town. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'townLocationName'?: string; + /** + * Identifies a subdivision within a country subdivision. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'districtName'?: string; + /** + * Identifies a subdivision of a country such as state, region, or province. The value must be encrypted. + * @type {string} + * @memberof TravelRuleGeographicAddress + */ + 'countrySubDivision'?: string; + /** + * Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted. + * @type {Array} + * @memberof TravelRuleGeographicAddress + */ + 'addressLine'?: Array; +} + diff --git a/models/travel-rule-get-all-vasps-response.ts b/models/travel-rule-get-all-vasps-response.ts index 2d433ab..5b710aa 100644 --- a/models/travel-rule-get-all-vasps-response.ts +++ b/models/travel-rule-get-all-vasps-response.ts @@ -24,10 +24,22 @@ import { TravelRuleVASP } from './travel-rule-vasp'; */ export interface TravelRuleGetAllVASPsResponse { /** - * + * An array of VASP objects, referencing the TravelRuleVASP schema. * @type {Array} * @memberof TravelRuleGetAllVASPsResponse */ - 'vasps': Array; + 'data': Array; + /** + * The total number of VASPs. + * @type {number} + * @memberof TravelRuleGetAllVASPsResponse + */ + 'total'?: number; + /** + * The URL for the next page of results. + * @type {string} + * @memberof TravelRuleGetAllVASPsResponse + */ + 'next'?: string | null; } diff --git a/models/travel-rule-legal-person-name-identifier.ts b/models/travel-rule-legal-person-name-identifier.ts new file mode 100644 index 0000000..f074630 --- /dev/null +++ b/models/travel-rule-legal-person-name-identifier.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleLegalPersonNameIdentifier + */ +export interface TravelRuleLegalPersonNameIdentifier { + /** + * Name by which the legal person is known. The value must be encrypted. + * @type {string} + * @memberof TravelRuleLegalPersonNameIdentifier + */ + 'legalPersonName'?: string; + /** + * Specifies the type of name for a legal person. Acceptable values are: - \'REGISTERED\': The official registered name. - \'TRADE\': A trading name or DBA (Doing Business As) name. - \'OTHER\': Any other type of name. The value must be encrypted. + * @type {string} + * @memberof TravelRuleLegalPersonNameIdentifier + */ + 'legalPersonNameIdentifierType'?: string; +} + diff --git a/models/travel-rule-legal-person.ts b/models/travel-rule-legal-person.ts new file mode 100644 index 0000000..ea91210 --- /dev/null +++ b/models/travel-rule-legal-person.ts @@ -0,0 +1,69 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleGeographicAddress } from './travel-rule-geographic-address'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleLegalPersonNameIdentifier } from './travel-rule-legal-person-name-identifier'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleNationalIdentification } from './travel-rule-national-identification'; + +/** + * + * @export + * @interface TravelRuleLegalPerson + */ +export interface TravelRuleLegalPerson { + /** + * + * @type {TravelRuleLegalPersonNameIdentifier} + * @memberof TravelRuleLegalPerson + */ + 'name'?: TravelRuleLegalPersonNameIdentifier; + /** + * The array of geographic addresses associated with the legal person. + * @type {Array} + * @memberof TravelRuleLegalPerson + */ + 'geographicAddress'?: Array; + /** + * + * @type {TravelRuleNationalIdentification} + * @memberof TravelRuleLegalPerson + */ + 'nationalIdentification'?: TravelRuleNationalIdentification; + /** + * A unique identifier that identifies the customer in the organization\'s context. The value must be encrypted. + * @type {string} + * @memberof TravelRuleLegalPerson + */ + 'customerIdentification'?: string; + /** + * A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted. + * @type {string} + * @memberof TravelRuleLegalPerson + */ + 'customerNumber'?: string; + /** + * The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted. + * @type {string} + * @memberof TravelRuleLegalPerson + */ + 'countryOfRegistration'?: string; +} + diff --git a/models/travel-rule-national-identification.ts b/models/travel-rule-national-identification.ts new file mode 100644 index 0000000..032cbcc --- /dev/null +++ b/models/travel-rule-national-identification.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@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. + */ + + + +/** + * Represents a national identifier for a person or entity + * @export + * @interface TravelRuleNationalIdentification + */ +export interface TravelRuleNationalIdentification { + /** + * Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted. + * @type {string} + * @memberof TravelRuleNationalIdentification + */ + 'countryOfIssue'?: string; + /** + * National identifier (max 35 characters). The value must be encrypted. + * @type {string} + * @memberof TravelRuleNationalIdentification + */ + 'nationalIdentifier'?: string; + /** + * Type of national identifier. Acceptable values include: - \'PASSPORT\': Passport number - \'NATIONAL_ID\': National identification number - \'TAX_ID\': Tax identification number - \'SOCIAL_SECURITY\': Social security number The value must be encrypted. + * @type {string} + * @memberof TravelRuleNationalIdentification + */ + 'nationalIdentifierType'?: string; + /** + * Registration authority (format -> RA followed by 6 digits). The value must be encrypted. + * @type {string} + * @memberof TravelRuleNationalIdentification + */ + 'registrationAuthority'?: string; +} + diff --git a/models/travel-rule-natural-name-identifier.ts b/models/travel-rule-natural-name-identifier.ts new file mode 100644 index 0000000..7ab4b61 --- /dev/null +++ b/models/travel-rule-natural-name-identifier.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleNaturalNameIdentifier + */ +export interface TravelRuleNaturalNameIdentifier { + /** + * The primary identifier of the name. The value must be encrypted. + * @type {string} + * @memberof TravelRuleNaturalNameIdentifier + */ + 'primaryIdentifier'?: string; + /** + * The secondary identifier of the name. The value must be encrypted. + * @type {string} + * @memberof TravelRuleNaturalNameIdentifier + */ + 'secondaryIdentifier'?: string; + /** + * The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR]. + * @type {string} + * @memberof TravelRuleNaturalNameIdentifier + */ + 'nameIdentifierType'?: string; +} + diff --git a/models/travel-rule-natural-person-name-identifier.ts b/models/travel-rule-natural-person-name-identifier.ts new file mode 100644 index 0000000..5135662 --- /dev/null +++ b/models/travel-rule-natural-person-name-identifier.ts @@ -0,0 +1,45 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleNaturalNameIdentifier } from './travel-rule-natural-name-identifier'; + +/** + * + * @export + * @interface TravelRuleNaturalPersonNameIdentifier + */ +export interface TravelRuleNaturalPersonNameIdentifier { + /** + * + * @type {Array} + * @memberof TravelRuleNaturalPersonNameIdentifier + */ + 'nameIdentifier'?: Array; + /** + * + * @type {Array} + * @memberof TravelRuleNaturalPersonNameIdentifier + */ + 'localNameIdentifier'?: Array; + /** + * + * @type {Array} + * @memberof TravelRuleNaturalPersonNameIdentifier + */ + 'phoneticNameIdentifier'?: Array; +} + diff --git a/models/travel-rule-natural-person.ts b/models/travel-rule-natural-person.ts new file mode 100644 index 0000000..cf4a0ed --- /dev/null +++ b/models/travel-rule-natural-person.ts @@ -0,0 +1,78 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleDateAndPlaceOfBirth } from './travel-rule-date-and-place-of-birth'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleGeographicAddress } from './travel-rule-geographic-address'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleNationalIdentification } from './travel-rule-national-identification'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleNaturalPersonNameIdentifier } from './travel-rule-natural-person-name-identifier'; + +/** + * + * @export + * @interface TravelRuleNaturalPerson + */ +export interface TravelRuleNaturalPerson { + /** + * An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema. + * @type {Array} + * @memberof TravelRuleNaturalPerson + */ + 'name'?: Array; + /** + * An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema. + * @type {Array} + * @memberof TravelRuleNaturalPerson + */ + 'geographicAddress'?: Array; + /** + * + * @type {TravelRuleNationalIdentification} + * @memberof TravelRuleNaturalPerson + */ + 'nationalIdentification'?: TravelRuleNationalIdentification; + /** + * + * @type {TravelRuleDateAndPlaceOfBirth} + * @memberof TravelRuleNaturalPerson + */ + 'dateAndPlaceOfBirth'?: TravelRuleDateAndPlaceOfBirth; + /** + * A unique identifier for the customer within the organization\'s context. The value must be encrypted. + * @type {string} + * @memberof TravelRuleNaturalPerson + */ + 'customerIdentification'?: string; + /** + * The ISO-3166 Alpha-2 country code of the natural person\'s residence. The value must be encrypted. + * @type {string} + * @memberof TravelRuleNaturalPerson + */ + 'countryOfResidence'?: string; + /** + * A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted. + * @type {string} + * @memberof TravelRuleNaturalPerson + */ + 'customerNumber'?: string; +} + diff --git a/models/travel-rule-notation-enum.ts b/models/travel-rule-notation-enum.ts new file mode 100644 index 0000000..be62ed9 --- /dev/null +++ b/models/travel-rule-notation-enum.ts @@ -0,0 +1,24 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleNotationEnum + */ +export interface TravelRuleNotationEnum extends Array { +} + diff --git a/models/travel-rule-ownership-proof.ts b/models/travel-rule-ownership-proof.ts index a406405..2877d07 100644 --- a/models/travel-rule-ownership-proof.ts +++ b/models/travel-rule-ownership-proof.ts @@ -15,22 +15,52 @@ /** - * + * Ownership proof related to the originator of the transaction. * @export * @interface TravelRuleOwnershipProof */ export interface TravelRuleOwnershipProof { /** - * Type of ownership proof + * The type of ownership proof. Example values: - `eip-191`: Ethereum signature proof - `eip-712`: Ethereum typed data signature proof - `bip-137`: Bitcoin signature proof - `microtransfer`: Microtransaction (Satoshi test) - `screenshot`: Uploaded screenshot of the wallet - `self-declaration`: Checkbox attestation of ownership * @type {string} * @memberof TravelRuleOwnershipProof */ 'type'?: string; /** - * Identification number + * The cryptographic signature, transaction hash, or other proof depending on the type. Examples: - For `eip-191`: `0x3dd4a17a...ce4a2bcd1b` - For `microtransfer`: The transaction hash `H3V8GXBy39Dz...tr3TSTkY=` * @type {string} * @memberof TravelRuleOwnershipProof */ 'proof'?: string; + /** + * A human-readable statement of wallet ownership. Required for signature proofs and self-declarations. Examples: - `I certify that ETH account 0x896B...0b9b belongs to me.` - `I hereby declare that the blockchain address 0xa437bEed902AF9338B7DEB23848e195d85019510 is under my control.` + * @type {string} + * @memberof TravelRuleOwnershipProof + */ + 'attestation'?: string; + /** + * The wallet address being verified. Examples: - For Ethereum: `0x896B...0b9b` - For Bitcoin: `1442...dxhsQ` + * @type {string} + * @memberof TravelRuleOwnershipProof + */ + 'address'?: string; + /** + * The wallet provider or method used for verification. Examples: - For Metamask: `Metamask` - For manual signature: `manual` + * @type {string} + * @memberof TravelRuleOwnershipProof + */ + 'wallet_provider'?: string; + /** + * The URL for the uploaded screenshot (for `screenshot` proof types only). Example: `https://example.com/uploaded_image.png` + * @type {string} + * @memberof TravelRuleOwnershipProof + */ + 'url'?: string; + /** + * Whether the user confirmed ownership of the wallet (for `self-declaration` proofs). Example: `true` + * @type {boolean} + * @memberof TravelRuleOwnershipProof + */ + 'confirmed'?: boolean; } diff --git a/models/travel-rule-person.ts b/models/travel-rule-person.ts new file mode 100644 index 0000000..f549c28 --- /dev/null +++ b/models/travel-rule-person.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleLegalPerson } from './travel-rule-legal-person'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleNaturalPerson } from './travel-rule-natural-person'; + +/** + * + * @export + * @interface TravelRulePerson + */ +export interface TravelRulePerson { + /** + * + * @type {TravelRuleNaturalPerson} + * @memberof TravelRulePerson + */ + 'naturalPerson'?: TravelRuleNaturalPerson; + /** + * + * @type {TravelRuleLegalPerson} + * @memberof TravelRulePerson + */ + 'legalPerson'?: TravelRuleLegalPerson; +} + diff --git a/models/travel-rule-pii-ivms.ts b/models/travel-rule-pii-ivms.ts index 1762259..45a7234 100644 --- a/models/travel-rule-pii-ivms.ts +++ b/models/travel-rule-pii-ivms.ts @@ -13,66 +13,33 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import { TravelRulePerson } from './travel-rule-person'; /** - * + * Personal identifiable information related to the transaction * @export * @interface TravelRulePiiIVMS */ export interface TravelRulePiiIVMS { /** - * - * @type {string} + * Information about the originator of the transaction + * @type {Array} * @memberof TravelRulePiiIVMS */ - 'fullName'?: string; + 'originatorPersons'?: Array; /** - * - * @type {string} + * Information about the beneficiary of the transaction + * @type {Array} * @memberof TravelRulePiiIVMS */ - 'dateOfBirth'?: string; + 'beneficiaryPersons'?: Array; /** - * - * @type {string} + * Beneficiary account number. The value must be encrypted. + * @type {Array} * @memberof TravelRulePiiIVMS */ - 'placeOfBirth'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'address'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'identificationNumber'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'nationality'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'countryOfResidence'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'taxIdentificationNumber'?: string; - /** - * - * @type {string} - * @memberof TravelRulePiiIVMS - */ - 'customerNumber'?: string; + 'accountNumber'?: Array; } diff --git a/models/travel-rule-transaction-blockchain-info.ts b/models/travel-rule-transaction-blockchain-info.ts index d6b8f55..cf3ff35 100644 --- a/models/travel-rule-transaction-blockchain-info.ts +++ b/models/travel-rule-transaction-blockchain-info.ts @@ -15,25 +15,25 @@ /** - * + * Information about the blockchain transaction. * @export * @interface TravelRuleTransactionBlockchainInfo */ export interface TravelRuleTransactionBlockchainInfo { /** - * + * The hash of the transaction * @type {string} * @memberof TravelRuleTransactionBlockchainInfo */ 'txHash'?: string; /** - * + * The origin address of the transaction * @type {string} * @memberof TravelRuleTransactionBlockchainInfo */ 'origin'?: string; /** - * + * The destination address of the transaction * @type {string} * @memberof TravelRuleTransactionBlockchainInfo */ diff --git a/models/travel-rule-validate-date-and-place-of-birth.ts b/models/travel-rule-validate-date-and-place-of-birth.ts new file mode 100644 index 0000000..a3d3eb0 --- /dev/null +++ b/models/travel-rule-validate-date-and-place-of-birth.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@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. + */ + + + +/** + * Represents the date and place of birth for a natural person + * @export + * @interface TravelRuleValidateDateAndPlaceOfBirth + */ +export interface TravelRuleValidateDateAndPlaceOfBirth { + /** + * Date of birth in ISO 8601 format (YYYY-MM-DD) + * @type {string} + * @memberof TravelRuleValidateDateAndPlaceOfBirth + */ + 'dateOfBirth'?: string; + /** + * Place of birth + * @type {string} + * @memberof TravelRuleValidateDateAndPlaceOfBirth + */ + 'placeOfBirth'?: string; +} + diff --git a/models/travel-rule-validate-full-transaction-request.ts b/models/travel-rule-validate-full-transaction-request.ts index 4cc914c..83b5b91 100644 --- a/models/travel-rule-validate-full-transaction-request.ts +++ b/models/travel-rule-validate-full-transaction-request.ts @@ -22,6 +22,9 @@ import { TravelRulePiiIVMS } from './travel-rule-pii-ivms'; // May contain unused imports in some cases // @ts-ignore import { TravelRuleTransactionBlockchainInfo } from './travel-rule-transaction-blockchain-info'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidatePiiIVMS } from './travel-rule-validate-pii-ivms'; /** * @@ -30,112 +33,157 @@ import { TravelRuleTransactionBlockchainInfo } from './travel-rule-transaction-b */ export interface TravelRuleValidateFullTransactionRequest { /** - * Information about the originator of the transaction - * @type {TravelRulePiiIVMS} - * @memberof TravelRuleValidateFullTransactionRequest - */ - 'originator': TravelRulePiiIVMS; - /** - * Information about the beneficiary of the transaction - * @type {TravelRulePiiIVMS} + * + * @type {TravelRuleValidatePiiIVMS} * @memberof TravelRuleValidateFullTransactionRequest */ - 'beneficiary': TravelRulePiiIVMS; + 'originator': TravelRuleValidatePiiIVMS; /** - * The asset involved in the transaction - * @type {string} + * + * @type {TravelRuleValidatePiiIVMS} * @memberof TravelRuleValidateFullTransactionRequest */ - 'transactionAsset'?: string; + 'beneficiary': TravelRuleValidatePiiIVMS; /** - * The amount of the transaction + * The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'transactionAmount'?: string; + 'originatorVASPdid'?: string; /** - * The DID of the transaction originator + * The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange\'s account is created in the Notabene network. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'originatorDid'?: string; + 'beneficiaryVASPdid'?: string; /** - * The DID of the transaction beneficiary + * Transaction asset symbol (e.g., BTC, ETH, USDC). By using the `notation` query string, users can select the type of asset notation: - `fireblocks`: Converts asset symbols to Fireblocks notation. - `notabene`: Retains the original Notabene asset symbol format. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'beneficiaryDid'?: string; + 'transactionAsset'?: string; /** - * The VASP ID of the transaction originator + * Transaction amount in the transaction asset. For example, if the asset is BTC, the amount is the value in BTC units. By using the `notation` query string, users can select the type of amount notation: - `fireblocks`: Converts the amount to Fireblocks notation (e.g., adjusted for decimals). - `notabene`: Retains the original Notabene amount format. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'originatorVASPdid'?: string; + 'transactionAmount'?: string; /** - * The VASP ID of the transaction beneficiary + * The name of the VASP acting as the transaction originator. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'beneficiaryVASPdid'?: string; + 'originatorVASPname'?: string; /** - * The name of the VASP acting as the beneficiary + * The name of the VASP acting as the transaction beneficiary. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ 'beneficiaryVASPname'?: string; /** - * Information about the blockchain transaction + * * @type {TravelRuleTransactionBlockchainInfo} * @memberof TravelRuleValidateFullTransactionRequest */ 'transactionBlockchainInfo'?: TravelRuleTransactionBlockchainInfo; /** - * Encrypted data related to the transaction + * Encrypted data related to the transaction. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ 'encrypted'?: string; /** - * The protocol used to perform the travel rule - * @type {string} - * @memberof TravelRuleValidateFullTransactionRequest - */ - 'protocol'?: string; - /** - * The email address where a notification should be sent upon completion of the travel rule + * The protocol used to perform the travel rule. * @type {string} * @memberof TravelRuleValidateFullTransactionRequest */ - 'notificationEmail'?: string; + 'protocol'?: TravelRuleValidateFullTransactionRequestProtocolEnum; /** - * Whether to skip validation of beneficiary data + * Whether to skip validation of beneficiary data. * @type {boolean} * @memberof TravelRuleValidateFullTransactionRequest */ 'skipBeneficiaryDataValidation'?: boolean; /** - * Whether to check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction + * Whether to check if the transaction complies with the travel rule in the beneficiary VASP\'s jurisdiction. * @type {boolean} * @memberof TravelRuleValidateFullTransactionRequest */ 'travelRuleBehavior'?: boolean; /** - * Ownership proof related to the originator of the transaction + * A reference ID related to the originator of the transaction. + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'originatorRef'?: string; + /** + * A reference ID related to the beneficiary of the transaction. + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'beneficiaryRef'?: string; + /** + * A reference ID related to the travel rule behavior. + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'travelRuleBehaviorRef'?: string; + /** + * * @type {TravelRuleOwnershipProof} * @memberof TravelRuleValidateFullTransactionRequest */ 'originatorProof'?: TravelRuleOwnershipProof; /** - * Ownership proof related to the beneficiary of the transaction + * * @type {TravelRuleOwnershipProof} * @memberof TravelRuleValidateFullTransactionRequest */ 'beneficiaryProof'?: TravelRuleOwnershipProof; /** - * Personal identifiable information related to the transaction + * The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'beneficiaryDid'?: string; + /** + * The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'originatorDid'?: string; + /** + * Indicates if the transaction involves a non-custodial wallet. + * @type {boolean} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'isNonCustodial'?: boolean; + /** + * The email address where a notification should be sent upon completion of the travel rule + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'notificationEmail'?: string; + /** + * * @type {TravelRulePiiIVMS} * @memberof TravelRuleValidateFullTransactionRequest */ 'pii'?: TravelRulePiiIVMS; + /** + * The URL of the personal identifiable information related to the transaction + * @type {string} + * @memberof TravelRuleValidateFullTransactionRequest + */ + 'pii_url'?: string; } +export const TravelRuleValidateFullTransactionRequestProtocolEnum = { + TrLight: 'TRLight', + Trp: 'TRP', + OpenVasp: 'OpenVASP' +} as const; + +export type TravelRuleValidateFullTransactionRequestProtocolEnum = typeof TravelRuleValidateFullTransactionRequestProtocolEnum[keyof typeof TravelRuleValidateFullTransactionRequestProtocolEnum]; + + diff --git a/models/travel-rule-validate-geographic-address.ts b/models/travel-rule-validate-geographic-address.ts new file mode 100644 index 0000000..14e1000 --- /dev/null +++ b/models/travel-rule-validate-geographic-address.ts @@ -0,0 +1,129 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleValidateGeographicAddress + */ +export interface TravelRuleValidateGeographicAddress { + /** + * Name of a street or thoroughfare + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'streetName'?: string; + /** + * Name of a built-up area, with defined boundaries, and a local government + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'townName'?: string; + /** + * Nation with its own government (ISO-3166 Alpha-2 country code) + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'country'?: string; + /** + * Number that identifies the position of a building on a street + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'buildingNumber'?: string; + /** + * Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'postCode'?: string; + /** + * Specifies the type of address. Acceptable values are: - \'HOME\': Residential, the home address - \'BIZZ\': Business, the business address - \'GEOG\': Geographic, an unspecified physical (geographical) address + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'addressType'?: TravelRuleValidateGeographicAddressAddressTypeEnum; + /** + * Identification of a division of a large organisation or building + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'department'?: string; + /** + * Identification of a sub-division of a large organisation or building + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'subDepartment'?: string; + /** + * Name of the building or house + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'buildingName'?: string; + /** + * Floor or storey within a building + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'floor'?: string; + /** + * Numbered box in a post office + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'postBox'?: string; + /** + * Building room number + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'room'?: string; + /** + * Specific location name within the town + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'townLocationName'?: string; + /** + * Identifies a subdivision within a country subdivision + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'districtName'?: string; + /** + * Identifies a subdivision of a country such as state, region, or province + * @type {string} + * @memberof TravelRuleValidateGeographicAddress + */ + 'countrySubDivision'?: string; + /** + * Information that locates and identifies a specific address, presented in free format text + * @type {Array} + * @memberof TravelRuleValidateGeographicAddress + */ + 'addressLine'?: Array; +} + +export const TravelRuleValidateGeographicAddressAddressTypeEnum = { + Home: 'HOME', + Bizz: 'BIZZ', + Geog: 'GEOG' +} as const; + +export type TravelRuleValidateGeographicAddressAddressTypeEnum = typeof TravelRuleValidateGeographicAddressAddressTypeEnum[keyof typeof TravelRuleValidateGeographicAddressAddressTypeEnum]; + + diff --git a/models/travel-rule-validate-legal-person-name-identifier.ts b/models/travel-rule-validate-legal-person-name-identifier.ts new file mode 100644 index 0000000..c6e1cc7 --- /dev/null +++ b/models/travel-rule-validate-legal-person-name-identifier.ts @@ -0,0 +1,45 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleValidateLegalPersonNameIdentifier + */ +export interface TravelRuleValidateLegalPersonNameIdentifier { + /** + * Name by which the legal person is known. + * @type {string} + * @memberof TravelRuleValidateLegalPersonNameIdentifier + */ + 'legalPersonName'?: string; + /** + * Specifies the type of name for a legal person. Acceptable values are: - \'REGISTERED\': The official registered name. - \'TRADE\': A trading name or DBA (Doing Business As) name. - \'OTHER\': Any other type of name. + * @type {string} + * @memberof TravelRuleValidateLegalPersonNameIdentifier + */ + 'legalPersonNameIdentifierType'?: TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum; +} + +export const TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum = { + Registered: 'REGISTERED', + Trade: 'TRADE', + Other: 'OTHER' +} as const; + +export type TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum = typeof TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum[keyof typeof TravelRuleValidateLegalPersonNameIdentifierLegalPersonNameIdentifierTypeEnum]; + + diff --git a/models/travel-rule-validate-legal-person.ts b/models/travel-rule-validate-legal-person.ts new file mode 100644 index 0000000..94025e9 --- /dev/null +++ b/models/travel-rule-validate-legal-person.ts @@ -0,0 +1,69 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateGeographicAddress } from './travel-rule-validate-geographic-address'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateLegalPersonNameIdentifier } from './travel-rule-validate-legal-person-name-identifier'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateNationalIdentification } from './travel-rule-validate-national-identification'; + +/** + * + * @export + * @interface TravelRuleValidateLegalPerson + */ +export interface TravelRuleValidateLegalPerson { + /** + * + * @type {TravelRuleValidateLegalPersonNameIdentifier} + * @memberof TravelRuleValidateLegalPerson + */ + 'name'?: TravelRuleValidateLegalPersonNameIdentifier; + /** + * The array of geographic addresses associated with the legal person. + * @type {Array} + * @memberof TravelRuleValidateLegalPerson + */ + 'geographicAddress'?: Array; + /** + * + * @type {TravelRuleValidateNationalIdentification} + * @memberof TravelRuleValidateLegalPerson + */ + 'nationalIdentification'?: TravelRuleValidateNationalIdentification; + /** + * A unique identifier that identifies the customer in the organization\'s context. + * @type {string} + * @memberof TravelRuleValidateLegalPerson + */ + 'customerIdentification'?: string; + /** + * A distinct identifier that uniquely identifies the customer within the organization. + * @type {string} + * @memberof TravelRuleValidateLegalPerson + */ + 'customerNumber'?: string; + /** + * The ISO-3166 Alpha-2 country code where the legal person is registered. + * @type {string} + * @memberof TravelRuleValidateLegalPerson + */ + 'countryOfRegistration'?: string; +} + diff --git a/models/travel-rule-validate-national-identification.ts b/models/travel-rule-validate-national-identification.ts new file mode 100644 index 0000000..bb06928 --- /dev/null +++ b/models/travel-rule-validate-national-identification.ts @@ -0,0 +1,58 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@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. + */ + + + +/** + * Represents a national identifier for a person or entity + * @export + * @interface TravelRuleValidateNationalIdentification + */ +export interface TravelRuleValidateNationalIdentification { + /** + * Country that issued the national identifier (ISO-3166 Alpha-2 country code) + * @type {string} + * @memberof TravelRuleValidateNationalIdentification + */ + 'countryOfIssue'?: string; + /** + * National identifier (max 35 characters) + * @type {string} + * @memberof TravelRuleValidateNationalIdentification + */ + 'nationalIdentifier'?: string; + /** + * Type of national identifier. Acceptable values include: - \'PASSPORT\': Passport number - \'NATIONAL_ID\': National identification number - \'TAX_ID\': Tax identification number - \'SOCIAL_SECURITY\': Social security number + * @type {string} + * @memberof TravelRuleValidateNationalIdentification + */ + 'nationalIdentifierType'?: TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum; + /** + * Registration authority (format -> RA followed by 6 digits) + * @type {string} + * @memberof TravelRuleValidateNationalIdentification + */ + 'registrationAuthority'?: string; +} + +export const TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum = { + Passport: 'PASSPORT', + NationalId: 'NATIONAL_ID', + TaxId: 'TAX_ID', + SocialSecurity: 'SOCIAL_SECURITY' +} as const; + +export type TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum = typeof TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum[keyof typeof TravelRuleValidateNationalIdentificationNationalIdentifierTypeEnum]; + + diff --git a/models/travel-rule-validate-natural-name-identifier.ts b/models/travel-rule-validate-natural-name-identifier.ts new file mode 100644 index 0000000..8cdb0a1 --- /dev/null +++ b/models/travel-rule-validate-natural-name-identifier.ts @@ -0,0 +1,53 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface TravelRuleValidateNaturalNameIdentifier + */ +export interface TravelRuleValidateNaturalNameIdentifier { + /** + * The primary identifier of the name + * @type {string} + * @memberof TravelRuleValidateNaturalNameIdentifier + */ + 'primaryIdentifier'?: string; + /** + * The secondary identifier of the name + * @type {string} + * @memberof TravelRuleValidateNaturalNameIdentifier + */ + 'secondaryIdentifier'?: string; + /** + * Specifies the type of name for a natural person. Acceptable values are: - \'ALIA\': Alias name, a name other than the legal name by which a natural person is also known. - \'BIRT\': Name at birth, the name given to a natural person at birth. - \'MAID\': Maiden name, the original name of a natural person who has changed their name after marriage. - \'LEGL\': Legal name, the name that identifies a natural person for legal, official, or administrative purposes. - \'MISC\': Unspecified, a name by which a natural person may be known but cannot otherwise be categorized. + * @type {string} + * @memberof TravelRuleValidateNaturalNameIdentifier + */ + 'nameIdentifierType'?: TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum; +} + +export const TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum = { + Alia: 'ALIA', + Birt: 'BIRT', + Maid: 'MAID', + Legl: 'LEGL', + Misc: 'MISC' +} as const; + +export type TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum = typeof TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum[keyof typeof TravelRuleValidateNaturalNameIdentifierNameIdentifierTypeEnum]; + + diff --git a/models/travel-rule-validate-natural-person-name-identifier.ts b/models/travel-rule-validate-natural-person-name-identifier.ts new file mode 100644 index 0000000..9dcd009 --- /dev/null +++ b/models/travel-rule-validate-natural-person-name-identifier.ts @@ -0,0 +1,45 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateNaturalNameIdentifier } from './travel-rule-validate-natural-name-identifier'; + +/** + * + * @export + * @interface TravelRuleValidateNaturalPersonNameIdentifier + */ +export interface TravelRuleValidateNaturalPersonNameIdentifier { + /** + * + * @type {Array} + * @memberof TravelRuleValidateNaturalPersonNameIdentifier + */ + 'nameIdentifier'?: Array; + /** + * + * @type {Array} + * @memberof TravelRuleValidateNaturalPersonNameIdentifier + */ + 'localNameIdentifier'?: Array; + /** + * + * @type {Array} + * @memberof TravelRuleValidateNaturalPersonNameIdentifier + */ + 'phoneticNameIdentifier'?: Array; +} + diff --git a/models/travel-rule-validate-natural-person.ts b/models/travel-rule-validate-natural-person.ts new file mode 100644 index 0000000..cf6bb80 --- /dev/null +++ b/models/travel-rule-validate-natural-person.ts @@ -0,0 +1,78 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateDateAndPlaceOfBirth } from './travel-rule-validate-date-and-place-of-birth'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateGeographicAddress } from './travel-rule-validate-geographic-address'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateNationalIdentification } from './travel-rule-validate-national-identification'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateNaturalPersonNameIdentifier } from './travel-rule-validate-natural-person-name-identifier'; + +/** + * + * @export + * @interface TravelRuleValidateNaturalPerson + */ +export interface TravelRuleValidateNaturalPerson { + /** + * An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema. + * @type {Array} + * @memberof TravelRuleValidateNaturalPerson + */ + 'name'?: Array; + /** + * An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema. + * @type {Array} + * @memberof TravelRuleValidateNaturalPerson + */ + 'geographicAddress'?: Array; + /** + * + * @type {TravelRuleValidateNationalIdentification} + * @memberof TravelRuleValidateNaturalPerson + */ + 'nationalIdentification'?: TravelRuleValidateNationalIdentification; + /** + * + * @type {TravelRuleValidateDateAndPlaceOfBirth} + * @memberof TravelRuleValidateNaturalPerson + */ + 'dateAndPlaceOfBirth'?: TravelRuleValidateDateAndPlaceOfBirth; + /** + * A unique identifier for the customer within the organization\'s context. + * @type {string} + * @memberof TravelRuleValidateNaturalPerson + */ + 'customerIdentification'?: string; + /** + * The ISO-3166 Alpha-2 country code of the natural person\'s residence. + * @type {string} + * @memberof TravelRuleValidateNaturalPerson + */ + 'countryOfResidence'?: string; + /** + * A distinct identifier that uniquely identifies the customer within the organization. + * @type {string} + * @memberof TravelRuleValidateNaturalPerson + */ + 'customerNumber'?: string; +} + diff --git a/models/travel-rule-validate-person.ts b/models/travel-rule-validate-person.ts new file mode 100644 index 0000000..ae1b0cb --- /dev/null +++ b/models/travel-rule-validate-person.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateLegalPerson } from './travel-rule-validate-legal-person'; +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidateNaturalPerson } from './travel-rule-validate-natural-person'; + +/** + * + * @export + * @interface TravelRuleValidatePerson + */ +export interface TravelRuleValidatePerson { + /** + * + * @type {TravelRuleValidateNaturalPerson} + * @memberof TravelRuleValidatePerson + */ + 'naturalPerson'?: TravelRuleValidateNaturalPerson; + /** + * + * @type {TravelRuleValidateLegalPerson} + * @memberof TravelRuleValidatePerson + */ + 'legalPerson'?: TravelRuleValidateLegalPerson; +} + diff --git a/models/travel-rule-validate-pii-ivms.ts b/models/travel-rule-validate-pii-ivms.ts new file mode 100644 index 0000000..8cb1170 --- /dev/null +++ b/models/travel-rule-validate-pii-ivms.ts @@ -0,0 +1,45 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Fireblocks API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.6.2 + * Contact: support@fireblocks.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { TravelRuleValidatePerson } from './travel-rule-validate-person'; + +/** + * Information about the originator of the transaction. + * @export + * @interface TravelRuleValidatePiiIVMS + */ +export interface TravelRuleValidatePiiIVMS { + /** + * Information about the originator of the transaction + * @type {Array} + * @memberof TravelRuleValidatePiiIVMS + */ + 'originatorPersons'?: Array; + /** + * Information about the beneficiary of the transaction + * @type {Array} + * @memberof TravelRuleValidatePiiIVMS + */ + 'beneficiaryPersons'?: Array; + /** + * Beneficiary account number + * @type {Array} + * @memberof TravelRuleValidatePiiIVMS + */ + 'accountNumber'?: Array; +} + diff --git a/models/travel-rule-validate-transaction-request.ts b/models/travel-rule-validate-transaction-request.ts index 47862e1..5d766d5 100644 --- a/models/travel-rule-validate-transaction-request.ts +++ b/models/travel-rule-validate-transaction-request.ts @@ -24,7 +24,7 @@ import { TravelRuleAddress } from './travel-rule-address'; */ export interface TravelRuleValidateTransactionRequest { /** - * Transaction asset symbol BTC,ETH) + * Transaction asset symbol (BTC,ETH) * @type {string} * @memberof TravelRuleValidateTransactionRequest */ @@ -53,6 +53,12 @@ export interface TravelRuleValidateTransactionRequest { * @memberof TravelRuleValidateTransactionRequest */ 'originatorEqualsBeneficiary': boolean; + /** + * Number of decimals in the transaction asset. This is used to convert the transaction amount to the smallest unit of the asset + * @type {number} + * @memberof TravelRuleValidateTransactionRequest + */ + 'transactionAssetDecimals'?: number; /** * This will also check if the transaction is a TRAVEL_RULE in the beneficiary VASP\'s jurisdiction * @type {boolean} @@ -84,7 +90,7 @@ export interface TravelRuleValidateTransactionRequest { */ 'beneficiaryAccountNumber'?: string; /** - * Beneficiary name + * * @type {TravelRuleAddress} * @memberof TravelRuleValidateTransactionRequest */ diff --git a/models/travel-rule-validate-transaction-response.ts b/models/travel-rule-validate-transaction-response.ts index ae0d918..5673a33 100644 --- a/models/travel-rule-validate-transaction-response.ts +++ b/models/travel-rule-validate-transaction-response.ts @@ -37,13 +37,13 @@ export interface TravelRuleValidateTransactionResponse { * @type {string} * @memberof TravelRuleValidateTransactionResponse */ - 'beneficiaryAddressType': string; + 'beneficiaryAddressType': TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum; /** * \"addressSource\" will tell you if the address was found in your internal address book or identified by the blockchain analytics provider. * @type {string} * @memberof TravelRuleValidateTransactionResponse */ - 'addressSource': string; + 'addressSource': TravelRuleValidateTransactionResponseAddressSourceEnum; /** * The VASP DID of the beneficiary VASP * @type {string} @@ -64,3 +64,22 @@ export interface TravelRuleValidateTransactionResponse { 'warnings': Array; } +export const TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum = { + Unknown: 'UNKNOWN', + Hosted: 'HOSTED', + Unhosted: 'UNHOSTED' +} as const; + +export type TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum = typeof TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum[keyof typeof TravelRuleValidateTransactionResponseBeneficiaryAddressTypeEnum]; +export const TravelRuleValidateTransactionResponseAddressSourceEnum = { + Unknown: 'UNKNOWN', + AddressHash: 'ADDRESS_HASH', + AddressGraph: 'ADDRESS_GRAPH', + Chainalysis: 'CHAINALYSIS', + Elliptic: 'ELLIPTIC', + Crystal: 'CRYSTAL' +} as const; + +export type TravelRuleValidateTransactionResponseAddressSourceEnum = typeof TravelRuleValidateTransactionResponseAddressSourceEnum[keyof typeof TravelRuleValidateTransactionResponseAddressSourceEnum]; + + diff --git a/models/travel-rule-vasp.ts b/models/travel-rule-vasp.ts index 88359a4..c8d6802 100644 --- a/models/travel-rule-vasp.ts +++ b/models/travel-rule-vasp.ts @@ -24,280 +24,280 @@ import { TravelRuleIssuers } from './travel-rule-issuers'; */ export interface TravelRuleVASP { /** - * + * The Decentralized Identifier (DID) of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'did': string; /** - * + * The name of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'name': string; /** - * + * The current verification status of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'verificationStatus': string; /** - * + * The first line of the VASP\'s address. * @type {string} * @memberof TravelRuleVASP */ 'addressLine1': string; /** - * - * @type {string} - * @memberof TravelRuleVASP - */ - 'addressLine2': string; - /** - * + * The city where the VASP is located. * @type {string} * @memberof TravelRuleVASP */ 'city': string; /** - * + * The country where the VASP is registered (ISO-3166 Alpha-2 code). * @type {string} * @memberof TravelRuleVASP */ 'country': string; /** - * + * Comma-separated list of email domains associated with the VASP. * @type {string} * @memberof TravelRuleVASP */ 'emailDomains': string; /** - * + * The official website of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'website': string; /** - * - * @type {string} - * @memberof TravelRuleVASP - */ - 'logo': string; - /** - * + * The legal structure of the VASP (e.g., Corporation, LLC). * @type {string} * @memberof TravelRuleVASP */ 'legalStructure': string; /** - * + * The legal name of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'legalName': string; /** - * + * The year the VASP was founded. * @type {string} * @memberof TravelRuleVASP */ 'yearFounded': string; /** - * + * The country where the VASP is incorporated (ISO-3166 Alpha-2 code). * @type {string} * @memberof TravelRuleVASP */ 'incorporationCountry': string; /** - * + * Indicates whether the VASP is regulated. * @type {string} * @memberof TravelRuleVASP */ 'isRegulated': string; /** - * + * The jurisdictions where the VASP operates. * @type {string} * @memberof TravelRuleVASP */ - 'otherNames': string; + 'jurisdictions': string; /** - * + * Travel rule compliance status for TRLight. * @type {string} * @memberof TravelRuleVASP */ - 'identificationType': string; + 'travelRule_TRLIGHT': string; /** - * + * Timestamp when the VASP record was created. * @type {string} * @memberof TravelRuleVASP */ - 'identificationCountry': string; + 'createdAt': string; /** - * - * @type {string} + * Indicates if the VASP has an admin. + * @type {boolean} + * @memberof TravelRuleVASP + */ + 'hasAdmin': boolean; + /** + * Indicates if the VASP is notifiable for compliance reasons. + * @type {boolean} * @memberof TravelRuleVASP */ - 'businessNumber': string; + 'isNotifiable': boolean; /** * + * @type {TravelRuleIssuers} + * @memberof TravelRuleVASP + */ + 'issuers': TravelRuleIssuers; + /** + * The second line of the VASP\'s address (if applicable). * @type {string} * @memberof TravelRuleVASP */ - 'regulatoryAuthorities': string; + 'addressLine2'?: string; /** - * + * URL to the logo of the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'jurisdictions': string; + 'logo'?: string; /** - * + * Other names the VASP is known by. * @type {string} * @memberof TravelRuleVASP */ - 'street': string; + 'otherNames'?: string; /** - * + * The type of identification used by the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'number': string; + 'identificationType'?: string; /** - * + * The country of identification for the VASP (ISO-3166 Alpha-2 code). * @type {string} * @memberof TravelRuleVASP */ - 'unit': string; + 'identificationCountry'?: string; /** - * + * The business registration number of the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'postCode': string; + 'businessNumber'?: string; /** - * + * The regulatory authorities overseeing the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'state': string; + 'regulatoryAuthorities'?: string; /** - * + * The street name where the VASP is located. * @type {string} * @memberof TravelRuleVASP */ - 'certificates': string; + 'street'?: string; /** - * + * The building number of the VASP\'s address. * @type {string} * @memberof TravelRuleVASP */ - 'description': string; + 'number'?: string; /** - * + * The unit or suite number of the VASP\'s address. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_OPENVASP': string; + 'unit'?: string; /** - * + * The postal code of the VASP\'s location. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_SYGNA': string; + 'postCode'?: string; /** - * + * The state or region where the VASP is located. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_TRISA': string; + 'state'?: string; /** - * + * Certificates or licenses held by the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_TRLIGHT': string; + 'certificates'?: string; /** - * + * A brief description of the VASP. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_EMAIL': string; + 'description'?: string; /** - * + * Travel rule compliance status for OpenVASP. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_TRP': string; + 'travelRule_OPENVASP'?: string; /** - * + * Travel rule compliance status for Sygna. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_SHYFT': string; + 'travelRule_SYGNA'?: string; /** - * + * Travel rule compliance status for TRISA. * @type {string} * @memberof TravelRuleVASP */ - 'travelRule_USTRAVELRULEWG': string; + 'travelRule_TRISA'?: string; /** - * + * Travel rule compliance status for EMAIL. * @type {string} * @memberof TravelRuleVASP */ - 'createdAt': string; + 'travelRule_EMAIL'?: string; /** - * + * Travel rule compliance status for TRP. * @type {string} * @memberof TravelRuleVASP */ - 'createdBy': string; + 'travelRule_TRP'?: string; /** - * + * Travel rule compliance status for Shyft. * @type {string} * @memberof TravelRuleVASP */ - 'updatedAt': string; + 'travelRule_SHYFT'?: string; /** - * + * Travel rule compliance status for US Travel Rule WG. * @type {string} * @memberof TravelRuleVASP */ - 'updatedBy': string; + 'travelRule_USTRAVELRULEWG'?: string; /** - * + * User or system that created the VASP record. * @type {string} * @memberof TravelRuleVASP */ - 'lastSentDate': string; + 'createdBy'?: string; /** - * + * Timestamp of the last update to the VASP record. * @type {string} * @memberof TravelRuleVASP */ - 'lastReceivedDate': string; + 'updatedAt'?: string; /** - * + * User or system that last updated the VASP record. * @type {string} * @memberof TravelRuleVASP */ - 'documents': string; + 'updatedBy'?: string; /** - * - * @type {boolean} + * The last date a transaction was sent by the VASP. + * @type {string} * @memberof TravelRuleVASP */ - 'hasAdmin': boolean; + 'lastSentDate'?: string; /** - * - * @type {boolean} + * The last date a transaction was received by the VASP. + * @type {string} * @memberof TravelRuleVASP */ - 'isNotifiable': boolean; + 'lastReceivedDate'?: string; /** - * - * @type {TravelRuleIssuers} + * Documents associated with the VASP. + * @type {string} * @memberof TravelRuleVASP */ - 'issuers': TravelRuleIssuers; + 'documents'?: string; } diff --git a/package-lock.json b/package-lock.json index f452a45..40e896d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@fireblocks/ts-sdk", - "version": "8.0.1", + "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@fireblocks/ts-sdk", - "version": "8.0.1", + "version": "0.0.0", "license": "MIT License", "dependencies": { "axios": "^1.6.7", @@ -66,23 +66,22 @@ } }, "node_modules/@babel/core": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.8.tgz", - "integrity": "sha512-l+lkXCHS6tQEc5oUpK28xBOZ6+HwaH7YwoYQbLFiYb4nS2/l1tKnZEtEWkD0GuiYdvArf9qBS0XlQGXzPMsNqQ==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.9.tgz", + "integrity": "sha512-lWBYIrF7qK5+GjY5Uy+/hEgp8OJWOD/rpy74GplYRhEauvbHDeFB8t5hPOZxCZ0Oxf4Cc36tK51/l3ymJysrKw==", "dev": true, "license": "MIT", "dependencies": { "@ampproject/remapping": "^2.2.0", "@babel/code-frame": "^7.26.2", - "@babel/generator": "^7.26.8", + "@babel/generator": "^7.26.9", "@babel/helper-compilation-targets": "^7.26.5", "@babel/helper-module-transforms": "^7.26.0", - "@babel/helpers": "^7.26.7", - "@babel/parser": "^7.26.8", - "@babel/template": "^7.26.8", - "@babel/traverse": "^7.26.8", - "@babel/types": "^7.26.8", - "@types/gensync": "^1.0.0", + "@babel/helpers": "^7.26.9", + "@babel/parser": "^7.26.9", + "@babel/template": "^7.26.9", + "@babel/traverse": "^7.26.9", + "@babel/types": "^7.26.9", "convert-source-map": "^2.0.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", @@ -98,14 +97,14 @@ } }, "node_modules/@babel/generator": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.26.8.tgz", - "integrity": "sha512-ef383X5++iZHWAXX0SXQR6ZyQhw/0KtTkrTz61WXRhFM6dhpHulO/RJz79L8S6ugZHJkOOkUrUdxgdF2YiPFnA==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.26.9.tgz", + "integrity": "sha512-kEWdzjOAUMW4hAyrzJ0ZaTOu9OmpyDIQicIh0zg0EEcEkYXZb2TjtBhnHi2ViX7PKwZqF4xwqfAm299/QMP3lg==", "dev": true, "license": "MIT", "dependencies": { - "@babel/parser": "^7.26.8", - "@babel/types": "^7.26.8", + "@babel/parser": "^7.26.9", + "@babel/types": "^7.26.9", "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.25", "jsesc": "^3.0.2" @@ -204,27 +203,27 @@ } }, "node_modules/@babel/helpers": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.7.tgz", - "integrity": "sha512-8NHiL98vsi0mbPQmYAGWwfcFaOy4j2HY49fXJCfuDcdE7fMIsH9a7GdaeXpIBsbT7307WU8KCMp5pUVDNL4f9A==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.9.tgz", + "integrity": "sha512-Mz/4+y8udxBKdmzt/UjPACs4G3j5SshJJEFFKxlCGPydG4JAHXxjWjAwjd09tf6oINvl1VfMJo+nB7H2YKQ0dA==", "dev": true, "license": "MIT", "dependencies": { - "@babel/template": "^7.25.9", - "@babel/types": "^7.26.7" + "@babel/template": "^7.26.9", + "@babel/types": "^7.26.9" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/parser": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.8.tgz", - "integrity": "sha512-TZIQ25pkSoaKEYYaHbbxkfL36GNsQ6iFiBbeuzAkLnXayKR1yP1zFe+NxuZWWsUyvt8icPU9CCq0sgWGXR1GEw==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.9.tgz", + "integrity": "sha512-81NWa1njQblgZbQHxWHpxxCzNsa3ZwvFqpUg7P+NNUU6f3UU2jBEg4OlF/J6rl8+PQGh1q6/zWScd001YwcA5A==", "dev": true, "license": "MIT", "dependencies": { - "@babel/types": "^7.26.8" + "@babel/types": "^7.26.9" }, "bin": { "parser": "bin/babel-parser.js" @@ -473,32 +472,32 @@ } }, "node_modules/@babel/template": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.26.8.tgz", - "integrity": "sha512-iNKaX3ZebKIsCvJ+0jd6embf+Aulaa3vNBqZ41kM7iTWjx5qzWKXGHiJUW3+nTpQ18SG11hdF8OAzKrpXkb96Q==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.26.9.tgz", + "integrity": "sha512-qyRplbeIpNZhmzOysF/wFMuP9sctmh2cFzRAZOn1YapxBsE1i9bJIY586R/WBLfLcmcBlM8ROBiQURnnNy+zfA==", "dev": true, "license": "MIT", "dependencies": { "@babel/code-frame": "^7.26.2", - "@babel/parser": "^7.26.8", - "@babel/types": "^7.26.8" + "@babel/parser": "^7.26.9", + "@babel/types": "^7.26.9" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/traverse": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.26.8.tgz", - "integrity": "sha512-nic9tRkjYH0oB2dzr/JoGIm+4Q6SuYeLEiIiZDwBscRMYFJ+tMAz98fuel9ZnbXViA2I0HVSSRRK8DW5fjXStA==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.26.9.tgz", + "integrity": "sha512-ZYW7L+pL8ahU5fXmNbPF+iZFHCv5scFak7MZ9bwaRPLUhHh7QQEMjZUg0HevihoqCM5iSYHN61EyCoZvqC+bxg==", "dev": true, "license": "MIT", "dependencies": { "@babel/code-frame": "^7.26.2", - "@babel/generator": "^7.26.8", - "@babel/parser": "^7.26.8", - "@babel/template": "^7.26.8", - "@babel/types": "^7.26.8", + "@babel/generator": "^7.26.9", + "@babel/parser": "^7.26.9", + "@babel/template": "^7.26.9", + "@babel/types": "^7.26.9", "debug": "^4.3.1", "globals": "^11.1.0" }, @@ -507,9 +506,9 @@ } }, "node_modules/@babel/types": { - "version": "7.26.8", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.8.tgz", - "integrity": "sha512-eUuWapzEGWFEpHFxgEaBG8e3n6S8L3MSu0oda755rOfabWPnh0Our1AozNFVUxGFIhbKgd1ksprsoDGMinTOTA==", + "version": "7.26.9", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.9.tgz", + "integrity": "sha512-Y3IR1cRnOxOCDvMmNiym7XpXQ93iGDDPHx+Zj+NM+rg0fBaShfQLkg+hKPaZCEvg5N/LeCo4+Rj/i3FuJsIQaw==", "dev": true, "license": "MIT", "dependencies": { @@ -971,13 +970,6 @@ "@babel/types": "^7.20.7" } }, - "node_modules/@types/gensync": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@types/gensync/-/gensync-1.0.4.tgz", - "integrity": "sha512-C3YYeRQWp2fmq9OryX+FoDy8nXS6scQ7dPptD8LnFDAUNcKWJjXQKDNJD3HVm+kOUsXhTOkpi69vI4EuAr95bA==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/graceful-fs": { "version": "4.1.9", "resolved": "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.9.tgz", @@ -1027,9 +1019,9 @@ } }, "node_modules/@types/jsonwebtoken": { - "version": "9.0.8", - "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-9.0.8.tgz", - "integrity": "sha512-7fx54m60nLFUVYlxAB1xpe9CBWX2vSrk50Y6ogRJ1v5xxtba7qXTg5BgYDN5dq+yuQQ9HaVlHJyAAt1/mxryFg==", + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-9.0.9.tgz", + "integrity": "sha512-uoe+GxEuHbvy12OUQct2X9JenKM3qAscquYymuQN4fMWG9DBQtykrQEFcAbVACF7qaLw9BePSodUL0kquqBJpQ==", "dev": true, "license": "MIT", "dependencies": { @@ -1388,6 +1380,19 @@ "dev": true, "license": "MIT" }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -1409,9 +1414,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001699", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001699.tgz", - "integrity": "sha512-b+uH5BakXZ9Do9iK+CkDmctUSEqZl+SP056vc5usa0PL+ev5OHw003rZXcnjNDv3L8P5j6rwT6C0BPKSikW08w==", + "version": "1.0.30001700", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001700.tgz", + "integrity": "sha512-2S6XIXwaE7K7erT8dY+kLQcpa5ms63XlRkMkReXjle+kf6c5g38vyMl+Z5y8dSxOFDhcFe+nxnn261PLxBSQsQ==", "dev": true, "funding": [ { @@ -1667,6 +1672,20 @@ "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/ecdsa-sig-formatter": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", @@ -1677,9 +1696,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.97", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.97.tgz", - "integrity": "sha512-HKLtaH02augM7ZOdYRuO19rWDeY+QSJ1VxnXFa/XDFLf07HvM90pALIJFgrO+UVaajI3+aJMMpojoUTLZyQ7JQ==", + "version": "1.5.103", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.103.tgz", + "integrity": "sha512-P6+XzIkfndgsrjROJWfSvVEgNHtPgbhVyTkwLjUM2HU/h7pZRORgaTlHqfAikqxKmdJMLW8fftrdGWbd/Ds0FA==", "dev": true, "license": "ISC" }, @@ -1713,6 +1732,51 @@ "is-arrayish": "^0.2.1" } }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", + "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.6", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", @@ -1862,13 +1926,14 @@ } }, "node_modules/form-data": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.1.tgz", - "integrity": "sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.2.tgz", + "integrity": "sha512-hGfm/slu0ZabnNt4oaRZ6uREyfCj6P4fT/n6A1rGV+Z0VdGXjfOhVUpkn6qVQONHGIFwmveGXyDs75+nr6FM8w==", "license": "MIT", "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", + "es-set-tostringtag": "^2.1.0", "mime-types": "^2.1.12" }, "engines": { @@ -1901,7 +1966,6 @@ "version": "1.1.2", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "dev": true, "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" @@ -1927,6 +1991,30 @@ "node": "6.* || 8.* || >= 10.*" } }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/get-package-type": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", @@ -1937,6 +2025,19 @@ "node": ">=8.0.0" } }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -1982,6 +2083,18 @@ "node": ">=4" } }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", @@ -1999,11 +2112,37 @@ "node": ">=8" } }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/hasown": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, "license": "MIT", "dependencies": { "function-bind": "^1.1.2" @@ -3101,6 +3240,15 @@ "tmpl": "1.0.5" } }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", diff --git a/package.json b/package.json index 31e5bba..985015d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fireblocks/ts-sdk", - "version": "8.0.1", + "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 3cdb157..998db20 100644 --- a/tests/client.spec.ts +++ b/tests/client.spec.ts @@ -44,7 +44,7 @@ SmartTransferApi, StakingApi, TokenizationApi, TransactionsApi, -TravelRuleBetaApi, +TravelRuleApi, UserGroupsBetaApi, UsersApi, VaultsApi, @@ -91,7 +91,7 @@ let mockSmartTransferApi: jest.Mock; let mockStakingApi: jest.Mock; let mockTokenizationApi: jest.Mock; let mockTransactionsApi: jest.Mock; -let mockTravelRuleBetaApi: jest.Mock; +let mockTravelRuleApi: jest.Mock; let mockUserGroupsBetaApi: jest.Mock; let mockUsersApi: jest.Mock; let mockVaultsApi: jest.Mock; @@ -135,7 +135,7 @@ jest.mock('../api', () => { mockStakingApi = jest.fn(); mockTokenizationApi = jest.fn(); mockTransactionsApi = jest.fn(); - mockTravelRuleBetaApi = jest.fn(); + mockTravelRuleApi = jest.fn(); mockUserGroupsBetaApi = jest.fn(); mockUsersApi = jest.fn(); mockVaultsApi = jest.fn(); @@ -180,7 +180,7 @@ jest.mock('../api', () => { StakingApi: mockStakingApi, TokenizationApi: mockTokenizationApi, TransactionsApi: mockTransactionsApi, - TravelRuleBetaApi: mockTravelRuleBetaApi, + TravelRuleApi: mockTravelRuleApi, UserGroupsBetaApi: mockUserGroupsBetaApi, UsersApi: mockUsersApi, VaultsApi: mockVaultsApi, @@ -400,9 +400,9 @@ describe("Fireblocks Client Tests", () => { expect(fireblocks.transactions).toBeInstanceOf(TransactionsApi); expect(mockTransactionsApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); - it('Should return TravelRuleBetaApi', async () => { - expect(fireblocks.travelRuleBeta).toBeInstanceOf(TravelRuleBetaApi); - expect(mockTravelRuleBetaApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); + it('Should return TravelRuleApi', async () => { + expect(fireblocks.travelRule).toBeInstanceOf(TravelRuleApi); + expect(mockTravelRuleApi).toHaveBeenCalledWith(expectedConfig, undefined, mockAxios); }); it('Should return UserGroupsBetaApi', async () => { expect(fireblocks.userGroupsBeta).toBeInstanceOf(UserGroupsBetaApi);