squarefi-bff-api-module 1.33.1 → 1.34.0

package/dist/api/bank-data.d.ts

@@ -1,4 +1 @@
-import { API } from './types/types';
-export declare const bankData: {
-    getBankDataByAccountNumber: (params: API.BankData.GetBankDataByAccountNumber.Request) => Promise<API.BankData.GetBankDataByAccountNumber.Response>;
-};
+export declare const bankData: {};

package/dist/api/bank-data.js

@@ -1,6 +1,8 @@
-import { apiClientV2 } from '../utils/apiClientFactory';
 export const bankData = {
-    getBankDataByAccountNumber: (params) => apiClientV2.getRequest(`/bank-data`, {
-        params,
-    }),
+// getBankDataByAccountNumber: ( // TBD on backend
+//   params: API.BankData.GetBankDataByAccountNumber.Request,
+// ): Promise<API.BankData.GetBankDataByAccountNumber.Response> =>
+//   apiClientV2.getRequest<API.BankData.GetBankDataByAccountNumber.Response>(`/bank-data`, {
+//     params,
+//   }),
 };

package/dist/api/index.d.ts

@@ -9,6 +9,7 @@ import { kyc } from './kyc';
 import { list } from './list';
 import { orders } from './orders';
 import { persona } from './persona';
+import { referrals } from './referrals';
 import { storage } from './storage';
 import { tenants } from './tenants';
 import { totp } from './totp';
@@ -27,6 +28,7 @@ type Api = {
     list: typeof list;
     orders: typeof orders;
     persona: typeof persona;
+    referrals: typeof referrals;
     storage: typeof storage;
     tenants: typeof tenants;
     totp: typeof totp;

package/dist/api/index.js

@@ -9,6 +9,7 @@ import { kyc } from './kyc';
 import { list } from './list';
 import { orders } from './orders';
 import { persona } from './persona';
+import { referrals } from './referrals';
 import { storage } from './storage';
 import { tenants } from './tenants';
 import { totp } from './totp';
@@ -27,6 +28,7 @@ export const squarefi_bff_api_client = {
     list,
     orders,
     persona,
+    referrals,
     storage,
     tenants,
     totp,

package/dist/api/referrals.d.ts

@@ -0,0 +1,14 @@
+import { API } from './types/types';
+export declare const referrals: {
+    levels: {
+        getAll: () => Promise<API.Referrals.Levels.Response>;
+    };
+    income: {
+        progress: {
+            get: () => Promise<API.Referrals.Income.Progress.Response>;
+        };
+        summary: {
+            get: () => Promise<API.Referrals.Income.Summary.Response>;
+        };
+    };
+};

package/dist/api/referrals.js

@@ -0,0 +1,14 @@
+import { apiClientV2 } from '../utils/apiClientFactory';
+export const referrals = {
+    levels: {
+        getAll: () => apiClientV2.getRequest('/referrals/levels'),
+    },
+    income: {
+        progress: {
+            get: () => apiClientV2.getRequest('/referrals/income/progress'),
+        },
+        summary: {
+            get: () => apiClientV2.getRequest('/referrals/income/summary'),
+        },
+    },
+};

package/dist/api/types/autogen/apiV2.types.d.ts

@@ -397,6 +397,57 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/referrals/levels": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get referral levels */
+        get: operations["ReferralsController_getLevels"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/referrals/income/progress": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get referral progress for current user main wallet */
+        get: operations["ReferralsController_getProgress"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/referrals/income/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get referral income summary for current user main wallet */
+        get: operations["ReferralsController_getSummary"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/wallets": {
         parameters: {
             query?: never;
@@ -1222,23 +1273,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/bank-data": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Returns bank data by code */
-        get: operations["BankDataController_getBankDataByCode"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -1431,6 +1465,51 @@ export interface components {
         StorageUploadFileResponseDto: {
             fullPath: string;
         };
+        ReferralLevelRewardDto: {
+            /**
+             * @example cashback_percent
+             * @enum {string}
+             */
+            type: "cashback_percent" | "free_card";
+            /**
+             * @description Percent for cashback or quantity for free card.
+             * @example 3
+             */
+            value: number;
+        };
+        ReferralLevelDto: {
+            /** @example 0 */
+            from: number;
+            /** @example 100 */
+            to?: Record<string, never> | null;
+            /** @example Level 1 */
+            title: string;
+            /** @example Starter range */
+            description?: Record<string, never> | null;
+            reward: components["schemas"]["ReferralLevelRewardDto"];
+        };
+        ReferralLevelsResponseDto: {
+            levels: components["schemas"]["ReferralLevelDto"][];
+        };
+        ReferralProgressResponseDto: {
+            currentLevel: components["schemas"]["ReferralLevelDto"];
+            /**
+             * @description Amount missing to complete the current level.
+             * @example 25
+             */
+            missingAmount: number;
+            /**
+             * @description Completed percent of the current level.
+             * @example 75
+             */
+            completedPercent: number;
+        };
+        ReferralIncomeSumResponseDto: {
+            /** @example 1250.5 */
+            total_amount: number;
+            /** @example 1250.5 */
+            incoming_amount: number;
+        };
         PaginationResponseDto: {
             /** @example 20 */
             total: number;
@@ -1546,7 +1625,7 @@ export interface components {
             method: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat" | null;
             meta: components["schemas"]["TransactionMetaEntity"] | null;
             /** @enum {string|null} */
-            record_type: "CARD_PROVIDER_DEPOSIT" | "CARD_PROVIDER_REFUND" | "DEPOSIT_CRYPTO_EXTERNAL" | "DEPOSIT_CRYPTO_INTERNAL" | "EXCHANGE_CRYPTO_INTERNAL" | "EXT_EXCHANGE" | "FEE" | "NETWORK_FEE" | "REFUND" | "WITHDRAWAL_CRYPTO_EXTERNAL" | "WITHDRAWAL_CRYPTO_INTERNAL" | "WHOLESALE_CARD_DEPOSIT" | null;
+            record_type: "WITHDRAWAL" | "DEPOSIT" | "REFERRAL_INCOME" | null;
             currency: components["schemas"]["CryptoCurrencyDto"] | components["schemas"]["FiatCurrencyDto"];
         };
         TransactionsFilter: {
@@ -1556,7 +1635,7 @@ export interface components {
             /** @enum {string|null} */
             method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat" | null;
             /** @enum {string|null} */
-            record_type?: "CARD_PROVIDER_DEPOSIT" | "CARD_PROVIDER_REFUND" | "DEPOSIT_CRYPTO_EXTERNAL" | "DEPOSIT_CRYPTO_INTERNAL" | "EXCHANGE_CRYPTO_INTERNAL" | "EXT_EXCHANGE" | "FEE" | "NETWORK_FEE" | "REFUND" | "WITHDRAWAL_CRYPTO_EXTERNAL" | "WITHDRAWAL_CRYPTO_INTERNAL" | "WHOLESALE_CARD_DEPOSIT" | null;
+            record_type?: "WITHDRAWAL" | "DEPOSIT" | "REFERRAL_INCOME" | null;
             "currency.uuid"?: string;
             "meta.billing_amount_currency"?: string;
             "meta.transaction_amount_currency"?: string;
@@ -2536,21 +2615,6 @@ export interface components {
             wallet_id: string;
         };
         QStashWebhookDto: Record<string, never>;
-        BankDataAddressDto: {
-            city?: string | null;
-            country_id?: number | null;
-            postcode?: string | null;
-            street1?: string | null;
-            street2?: string | null;
-            state_id?: number | null;
-        };
-        GetBankDataByCodeResponseDto: {
-            bank_name: string;
-            address: components["schemas"]["BankDataAddressDto"];
-            routing_number?: string;
-            iban?: string;
-            swift_bic?: string;
-        };
     };
     responses: never;
     parameters: never;
@@ -3352,6 +3416,84 @@ export interface operations {
             };
         };
     };
+    ReferralsController_getLevels: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReferralLevelsResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ReferralsController_getProgress: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReferralProgressResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ReferralsController_getSummary: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReferralIncomeSumResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     WalletsController_all: {
         parameters: {
             query?: {
@@ -5236,7 +5378,7 @@ export interface operations {
             header?: never;
             path: {
                 wallet_id: string;
-                user_data_id: number;
+                user_data_id: string;
             };
             cookie?: never;
         };
@@ -5272,7 +5414,7 @@ export interface operations {
             header?: never;
             path: {
                 wallet_id: string;
-                user_data_id: number;
+                user_data_id: string;
             };
             cookie?: never;
         };
@@ -5307,7 +5449,7 @@ export interface operations {
             header?: never;
             path: {
                 wallet_id: string;
-                user_data_id: number;
+                user_data_id: string;
             };
             cookie?: never;
         };
@@ -5347,7 +5489,7 @@ export interface operations {
             header?: never;
             path: {
                 wallet_id: string;
-                user_data_id: number;
+                user_data_id: string;
             };
             cookie?: never;
         };
@@ -5383,7 +5525,7 @@ export interface operations {
             header?: never;
             path: {
                 wallet_id: string;
-                user_data_id: number;
+                user_data_id: string;
             };
             cookie?: never;
         };
@@ -5622,40 +5764,4 @@ export interface operations {
             };
         };
     };
-    BankDataController_getBankDataByCode: {
-        parameters: {
-            query: {
-                /** @description Bank code string must be a valid IBAN, RTN or SWIFT */
-                code: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["GetBankDataByCodeResponseDto"];
-                };
-            };
-            /** @description No data by code */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Unauthorized */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
 }

package/dist/api/types/types.d.ts

@@ -75,12 +75,6 @@ export declare namespace API {
             };
         }
     }
-    namespace BankData {
-        namespace GetBankDataByAccountNumber {
-            type Request = operations['BankDataController_getBankDataByCode']['parameters']['query'];
-            type Response = operations['BankDataController_getBankDataByCode']['responses']['200']['content']['application/json'];
-        }
-    }
     namespace Cards {
         namespace Config {
             type IssuingProgramOrderType = {
@@ -2271,4 +2265,17 @@ export declare namespace API {
             }
         }
     }
+    namespace Referrals {
+        namespace Levels {
+            type Response = operations['ReferralsController_getLevels']['responses']['200']['content']['application/json'];
+        }
+        namespace Income {
+            namespace Progress {
+                type Response = operations['ReferralsController_getProgress']['responses']['200']['content']['application/json'];
+            }
+            namespace Summary {
+                type Response = operations['ReferralsController_getSummary']['responses']['200']['content']['application/json'];
+            }
+        }
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.33.1",
+  "version": "1.34.0",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",