/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { TravelRuleGetAllVASPsResponse } from '../models'; import { TravelRuleUpdateVASPDetails } from '../models'; import { TravelRuleVASP } from '../models'; import { TravelRuleValidateFullTransactionRequest } from '../models'; import { TravelRuleValidateTransactionResponse } from '../models'; import { TravelRuleVaspForVault } from '../models'; import { TrustProofOfAddressCreateResponse } from '../models'; import { TrustProofOfAddressRequest } from '../models'; import { TrustProofOfAddressResponse } from '../models'; /** * TravelRuleApi - axios parameter creator * @export */ export declare const TravelRuleApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a cryptographic proof of address ownership for TRUST network. * @summary Create Trust Network Proof of Address * @param {TrustProofOfAddressRequest} trustProofOfAddressRequest * @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} */ createTrustProofOfAddress: (trustProofOfAddressRequest: TrustProofOfAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification. * @summary Retrieve Trust Network Proof of Address Signature * @param {string} transactionId Fireblocks transaction ID (UUID format) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrustProofOfAddress: (transactionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get VASP Details. Returns information about a VASP that has the specified DID. The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get VASP details * @param {string} did The Decentralized Identifier (DID) of the VASP. * @param {Array} [fields] The VASP fields to return. Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing `all`. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVASPByDID: (did: string, fields?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in the response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get All VASPs * @param {GetVASPsOrderEnum} [order] Field to order by * @param {number} [pageSize] Records per page * @param {Array} [fields] The VASP fields to return. Optional. If omitted, each VASP is returned with a default subset of six fields: `did`, `name`, `website`, `logo`, `incorporationCountry` and `jurisdictions`. Pass `all` to return the complete record for each VASP. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @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: (order?: GetVASPsOrderEnum, pageSize?: number, fields?: Array, search?: string, reviewValue?: GetVASPsReviewValueEnum, pageCursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * 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 {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaspForVault: (vaultAccountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault * @param {TravelRuleVaspForVault} travelRuleVaspForVault * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaspForVault: (travelRuleVaspForVault: TravelRuleVaspForVault, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVasp: (travelRuleUpdateVASPDetails: TravelRuleUpdateVASPDetails, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * 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: (travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, notation?: Array, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * TravelRuleApi - functional programming interface * @export */ export declare const TravelRuleApiFp: (configuration?: Configuration) => { /** * Creates a cryptographic proof of address ownership for TRUST network. * @summary Create Trust Network Proof of Address * @param {TrustProofOfAddressRequest} trustProofOfAddressRequest * @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} */ createTrustProofOfAddress(trustProofOfAddressRequest: TrustProofOfAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification. * @summary Retrieve Trust Network Proof of Address Signature * @param {string} transactionId Fireblocks transaction ID (UUID format) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrustProofOfAddress(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get VASP Details. Returns information about a VASP that has the specified DID. The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get VASP details * @param {string} did The Decentralized Identifier (DID) of the VASP. * @param {Array} [fields] The VASP fields to return. Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing `all`. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVASPByDID(did: string, fields?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in the response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get All VASPs * @param {GetVASPsOrderEnum} [order] Field to order by * @param {number} [pageSize] Records per page * @param {Array} [fields] The VASP fields to return. Optional. If omitted, each VASP is returned with a default subset of six fields: `did`, `name`, `website`, `logo`, `incorporationCountry` and `jurisdictions`. Pass `all` to return the complete record for each VASP. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @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(order?: GetVASPsOrderEnum, pageSize?: number, fields?: Array, search?: string, reviewValue?: GetVASPsReviewValueEnum, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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 {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaspForVault(vaultAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault * @param {TravelRuleVaspForVault} travelRuleVaspForVault * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaspForVault(travelRuleVaspForVault: TravelRuleVaspForVault, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVasp(travelRuleUpdateVASPDetails: TravelRuleUpdateVASPDetails, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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(travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest, notation?: Array, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TravelRuleApi - factory interface * @export */ export declare const TravelRuleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a cryptographic proof of address ownership for TRUST network. * @summary Create Trust Network Proof of Address * @param {TravelRuleApiCreateTrustProofOfAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTrustProofOfAddress(requestParameters: TravelRuleApiCreateTrustProofOfAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification. * @summary Retrieve Trust Network Proof of Address Signature * @param {TravelRuleApiGetTrustProofOfAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrustProofOfAddress(requestParameters: TravelRuleApiGetTrustProofOfAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get VASP Details. Returns information about a VASP that has the specified DID. The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get VASP details * @param {TravelRuleApiGetVASPByDIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVASPByDID(requestParameters: TravelRuleApiGetVASPByDIDRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in the response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get All VASPs * @param {TravelRuleApiGetVASPsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVASPs(requestParameters?: TravelRuleApiGetVASPsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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 {TravelRuleApiGetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaspForVault(requestParameters: TravelRuleApiGetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault * @param {TravelRuleApiSetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaspForVault(requestParameters: TravelRuleApiSetVaspForVaultRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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 {TravelRuleApiUpdateVaspRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVasp(requestParameters: TravelRuleApiUpdateVaspRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction * @param {TravelRuleApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateFullTravelRuleTransaction(requestParameters: TravelRuleApiValidateFullTravelRuleTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createTrustProofOfAddress operation in TravelRuleApi. * @export * @interface TravelRuleApiCreateTrustProofOfAddressRequest */ export interface TravelRuleApiCreateTrustProofOfAddressRequest { /** * * @type {TrustProofOfAddressRequest} * @memberof TravelRuleApiCreateTrustProofOfAddress */ readonly trustProofOfAddressRequest: TrustProofOfAddressRequest; /** * 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 TravelRuleApiCreateTrustProofOfAddress */ readonly idempotencyKey?: string; } /** * Request parameters for getTrustProofOfAddress operation in TravelRuleApi. * @export * @interface TravelRuleApiGetTrustProofOfAddressRequest */ export interface TravelRuleApiGetTrustProofOfAddressRequest { /** * Fireblocks transaction ID (UUID format) * @type {string} * @memberof TravelRuleApiGetTrustProofOfAddress */ readonly transactionId: string; } /** * Request parameters for getVASPByDID operation in TravelRuleApi. * @export * @interface TravelRuleApiGetVASPByDIDRequest */ export interface TravelRuleApiGetVASPByDIDRequest { /** * The Decentralized Identifier (DID) of the VASP. * @type {string} * @memberof TravelRuleApiGetVASPByDID */ readonly did: string; /** * The VASP fields to return. Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing `all`. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @type {TravelRuleFieldsEnum} * @memberof TravelRuleApiGetVASPByDID */ readonly fields?: Array; } /** * Request parameters for getVASPs operation in TravelRuleApi. * @export * @interface TravelRuleApiGetVASPsRequest */ export interface TravelRuleApiGetVASPsRequest { /** * Field to order by * @type {'ASC' | 'DESC'} * @memberof TravelRuleApiGetVASPs */ readonly order?: GetVASPsOrderEnum; /** * Records per page * @type {number} * @memberof TravelRuleApiGetVASPs */ readonly pageSize?: number; /** * The VASP fields to return. Optional. If omitted, each VASP is returned with a default subset of six fields: `did`, `name`, `website`, `logo`, `incorporationCountry` and `jurisdictions`. Pass `all` to return the complete record for each VASP. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error. * @type {TravelRuleFieldsEnum} * @memberof TravelRuleApiGetVASPs */ readonly fields?: Array; /** * Search query * @type {string} * @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 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 TravelRuleApi. * @export * @interface TravelRuleApiGetVaspForVaultRequest */ export interface TravelRuleApiGetVaspForVaultRequest { /** * The ID of the vault account * @type {string} * @memberof TravelRuleApiGetVaspForVault */ readonly vaultAccountId: string; } /** * Request parameters for setVaspForVault operation in TravelRuleApi. * @export * @interface TravelRuleApiSetVaspForVaultRequest */ export interface TravelRuleApiSetVaspForVaultRequest { /** * * @type {TravelRuleVaspForVault} * @memberof TravelRuleApiSetVaspForVault */ readonly travelRuleVaspForVault: TravelRuleVaspForVault; /** * The ID of the vault account * @type {string} * @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 TravelRuleApiSetVaspForVault */ readonly idempotencyKey?: string; } /** * Request parameters for updateVasp operation in TravelRuleApi. * @export * @interface TravelRuleApiUpdateVaspRequest */ export interface TravelRuleApiUpdateVaspRequest { /** * * @type {TravelRuleUpdateVASPDetails} * @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 TravelRuleApiUpdateVasp */ readonly idempotencyKey?: string; } /** * Request parameters for validateFullTravelRuleTransaction operation in TravelRuleApi. * @export * @interface TravelRuleApiValidateFullTravelRuleTransactionRequest */ export interface TravelRuleApiValidateFullTravelRuleTransactionRequest { /** * * @type {TravelRuleValidateFullTransactionRequest} * @memberof TravelRuleApiValidateFullTravelRuleTransaction */ readonly travelRuleValidateFullTransactionRequest: TravelRuleValidateFullTransactionRequest; /** * 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 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 TravelRuleApiValidateFullTravelRuleTransaction */ readonly idempotencyKey?: string; } /** * TravelRuleApi - object-oriented interface * @export * @class TravelRuleApi * @extends {BaseAPI} */ export declare class TravelRuleApi extends BaseAPI { /** * Creates a cryptographic proof of address ownership for TRUST network. * @summary Create Trust Network Proof of Address * @param {TravelRuleApiCreateTrustProofOfAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ createTrustProofOfAddress(requestParameters: TravelRuleApiCreateTrustProofOfAddressRequest): Promise>; /** * Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification. * @summary Retrieve Trust Network Proof of Address Signature * @param {TravelRuleApiGetTrustProofOfAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ getTrustProofOfAddress(requestParameters: TravelRuleApiGetTrustProofOfAddressRequest): Promise>; /** * Get VASP Details. Returns information about a VASP that has the specified DID. The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get VASP details * @param {TravelRuleApiGetVASPByDIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ getVASPByDID(requestParameters: TravelRuleApiGetVASPByDIDRequest): Promise>; /** * Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in the response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize. * @summary Get All VASPs * @param {TravelRuleApiGetVASPsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ getVASPs(requestParameters?: TravelRuleApiGetVASPsRequest): Promise>; /** * 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 {TravelRuleApiGetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ getVaspForVault(requestParameters: TravelRuleApiGetVaspForVaultRequest): Promise>; /** * Sets the VASP Did for a specific vault. Pass empty string to remove existing one. * @summary Assign VASP to vault * @param {TravelRuleApiSetVaspForVaultRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ setVaspForVault(requestParameters: TravelRuleApiSetVaspForVaultRequest): Promise>; /** * 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 {TravelRuleApiUpdateVaspRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ updateVasp(requestParameters: TravelRuleApiUpdateVaspRequest): Promise>; /** * Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs. * @summary Validate Full Travel Rule Transaction * @param {TravelRuleApiValidateFullTravelRuleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TravelRuleApi */ validateFullTravelRuleTransaction(requestParameters: TravelRuleApiValidateFullTravelRuleTransactionRequest): Promise>; } /** * @export */ export declare const GetVASPByDIDFieldsEnum: { readonly All: "all"; readonly Did: "did"; readonly Name: "name"; readonly VerificationStatus: "verificationStatus"; readonly AddressLine1: "addressLine1"; readonly AddressLine2: "addressLine2"; readonly City: "city"; readonly Country: "country"; readonly EmailDomains: "emailDomains"; readonly Website: "website"; readonly Logo: "logo"; readonly LegalStructure: "legalStructure"; readonly LegalName: "legalName"; readonly YearFounded: "yearFounded"; readonly IncorporationCountry: "incorporationCountry"; readonly IsRegulated: "isRegulated"; readonly OtherNames: "otherNames"; readonly IdentificationType: "identificationType"; readonly IdentificationCountry: "identificationCountry"; readonly BusinessNumber: "businessNumber"; readonly RegulatoryAuthorities: "regulatoryAuthorities"; readonly Jurisdictions: "jurisdictions"; readonly Division: "division"; readonly Street: "street"; readonly Number: "number"; readonly Unit: "unit"; readonly PostCode: "postCode"; readonly State: "state"; readonly OtherLegalName: "otherLegalName"; readonly GleifUpdatedAt: "gleifUpdatedAt"; readonly LeiNumber: "leiNumber"; readonly LegalForm: "legalForm"; readonly EntityCategory: "entityCategory"; readonly EntityStatus: "entityStatus"; readonly ExternalEntityConfig: "externalEntityConfig"; readonly HqStreet: "hqStreet"; readonly HqNumber: "hqNumber"; readonly HqPostcode: "hqPostcode"; readonly HqRegion: "hqRegion"; readonly HqCity: "hqCity"; readonly HqCountry: "hqCountry"; readonly Certificates: "certificates"; readonly Description: "description"; readonly TravelRuleOpenvasp: "travelRule_OPENVASP"; readonly TravelRuleSygna: "travelRule_SYGNA"; readonly TravelRuleTrisa: "travelRule_TRISA"; readonly TravelRuleTrlight: "travelRule_TRLIGHT"; readonly TravelRuleEmail: "travelRule_EMAIL"; readonly TravelRuleTrp: "travelRule_TRP"; readonly TravelRuleShyft: "travelRule_SHYFT"; readonly TravelRuleUstravelrulewg: "travelRule_USTRAVELRULEWG"; readonly CreatedAt: "createdAt"; readonly CreatedBy: "createdBy"; readonly UpdatedAt: "updatedAt"; readonly UpdatedBy: "updatedBy"; readonly LastSentDate: "lastSentDate"; readonly LastReceivedDate: "lastReceivedDate"; readonly Documents: "documents"; readonly HasAdmin: "hasAdmin"; readonly IsNotifiable: "isNotifiable"; readonly Issuers: "issuers"; readonly RegulatoryStatus: "regulatoryStatus"; readonly SupervisoryAuthority: "supervisoryAuthority"; readonly RegistrationLicenseId: "registrationLicenseId"; readonly StatusStartDate: "statusStartDate"; readonly StatusExpirationDate: "statusExpirationDate"; readonly LastChecked: "lastChecked"; readonly AdditionalInformation: "additionalInformation"; readonly SubsidiaryOf: "subsidiaryOf"; readonly PiiDidkey: "pii_didkey"; readonly CompliancePhase: "compliancePhase"; readonly CompliancePhaseData: "compliancePhaseData"; readonly VaspnetId: "vaspnetId"; readonly VaspnetUpdatedAt: "vaspnetUpdatedAt"; readonly VaspnetImmutableFields: "vaspnetImmutableFields"; readonly NodeDidkey: "node_didkey"; readonly Ddq: "ddq"; readonly TargetProtocol: "targetProtocol"; readonly ParentGateway: "parentGateway"; readonly IsActiveSender: "isActiveSender"; readonly IsActiveReceiver: "isActiveReceiver"; readonly Subsidiaries: "subsidiaries"; }; export type GetVASPByDIDFieldsEnum = typeof GetVASPByDIDFieldsEnum[keyof typeof GetVASPByDIDFieldsEnum]; /** * @export */ export declare const GetVASPsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetVASPsOrderEnum = typeof GetVASPsOrderEnum[keyof typeof GetVASPsOrderEnum]; /** * @export */ export declare const GetVASPsFieldsEnum: { readonly All: "all"; readonly Did: "did"; readonly Name: "name"; readonly VerificationStatus: "verificationStatus"; readonly AddressLine1: "addressLine1"; readonly AddressLine2: "addressLine2"; readonly City: "city"; readonly Country: "country"; readonly EmailDomains: "emailDomains"; readonly Website: "website"; readonly Logo: "logo"; readonly LegalStructure: "legalStructure"; readonly LegalName: "legalName"; readonly YearFounded: "yearFounded"; readonly IncorporationCountry: "incorporationCountry"; readonly IsRegulated: "isRegulated"; readonly OtherNames: "otherNames"; readonly IdentificationType: "identificationType"; readonly IdentificationCountry: "identificationCountry"; readonly BusinessNumber: "businessNumber"; readonly RegulatoryAuthorities: "regulatoryAuthorities"; readonly Jurisdictions: "jurisdictions"; readonly Division: "division"; readonly Street: "street"; readonly Number: "number"; readonly Unit: "unit"; readonly PostCode: "postCode"; readonly State: "state"; readonly OtherLegalName: "otherLegalName"; readonly GleifUpdatedAt: "gleifUpdatedAt"; readonly LeiNumber: "leiNumber"; readonly LegalForm: "legalForm"; readonly EntityCategory: "entityCategory"; readonly EntityStatus: "entityStatus"; readonly ExternalEntityConfig: "externalEntityConfig"; readonly HqStreet: "hqStreet"; readonly HqNumber: "hqNumber"; readonly HqPostcode: "hqPostcode"; readonly HqRegion: "hqRegion"; readonly HqCity: "hqCity"; readonly HqCountry: "hqCountry"; readonly Certificates: "certificates"; readonly Description: "description"; readonly TravelRuleOpenvasp: "travelRule_OPENVASP"; readonly TravelRuleSygna: "travelRule_SYGNA"; readonly TravelRuleTrisa: "travelRule_TRISA"; readonly TravelRuleTrlight: "travelRule_TRLIGHT"; readonly TravelRuleEmail: "travelRule_EMAIL"; readonly TravelRuleTrp: "travelRule_TRP"; readonly TravelRuleShyft: "travelRule_SHYFT"; readonly TravelRuleUstravelrulewg: "travelRule_USTRAVELRULEWG"; readonly CreatedAt: "createdAt"; readonly CreatedBy: "createdBy"; readonly UpdatedAt: "updatedAt"; readonly UpdatedBy: "updatedBy"; readonly LastSentDate: "lastSentDate"; readonly LastReceivedDate: "lastReceivedDate"; readonly Documents: "documents"; readonly HasAdmin: "hasAdmin"; readonly IsNotifiable: "isNotifiable"; readonly Issuers: "issuers"; readonly RegulatoryStatus: "regulatoryStatus"; readonly SupervisoryAuthority: "supervisoryAuthority"; readonly RegistrationLicenseId: "registrationLicenseId"; readonly StatusStartDate: "statusStartDate"; readonly StatusExpirationDate: "statusExpirationDate"; readonly LastChecked: "lastChecked"; readonly AdditionalInformation: "additionalInformation"; readonly SubsidiaryOf: "subsidiaryOf"; readonly PiiDidkey: "pii_didkey"; readonly CompliancePhase: "compliancePhase"; readonly CompliancePhaseData: "compliancePhaseData"; readonly VaspnetId: "vaspnetId"; readonly VaspnetUpdatedAt: "vaspnetUpdatedAt"; readonly VaspnetImmutableFields: "vaspnetImmutableFields"; readonly NodeDidkey: "node_didkey"; readonly Ddq: "ddq"; readonly TargetProtocol: "targetProtocol"; readonly ParentGateway: "parentGateway"; readonly IsActiveSender: "isActiveSender"; readonly IsActiveReceiver: "isActiveReceiver"; readonly Subsidiaries: "subsidiaries"; }; export type GetVASPsFieldsEnum = typeof GetVASPsFieldsEnum[keyof typeof GetVASPsFieldsEnum]; /** * @export */ export declare const GetVASPsReviewValueEnum: { readonly Trusted: "TRUSTED"; readonly Blocked: "BLOCKED"; readonly Manual: "MANUAL"; readonly Null: "null"; }; export type GetVASPsReviewValueEnum = typeof GetVASPsReviewValueEnum[keyof typeof GetVASPsReviewValueEnum]; /** * @export */ export declare const ValidateFullTravelRuleTransactionNotationEnum: { readonly Fireblocks: "fireblocks"; readonly Notabene: "notabene"; }; export type ValidateFullTravelRuleTransactionNotationEnum = typeof ValidateFullTravelRuleTransactionNotationEnum[keyof typeof ValidateFullTravelRuleTransactionNotationEnum];