Merge pull request #173 from fireblocks/PIK-9685-fireblocks-network-link-add-the-rate-request-to-the-nlv-2

feat | Pik-9685 | fireblocks network link add the rate request to the nlv 2

Author: asafchn

v2/api-validator/capability-presets/all-capabilities/capabilities.json

@@ -9,6 +9,7 @@
     "transfersFiat": "*",
     "transfersPeerAccounts": "*",
     "trading": "*",
-    "liquidity": "*"
+    "liquidity": "*",
+    "rates": "*"
   }
-}
+}

v2/api-validator/src/client/SecureClient.ts

@@ -21,6 +21,7 @@ import {
   OpenAPI,
   OpenAPIConfig,
   RampsService,
+  RatesService,
   TradingService,
   TransfersBlockchainService,
   TransfersFiatService,
@@ -105,6 +106,7 @@ export class SecureClient {
   public readonly transfersInternal: SecureService<TransfersInternalService>;
   public readonly collateral: SecureService<CollateralService>;
   public readonly ramps: SecureService<RampsService>;
+  public readonly rates: SecureService<RatesService>;
   private readonly request: BaseHttpRequest;
 
   private static cachedApiComponents?: ApiComponents;
@@ -116,6 +118,7 @@ export class SecureClient {
       BASE: config.get('client').serverBaseUrl,
     });
 
+    this.rates = stripSecurityHeaderArgs(new RatesService(this.request));
     this.accounts = stripSecurityHeaderArgs(new AccountsService(this.request));
     this.balances = stripSecurityHeaderArgs(new BalancesService(this.request));
     this.capabilities = stripSecurityHeaderArgs(new CapabilitiesService(this.request));

v2/api-validator/src/client/generated/ApiClient.ts

@@ -13,6 +13,7 @@ import { CollateralService } from './services/CollateralService';
 import { HistoricBalancesService } from './services/HistoricBalancesService';
 import { LiquidityService } from './services/LiquidityService';
 import { RampsService } from './services/RampsService';
+import { RatesService } from './services/RatesService';
 import { TradingService } from './services/TradingService';
 import { TransfersService } from './services/TransfersService';
 import { TransfersBlockchainService } from './services/TransfersBlockchainService';
@@ -31,6 +32,7 @@ export class ApiClient {
     public readonly historicBalances: HistoricBalancesService;
     public readonly liquidity: LiquidityService;
     public readonly ramps: RampsService;
+    public readonly rates: RatesService;
     public readonly trading: TradingService;
     public readonly transfers: TransfersService;
     public readonly transfersBlockchain: TransfersBlockchainService;
@@ -60,6 +62,7 @@ export class ApiClient {
         this.historicBalances = new HistoricBalancesService(this.request);
         this.liquidity = new LiquidityService(this.request);
         this.ramps = new RampsService(this.request);
+        this.rates = new RatesService(this.request);
         this.trading = new TradingService(this.request);
         this.transfers = new TransfersService(this.request);
         this.transfersBlockchain = new TransfersBlockchainService(this.request);

v2/api-validator/src/client/generated/index.ts

@@ -72,6 +72,7 @@ export type { CollateralWithdrawalTransactions } from './models/CollateralWithdr
 export { CollateralWithdrawalTransactionStatus } from './models/CollateralWithdrawalTransactionStatus';
 export type { CommonRamp } from './models/CommonRamp';
 export type { CommonRampRequestProperties } from './models/CommonRampRequestProperties';
+export type { ConversionPairIdQueryParam } from './models/ConversionPairIdQueryParam';
 export { CountryAlpha2Code } from './models/CountryAlpha2Code';
 export type { CryptocurrencyReference } from './models/CryptocurrencyReference';
 export { CryptocurrencySymbol } from './models/CryptocurrencySymbol';
@@ -127,6 +128,7 @@ export { OnRampProperties } from './models/OnRampProperties';
 export type { OnRampPropertiesWithPaymentInstructions } from './models/OnRampPropertiesWithPaymentInstructions';
 export type { Order } from './models/Order';
 export type { OrderBook } from './models/OrderBook';
+export type { OrderBookPairIdQueryParam } from './models/OrderBookPairIdQueryParam';
 export type { OrderCommonProperties } from './models/OrderCommonProperties';
 export type { OrderData } from './models/OrderData';
 export { OrderQuote } from './models/OrderQuote';
@@ -173,7 +175,9 @@ export type { RampFees } from './models/RampFees';
 export type { RampFiatTransfer } from './models/RampFiatTransfer';
 export type { RampMethod } from './models/RampMethod';
 export type { RampRequest } from './models/RampRequest';
+export type { RampsPairIdQueryParam } from './models/RampsPairIdQueryParam';
 export { RampStatus } from './models/RampStatus';
+export type { Rate } from './models/Rate';
 export { RequestPart } from './models/RequestPart';
 export type { RoutingNumber } from './models/RoutingNumber';
 export type { SettlementDepositInstruction } from './models/SettlementDepositInstruction';
@@ -222,6 +226,7 @@ export { CollateralService } from './services/CollateralService';
 export { HistoricBalancesService } from './services/HistoricBalancesService';
 export { LiquidityService } from './services/LiquidityService';
 export { RampsService } from './services/RampsService';
+export { RatesService } from './services/RatesService';
 export { TradingService } from './services/TradingService';
 export { TransfersService } from './services/TransfersService';
 export { TransfersBlockchainService } from './services/TransfersBlockchainService';

v2/api-validator/src/client/generated/models/ApiComponents.ts

@@ -21,5 +21,6 @@ export type ApiComponents = {
     liquidity?: AccountsSet;
     collateral?: AccountsSet;
     ramps?: AccountsSet;
+    rates?: AccountsSet;
 };
 

v2/api-validator/src/client/generated/models/ConversionPairIdQueryParam.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Conversion pair to get the rate for.
+ */
+export type ConversionPairIdQueryParam = string;

v2/api-validator/src/client/generated/models/OrderBookPairIdQueryParam.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Order book pair to get the rate for.
+ */
+export type OrderBookPairIdQueryParam = string;

v2/api-validator/src/client/generated/models/RampsPairIdQueryParam.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Ramps pair to get the rate for.
+ */
+export type RampsPairIdQueryParam = string;

v2/api-validator/src/client/generated/models/Rate.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type Rate = {
+    rate: string;
+    /**
+     * In Milliseconds. The timestamp on the creation of the rate.
+     */
+    timestamp: number;
+};
+

v2/api-validator/src/client/generated/services/RatesService.ts

@@ -0,0 +1,87 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Rate } from '../models/Rate';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class RatesService {
+
+    constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+    /**
+     * Get rate by account and assets
+     * @returns Rate Rate by pair id.
+     * @throws ApiError
+     */
+    public getRateByAccountAndPairId({
+        xFbapiKey,
+        xFbapiNonce,
+        xFbapiTimestamp,
+        xFbapiSignature,
+        accountId,
+        conversionPairId,
+        rampsPairId,
+        orderBookPairId,
+    }: {
+        /**
+         * API authentication key.
+         */
+        xFbapiKey: string,
+        /**
+         * Unique identifier of the request.
+         */
+        xFbapiNonce: string,
+        /**
+         * Request timestamp in milliseconds since Unix epoch.
+         */
+        xFbapiTimestamp: number,
+        /**
+         * Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:
+         * - `X-FBAPI-TIMESTAMP` - `X-FBAPI-NONCE` - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
+         */
+        xFbapiSignature: string,
+        /**
+         * Sub-account identifier.
+         */
+        accountId: string,
+        /**
+         * Conversion pair to get the rate for.
+         */
+        conversionPairId?: string,
+        /**
+         * Ramps pair to get the rate for.
+         */
+        rampsPairId?: string,
+        /**
+         * Order book pair to get the rate for.
+         */
+        orderBookPairId?: string,
+    }): CancelablePromise<Rate> {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/accounts/{accountId}/rate',
+            path: {
+                'accountId': accountId,
+            },
+            headers: {
+                'X-FBAPI-KEY': xFbapiKey,
+                'X-FBAPI-NONCE': xFbapiNonce,
+                'X-FBAPI-TIMESTAMP': xFbapiTimestamp,
+                'X-FBAPI-SIGNATURE': xFbapiSignature,
+            },
+            query: {
+                'conversionPairId': conversionPairId,
+                'rampsPairId': rampsPairId,
+                'orderBookPairId': orderBookPairId,
+            },
+            errors: {
+                400: `Request could not be processed due to a client error.`,
+                401: `Request is unauthorized`,
+            },
+        });
+    }
+
+}