Merge pull request #96 from fireblocks/collateral-api-add-generated

Regenerate client and models to include collateral API

v2/api-validator/package.json

@@ -17,7 +17,7 @@
     "server": "NODE_ENV=development ts-node src/server/server.ts | pino-pretty; [ \"${PIPESTATUS[0]}\" -ne 0 ] && (echo \"\\nServer execution failed. There should be an error log above ^\"; exit 1)",
     "lint": "eslint src tests",
     "lint:fix": "eslint src tests --fix",
-    "test": "NODE_ENV=test jest --verbose --json --outputFile=test-results.json",
+    "test": "NODE_ENV=test jest --testTimeout=30000 --verbose --json --outputFile=test-results.json",
     "test:watch": "npm run test -- --watch",
     "test:sanity": "npm run test -- --config=jest.sanity.config.ts tests/sanity-tests",
     "test:sanity:watch": "npm run test:sanity -- --watch",

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

@@ -9,6 +9,7 @@ import { AxiosHttpRequest } from './core/AxiosHttpRequest';
 import { AccountsService } from './services/AccountsService';
 import { BalancesService } from './services/BalancesService';
 import { CapabilitiesService } from './services/CapabilitiesService';
+import { CollateralService } from './services/CollateralService';
 import { HistoricBalancesService } from './services/HistoricBalancesService';
 import { LiquidityService } from './services/LiquidityService';
 import { TradingService } from './services/TradingService';
@@ -25,6 +26,7 @@ export class ApiClient {
     public readonly accounts: AccountsService;
     public readonly balances: BalancesService;
     public readonly capabilities: CapabilitiesService;
+    public readonly collateral: CollateralService;
     public readonly historicBalances: HistoricBalancesService;
     public readonly liquidity: LiquidityService;
     public readonly trading: TradingService;
@@ -52,6 +54,7 @@ export class ApiClient {
         this.accounts = new AccountsService(this.request);
         this.balances = new BalancesService(this.request);
         this.capabilities = new CapabilitiesService(this.request);
+        this.collateral = new CollateralService(this.request);
         this.historicBalances = new HistoricBalancesService(this.request);
         this.liquidity = new LiquidityService(this.request);
         this.trading = new TradingService(this.request);

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

@@ -20,6 +20,7 @@ export { AccountStatus } from './models/AccountStatus';
 export type { ApiComponents } from './models/ApiComponents';
 export type { AssetBalance } from './models/AssetBalance';
 export type { AssetCommonProperties } from './models/AssetCommonProperties';
+export type { AssetCreditBalance } from './models/AssetCreditBalance';
 export type { AssetDefinition } from './models/AssetDefinition';
 export type { AssetIdQueryParam } from './models/AssetIdQueryParam';
 export type { AssetReference } from './models/AssetReference';
@@ -31,6 +32,23 @@ export type { BlockchainWithdrawal } from './models/BlockchainWithdrawal';
 export type { BlockchainWithdrawalRequest } from './models/BlockchainWithdrawalRequest';
 export { BucketAsset } from './models/BucketAsset';
 export type { Capabilities } from './models/Capabilities';
+export type { CollateralAccount } from './models/CollateralAccount';
+export type { CollateralAccountLink } from './models/CollateralAccountLink';
+export type { CollateralAddress } from './models/CollateralAddress';
+export type { CollateralAsset } from './models/CollateralAsset';
+export type { CollateralAssetAddress } from './models/CollateralAssetAddress';
+export type { CollateralAssetMapping } from './models/CollateralAssetMapping';
+export type { CollateralDepositAddresses } from './models/CollateralDepositAddresses';
+export type { CollateralDepositTransaction } from './models/CollateralDepositTransaction';
+export { CollateralDepositTransactionStatus } from './models/CollateralDepositTransactionStatus';
+export type { CollateralId } from './models/CollateralId';
+export type { CollateralIdPathParam } from './models/CollateralIdPathParam';
+export { CollateralLinkStatus } from './models/CollateralLinkStatus';
+export type { CollateralSignerId } from './models/CollateralSignerId';
+export type { CollateralTxIdPathParam } from './models/CollateralTxIdPathParam';
+export type { CollateralWithdrawalTransaction } from './models/CollateralWithdrawalTransaction';
+export type { CollateralWithdrawalTransactionRequest } from './models/CollateralWithdrawalTransactionRequest';
+export { CollateralWithdrawalTransactionStatus } from './models/CollateralWithdrawalTransactionStatus';
 export type { CryptocurrencyReference } from './models/CryptocurrencyReference';
 export { CryptocurrencySymbol } from './models/CryptocurrencySymbol';
 export type { CryptocurrencySymbolQueryParam } from './models/CryptocurrencySymbolQueryParam';
@@ -43,11 +61,13 @@ export type { DepositCapability } from './models/DepositCapability';
 export type { DepositDestination } from './models/DepositDestination';
 export { DepositStatus } from './models/DepositStatus';
 export type { EntityIdPathParam } from './models/EntityIdPathParam';
+export { Environment } from './models/Environment';
 export { Erc20Token } from './models/Erc20Token';
 export type { FiatTransfer } from './models/FiatTransfer';
 export type { FiatTransferDestination } from './models/FiatTransferDestination';
 export type { FiatWithdrawal } from './models/FiatWithdrawal';
 export type { FiatWithdrawalRequest } from './models/FiatWithdrawalRequest';
+export type { FireblocksAssetIdPathParam } from './models/FireblocksAssetIdPathParam';
 export { GeneralError } from './models/GeneralError';
 export type { Iban } from './models/Iban';
 export type { IbanAddress } from './models/IbanAddress';
@@ -102,6 +122,15 @@ export type { QuoteCapability } from './models/QuoteCapability';
 export type { QuoteRequest } from './models/QuoteRequest';
 export { QuoteStatus } from './models/QuoteStatus';
 export { RequestPart } from './models/RequestPart';
+export type { SettlementDepositInstruction } from './models/SettlementDepositInstruction';
+export type { SettlementDepositTransaction } from './models/SettlementDepositTransaction';
+export type { SettlementInstructions } from './models/SettlementInstructions';
+export type { SettlementRequest } from './models/SettlementRequest';
+export { SettlementState } from './models/SettlementState';
+export { SettlementTransactionStatus } from './models/SettlementTransactionStatus';
+export type { SettlementVersionPathParam } from './models/SettlementVersionPathParam';
+export type { SettlementWithdrawInstruction } from './models/SettlementWithdrawInstruction';
+export type { SettlementWithdrawTransaction } from './models/SettlementWithdrawTransaction';
 export { StellarToken } from './models/StellarToken';
 export type { SubAccountIdPathParam } from './models/SubAccountIdPathParam';
 export type { SwiftAddress } from './models/SwiftAddress';
@@ -118,6 +147,7 @@ export type { WithdrawalCommonProperties } from './models/WithdrawalCommonProper
 export type { WithdrawalEvent } from './models/WithdrawalEvent';
 export type { WithdrawalRequestCommonProperties } from './models/WithdrawalRequestCommonProperties';
 export { WithdrawalStatus } from './models/WithdrawalStatus';
+export type { X_FB_PLATFORM_SIGNATURE } from './models/X_FB_PLATFORM_SIGNATURE';
 export type { X_FBAPI_KEY } from './models/X_FBAPI_KEY';
 export type { X_FBAPI_NONCE } from './models/X_FBAPI_NONCE';
 export type { X_FBAPI_SIGNATURE } from './models/X_FBAPI_SIGNATURE';
@@ -126,6 +156,7 @@ export type { X_FBAPI_TIMESTAMP } from './models/X_FBAPI_TIMESTAMP';
 export { AccountsService } from './services/AccountsService';
 export { BalancesService } from './services/BalancesService';
 export { CapabilitiesService } from './services/CapabilitiesService';
+export { CollateralService } from './services/CollateralService';
 export { HistoricBalancesService } from './services/HistoricBalancesService';
 export { LiquidityService } from './services/LiquidityService';
 export { TradingService } from './services/TradingService';

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

@@ -19,5 +19,6 @@ export type ApiComponents = {
     transfersInternal?: AccountsSet;
     trading?: AccountsSet;
     liquidity?: AccountsSet;
+    collateral?: AccountsSet;
 };
 

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

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { AssetBalance } from './AssetBalance';
+import type { PositiveAmount } from './PositiveAmount';
+
+export type AssetCreditBalance = (AssetBalance & {
+    creditAmount: PositiveAmount;
+});
+

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

@@ -4,8 +4,9 @@
 /* eslint-disable */
 
 import type { AssetBalance } from './AssetBalance';
+import type { AssetCreditBalance } from './AssetCreditBalance';
 
 /**
  * Maps balance assets to their balances.
  */
-export type Balances = Array<AssetBalance>;
+export type Balances = Array<(AssetBalance | AssetCreditBalance)>;

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

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralId } from './CollateralId';
+import type { CollateralSignerId } from './CollateralSignerId';
+import type { Environment } from './Environment';
+
+export type CollateralAccount = {
+    collateralId: CollateralId;
+    collateralSigners: Array<CollateralSignerId>;
+    env: Environment;
+};
+

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

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralAccount } from './CollateralAccount';
+import type { CollateralAsset } from './CollateralAsset';
+import type { CollateralLinkStatus } from './CollateralLinkStatus';
+
+export type CollateralAccountLink = (CollateralAccount & {
+    status: CollateralLinkStatus;
+    eligibleCollateralAssets: Array<CollateralAsset>;
+    rejectionReason?: string;
+});
+

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

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PublicBlockchainAddress } from './PublicBlockchainAddress';
+
+export type CollateralAddress = {
+    address: PublicBlockchainAddress;
+    /**
+     * An account ID used when recovering the assets of an off-exchange client
+     */
+    recoveryAccountId: string;
+};
+

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

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { NativeCryptocurrency } from './NativeCryptocurrency';
+import type { OtherAssetReference } from './OtherAssetReference';
+
+export type CollateralAsset = (NativeCryptocurrency | OtherAssetReference);
+

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

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralAddress } from './CollateralAddress';
+import type { CollateralAssetMapping } from './CollateralAssetMapping';
+
+export type CollateralAssetAddress = (CollateralAddress & CollateralAssetMapping);
+

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

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralAsset } from './CollateralAsset';
+
+export type CollateralAssetMapping = {
+    asset: CollateralAsset;
+    fireblocksAssetId: string;
+};
+

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

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralAssetAddress } from './CollateralAssetAddress';
+
+export type CollateralDepositAddresses = {
+    addresses: Array<CollateralAssetAddress>;
+};
+

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

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralDepositTransactionStatus } from './CollateralDepositTransactionStatus';
+import type { PositiveAmount } from './PositiveAmount';
+
+export type CollateralDepositTransaction = {
+    /**
+     * A unique identifier of the transaction to track. This field will contain information to help the provider poll the status of the transaction from Fireblocks.
+     *
+     */
+    collateralTxId: string;
+    /**
+     * ID of the Fireblocks asset
+     */
+    fireblocksAssetId: string;
+    amount?: PositiveAmount;
+    status?: CollateralDepositTransactionStatus;
+};
+

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

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * - **Pending** - The transaction is pending and has not been credited to the provider's account yet
+ * - **Credited** - The transaction has been completed successfully and the account has been credited
+ * - **Rejected** - The transaction has been rejected and the account has not been credited
+ *
+ */
+export enum CollateralDepositTransactionStatus {
+    PENDING = 'Pending',
+    CREDITED = 'Credited',
+    REJECTED = 'Rejected',
+}

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

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Unique string representing the collateral account Id (<cvaTenantId>.<accountId>.<tenantId>)
+ */
+export type CollateralId = string;

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

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * ID of a collateral account
+ */
+export type CollateralIdPathParam = string;

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

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * - **Eligible** - The provider account is eligible for linking to a collateral account
+ * - **Linked** - The provider account is linked to a collateral account
+ * - **Disabled** - The link is disabled at the moment, but can be re-enabled
+ * - **Failed** - The link creation failed
+ *
+ */
+export enum CollateralLinkStatus {
+    ELIGIBLE = 'Eligible',
+    LINKED = 'Linked',
+    DISABLED = 'Disabled',
+    FAILED = 'Failed',
+}

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

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Unique Id of the collateral signer
+ */
+export type CollateralSignerId = string;

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

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A Fireblocks' ID of a collateral transaction
+ */
+export type CollateralTxIdPathParam = string;

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

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CollateralWithdrawalTransactionStatus } from './CollateralWithdrawalTransactionStatus';
+
+export type CollateralWithdrawalTransaction = {
+    /**
+     * A unique identifier of the transaction to track. This field will contain information to help Fireblocks poll the status of the transaction from the provider.
+     *
+     */
+    collateralTxId: string;
+    status: CollateralWithdrawalTransactionStatus;
+    withdrawalTxBlockchainId?: string;
+    rejectionReason?: string | null;
+};
+

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

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PositiveAmount } from './PositiveAmount';
+import type { PublicBlockchainAddress } from './PublicBlockchainAddress';
+
+export type CollateralWithdrawalTransactionRequest = {
+    /**
+     * ID of the Fireblocks asset
+     */
+    fireblocksAssetId: string;
+    amount: PositiveAmount;
+    destinationAddress: PublicBlockchainAddress;
+};
+

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

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * - **Pending** - The withdrawal transaction is pending the provider's approval
+ * - **Approved** - The withdrawal transaction has been approved and it is in progress
+ * - **Rejected** - The withdrawal transaction has been rejected
+ *
+ */
+export enum CollateralWithdrawalTransactionStatus {
+    PENDING = 'Pending',
+    APPROVED = 'Approved',
+    REJECTED = 'Rejected',
+}