Merge pull request #99 from fireblocks/PIK-7082-update-collateral-ope…

…nApi-structure-v2 PIK-7082 updated deposit and settlement openApi
fireblocks · Dec 24, 2024 · f2f5ec4 · f2f5ec4
2 parents c6738c8 + d5bd499
commit f2f5ec4
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 33 deletions.
diff --git a/v2/api-validator/src/client/generated/index.ts b/v2/api-validator/src/client/generated/index.ts
@@ -37,8 +37,8 @@ export type { CollateralAccountLink } from './models/CollateralAccountLink';
 export type { CollateralAddress } from './models/CollateralAddress';
 export type { CollateralAssetAddress } from './models/CollateralAssetAddress';
 export type { CollateralDepositAddresses } from './models/CollateralDepositAddresses';
-export type { CollateralDepositTransaction } from './models/CollateralDepositTransaction';
 export type { CollateralDepositTransactionRequest } from './models/CollateralDepositTransactionRequest';
+export type { CollateralDepositTransactionResponse } from './models/CollateralDepositTransactionResponse';
 export type { CollateralDepositTransactionsResponse } from './models/CollateralDepositTransactionsResponse';
 export { CollateralDepositTransactionStatus } from './models/CollateralDepositTransactionStatus';
 export type { CollateralId } from './models/CollateralId';

diff --git a/v2/api-validator/src/client/generated/models/CollateralDepositTransactionRequest.ts b/v2/api-validator/src/client/generated/models/CollateralDepositTransactionRequest.ts
@@ -3,7 +3,6 @@
 /* tslint:disable */
 /* eslint-disable */
 
-import type { CollateralDepositTransactionStatus } from './CollateralDepositTransactionStatus';
 import type { PositiveAmount } from './PositiveAmount';
 
 export type CollateralDepositTransactionRequest = {
@@ -13,6 +12,5 @@ export type CollateralDepositTransactionRequest = {
      */
     collateralTxId: string;
     amount?: PositiveAmount;
-    status?: CollateralDepositTransactionStatus;
 };
 
diff --git a/...ed/models/CollateralDepositTransaction.ts → ...s/CollateralDepositTransactionResponse.ts b/...ed/models/CollateralDepositTransaction.ts → ...s/CollateralDepositTransactionResponse.ts
@@ -4,8 +4,10 @@
 /* eslint-disable */
 
 import type { CollateralDepositTransactionRequest } from './CollateralDepositTransactionRequest';
+import type { CollateralDepositTransactionStatus } from './CollateralDepositTransactionStatus';
 
-export type CollateralDepositTransaction = ({
+export type CollateralDepositTransactionResponse = ({
     id: string;
+    status: CollateralDepositTransactionStatus;
 } & CollateralDepositTransactionRequest);
 
diff --git a/v2/api-validator/src/client/generated/models/CollateralDepositTransactionsResponse.ts b/v2/api-validator/src/client/generated/models/CollateralDepositTransactionsResponse.ts
@@ -3,9 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 
-import type { CollateralDepositTransaction } from './CollateralDepositTransaction';
+import type { CollateralDepositTransactionResponse } from './CollateralDepositTransactionResponse';
 
 export type CollateralDepositTransactionsResponse = {
-    transactions: Array<CollateralDepositTransaction>;
+    transactions: Array<CollateralDepositTransactionResponse>;
 };
 
diff --git a/v2/api-validator/src/client/generated/models/SettlementInstructions.ts b/v2/api-validator/src/client/generated/models/SettlementInstructions.ts
@@ -7,7 +7,7 @@ import type { SettlementDepositInstruction } from './SettlementDepositInstructio
 import type { SettlementWithdrawInstruction } from './SettlementWithdrawInstruction';
 
 export type SettlementInstructions = {
-    settlementVersion?: string;
+    settlementVersion: string;
     withdrawInstructions: Array<SettlementWithdrawInstruction>;
     depositInstructions: Array<SettlementDepositInstruction>;
 };

diff --git a/v2/api-validator/src/client/generated/models/SettlementRequest.ts b/v2/api-validator/src/client/generated/models/SettlementRequest.ts
@@ -12,6 +12,6 @@ export type SettlementRequest = {
      * A unique identifier of the settlement state version. This field is optional and can be used to indicate the version of the settlement state the client is referring to.
      *
      */
-    settlementVersion?: string;
+    settlementVersion: string;
 };
 
diff --git a/v2/api-validator/src/client/generated/models/SettlementState.ts b/v2/api-validator/src/client/generated/models/SettlementState.ts
@@ -7,7 +7,7 @@ import type { SettlementDepositTransaction } from './SettlementDepositTransactio
 import type { SettlementWithdrawTransaction } from './SettlementWithdrawTransaction';
 
 export type SettlementState = {
-    settlementVersion?: string;
+    settlementVersion: string;
     withdrawTransactions?: Array<SettlementWithdrawTransaction>;
     depositTransactions?: Array<SettlementDepositTransaction>;
     /**
@@ -18,7 +18,7 @@ export type SettlementState = {
      * - **Failed** - The settlement has failed
      *
      */
-    status?: SettlementState.status;
+    status: SettlementState.status;
 };
 
 export namespace SettlementState {

diff --git a/v2/api-validator/src/client/generated/services/CollateralService.ts b/v2/api-validator/src/client/generated/services/CollateralService.ts
@@ -7,8 +7,8 @@ import type { CollateralAccountLink } from '../models/CollateralAccountLink';
 import type { CollateralAddress } from '../models/CollateralAddress';
 import type { CollateralAssetAddress } from '../models/CollateralAssetAddress';
 import type { CollateralDepositAddresses } from '../models/CollateralDepositAddresses';
-import type { CollateralDepositTransaction } from '../models/CollateralDepositTransaction';
 import type { CollateralDepositTransactionRequest } from '../models/CollateralDepositTransactionRequest';
+import type { CollateralDepositTransactionResponse } from '../models/CollateralDepositTransactionResponse';
 import type { CollateralDepositTransactionsResponse } from '../models/CollateralDepositTransactionsResponse';
 import type { CollateralWithdrawalTransaction } from '../models/CollateralWithdrawalTransaction';
 import type { CollateralWithdrawalTransactionRequest } from '../models/CollateralWithdrawalTransactionRequest';
@@ -423,7 +423,7 @@ export class CollateralService {
      * Register a collateral deposit transaction
      * Notifies the provider to have start listening to a new collateral deposit transaction. The provider is expected to listen to this address and credit the account accordingly
      *
-     * @returns CollateralDepositTransaction Successful Operation
+     * @returns CollateralDepositTransactionResponse Successful Operation
      * @throws ApiError
      */
     public registerCollateralDepositTransaction({
@@ -469,7 +469,7 @@ export class CollateralService {
          * Collateral deposit transaction details
          */
         requestBody: CollateralDepositTransactionRequest,
-    }): CancelablePromise<CollateralDepositTransaction> {
+    }): CancelablePromise<CollateralDepositTransactionResponse> {
         return this.httpRequest.request({
             method: 'POST',
             url: '/accounts/{accountId}/collateral/{collateralId}/deposits',
@@ -583,7 +583,7 @@ export class CollateralService {
 
     /**
      * Get a collateral account deposit transaction details
-     * @returns CollateralDepositTransaction A collateral deposit transaction details
+     * @returns CollateralDepositTransactionResponse A collateral deposit transaction details
      * @throws ApiError
      */
     public getCollateralDepositTransactionDetails({
@@ -629,7 +629,7 @@ export class CollateralService {
          * A Fireblocks' ID of a collateral transaction
          */
         collateralTxId: string,
-    }): CancelablePromise<CollateralDepositTransaction> {
+    }): CancelablePromise<CollateralDepositTransactionResponse> {
         return this.httpRequest.request({
             method: 'GET',
             url: '/accounts/{accountId}/collateral/{collateralId}/deposits/{collateralTxId}',

diff --git a/v2/openapi/fb-provider-collateral-api.yaml b/v2/openapi/fb-provider-collateral-api.yaml
@@ -290,7 +290,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CollateralDepositTransaction'
+                $ref: '#/components/schemas/CollateralDepositTransactionResponse'
         '400':
           description: Return Bad Request.
         '401':
@@ -357,7 +357,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CollateralDepositTransaction'
+                $ref: '#/components/schemas/CollateralDepositTransactionResponse'
         '400':
           $ref: '#/x-responses/BadRequestResponse'
         '401':
@@ -732,17 +732,15 @@ components:
           example: "0.8e4cfce8-0182-4c6d-b9dd-a291c105e1d2.0.5a814998-ec0f-4f1c-92bf-fb5f7dc09ea2"
         amount:
           $ref: '#/x-schemas/PositiveAmount'
-        status:
-          $ref: '#/components/schemas/CollateralDepositTransactionStatus'
-
-    CollateralDepositTransaction:
+    CollateralDepositTransactionResponse:
       allOf:
         - type: object
-          required:
-            - id
+          required: [id, status]
           properties:
             id:
               type: string
+            status:
+              $ref: '#/components/schemas/CollateralDepositTransactionStatus'
         - $ref: '#/components/schemas/CollateralDepositTransactionRequest'
     CollateralDepositTransactionsResponse:
       type: object
@@ -752,7 +750,7 @@ components:
         transactions:
           type: array
           items:
-            $ref: '#/components/schemas/CollateralDepositTransaction'
+            $ref: '#/components/schemas/CollateralDepositTransactionResponse'
     CollateralWithdrawalTransactionStatus:
       type: string
       enum:
@@ -872,7 +870,7 @@ components:
               nullable: true
     SettlementInstructions:
       type: object
-      required: [ withdrawInstructions, depositInstructions ]
+      required: [ settlementVersion, withdrawInstructions, depositInstructions ]
       properties:
         settlementVersion:
           type: string
@@ -886,6 +884,7 @@ components:
             $ref: '#/components/schemas/SettlementDepositInstruction'
     SettlementState:
       type: object
+      required: [ settlementVersion, status ]
       properties:
         settlementVersion:
           type: string
@@ -919,8 +918,7 @@ components:
     SettlementRequest:
       type: object
       description: Settlement to be created
-      required:
-        - settlementId
+      required: [ settlementId, settlementVersion ]
       properties:
         settlementId:
           type: string

diff --git a/v2/openapi/fb-unified-openapi.yaml b/v2/openapi/fb-unified-openapi.yaml
@@ -1934,7 +1934,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CollateralDepositTransaction'
+                $ref: '#/components/schemas/CollateralDepositTransactionResponse'
         '400':
           description: Return Bad Request.
         '401':
@@ -2003,7 +2003,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CollateralDepositTransaction'
+                $ref: '#/components/schemas/CollateralDepositTransactionResponse'
         '400':
           $ref: '#/components/responses/BadRequestResponse'
         '401':
@@ -4050,16 +4050,17 @@ components:
           example: 0.8e4cfce8-0182-4c6d-b9dd-a291c105e1d2.0.5a814998-ec0f-4f1c-92bf-fb5f7dc09ea2
         amount:
           $ref: '#/components/schemas/PositiveAmount'
-        status:
-          $ref: '#/components/schemas/CollateralDepositTransactionStatus'
-    CollateralDepositTransaction:
+    CollateralDepositTransactionResponse:
       allOf:
         - type: object
           required:
             - id
+            - status
           properties:
             id:
               type: string
+            status:
+              $ref: '#/components/schemas/CollateralDepositTransactionStatus'
         - $ref: '#/components/schemas/CollateralDepositTransactionRequest'
     CollateralDepositTransactionsResponse:
       type: object
@@ -4069,7 +4070,7 @@ components:
         transactions:
           type: array
           items:
-            $ref: '#/components/schemas/CollateralDepositTransaction'
+            $ref: '#/components/schemas/CollateralDepositTransactionResponse'
     CollateralWithdrawalTransactionStatus:
       type: string
       enum:
@@ -4189,6 +4190,7 @@ components:
     SettlementInstructions:
       type: object
       required:
+        - settlementVersion
         - withdrawInstructions
         - depositInstructions
       properties:
@@ -4204,6 +4206,9 @@ components:
             $ref: '#/components/schemas/SettlementDepositInstruction'
     SettlementState:
       type: object
+      required:
+        - settlementVersion
+        - status
       properties:
         settlementVersion:
           type: string
@@ -4234,6 +4239,7 @@ components:
       description: Settlement to be created
       required:
         - settlementId
+        - settlementVersion
       properties:
         settlementId:
           type: string