squarefi-bff-api-module 1.34.15 → 1.34.17

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

@@ -346,6 +346,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/referrals/code": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get referral code of the current user */
+        get: operations["ReferralsController_getCode"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/referrals/levels": {
         parameters: {
             query?: never;
@@ -566,10 +583,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /**
-         * List of currencies
-         * @deprecated
-         */
+        /** List of currencies */
         get: operations["CurrenciesController_all"];
         put?: never;
         post?: never;
@@ -579,6 +593,24 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/currencies/{currency_id}/pin": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Pin a currency */
+        post: operations["CurrenciesController_pin"];
+        /** Unpin a currency */
+        delete: operations["CurrenciesController_unpin"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exchange/rates": {
         parameters: {
             query?: never;
@@ -599,6 +631,38 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/kyc/init/{wallet_id}/{type}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["KycController_initDataCollection"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/kyc/resume/{wallet_id}/{verification_ref}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["KycController_resumeDataCollection"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/kyc/forms/{rail_id}": {
         parameters: {
             query?: never;
@@ -705,6 +769,55 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/persona/inquiries/init/{wallet_id}/{type}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["PersonaController_initInquiry"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/persona/inquiries/{wallet_id}/{inquiry_id}/resume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["PersonaController_resumeInquiry"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/kyc/integration-persona-templates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get KYC integration Persona templates */
+        get: operations["IntegrationPersonaTemplateController_findAll"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/counterparties/{wallet_id}": {
         parameters: {
             query?: never;
@@ -881,55 +994,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/persona/inquiries/init/{wallet_id}/{type}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        post: operations["PersonaController_initInquiry"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/persona/inquiries/{wallet_id}/{inquiry_id}/resume": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        post: operations["PersonaController_resumeInquiry"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/kyc/integration-persona-templates": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Get KYC integration Persona templates */
-        get: operations["IntegrationPersonaTemplateController_findAll"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/persona-admin/{wallet_id}": {
         parameters: {
             query?: never;
@@ -1265,28 +1329,35 @@ export interface components {
         StorageUploadFileResponseDto: {
             fullPath: string;
         };
-        ReferralLevelRewardDto: {
+        ReferralCodeResponseDto: {
+            /**
+             * @description Personal referral code of the current user
+             * @example gule1rn25d
+             */
+            code: string;
+        };
+        ReferralLevelRewardEntity: {
             /**
-             * @example cashback_percent
+             * @example rev_share_percent
              * @enum {string}
              */
-            type: "cashback_percent" | "free_card";
+            type: "rev_share_percent";
             /**
-             * @description Percent for cashback or quantity for free card.
-             * @example 3
+             * @description Rev share percent of platform fee that goes to the referrer.
+             * @example 15
              */
             value: number;
         };
         ReferralLevelDto: {
             /** @example 0 */
             from: number;
-            /** @example 100 */
+            /** @example 10000 */
             to?: Record<string, never> | null;
             /** @example Level 1 */
             title: string;
             /** @example Starter range */
             description?: Record<string, never> | null;
-            reward: components["schemas"]["ReferralLevelRewardDto"];
+            reward: components["schemas"]["ReferralLevelRewardEntity"];
         };
         ReferralLevelsResponseDto: {
             levels: components["schemas"]["ReferralLevelDto"][];
@@ -1356,7 +1427,7 @@ export interface components {
             status?: ("complete" | "pending" | "canceled" | "failed" | "processing" | "new")[];
         };
         ReferralProgressResponseDto: {
-            currentLevel: components["schemas"]["ReferralLevelDto"];
+            currentLevel: components["schemas"]["ReferralLevelDto"] | null;
             /**
              * @description Amount missing to complete the current level.
              * @example 25
@@ -1494,6 +1565,8 @@ export interface components {
             type: "token" | "native" | null;
             meta: components["schemas"]["CryptoCurrencyMetaDto"];
             is_enabled: boolean;
+            /** @description Present only when user is authenticated */
+            is_pinned?: boolean;
             /** @example true */
             is_crypto: Record<string, never>;
         };
@@ -1516,6 +1589,8 @@ export interface components {
             type: "token" | "native" | null;
             meta: components["schemas"]["FiatCurrencyMetaDto"];
             is_enabled: boolean;
+            /** @description Present only when user is authenticated */
+            is_pinned?: boolean;
             /** @example false */
             is_crypto: Record<string, never>;
         };
@@ -1533,6 +1608,15 @@ export interface components {
             to: string;
             to_uuid: string | null;
         };
+        InitKycDataCollectionResponseDto: {
+            providerType: string;
+            verificationId: string;
+        };
+        ResumeKycDataCollectionResponseDto: {
+            providerType: string;
+            verificationId: string;
+            verificationToken?: string;
+        };
         KycFormFieldOptionDto: {
             label: string;
             value: string;
@@ -1961,6 +2045,23 @@ export interface components {
             translations: components["schemas"]["CountryTranslations"][] | null;
             wikiDataId: string | null;
         };
+        InitInquiryResponseDto: {
+            /** @example inq_E6U4KitBucNKpfrDMb997AaTkQTt */
+            inquiryId: string;
+        };
+        ResumeInquiryResponseDto: {
+            inquiryId: string;
+            sessionId: string;
+        };
+        IntegrationPersonaTemplateEntityDto: Record<string, never>;
+        FindAllIntegrationPersonaTemplatesResponseDto: {
+            /** @example 20 */
+            total: number;
+            /** @description Data */
+            data: components["schemas"]["IntegrationPersonaTemplateEntityDto"][];
+            /** @description Has more data flag */
+            readonly has_more: boolean;
+        };
         CounterpartiesFilter: {
             email?: string;
             /** @description Phone number */
@@ -2056,6 +2157,7 @@ export interface components {
             note: string | null;
             swift_bic?: string | null;
             iban?: string | null;
+            sort_code?: string | null;
             address?: components["schemas"]["AddressEntity"];
         };
         CryptoEntity: {
@@ -2113,6 +2215,7 @@ export interface components {
             note: string | null;
             swift_bic?: string | null;
             iban?: string | null;
+            sort_code?: string | null;
             address?: components["schemas"]["CreateCounterpartyExternalBankingDataAddressDto"];
         };
         CreateCounterpartyExternalCryptoDataDto: {
@@ -2191,23 +2294,6 @@ export interface components {
             total: number;
             data: components["schemas"]["ExchangeRateDto"][];
         };
-        InitInquiryResponseDto: {
-            /** @example inq_E6U4KitBucNKpfrDMb997AaTkQTt */
-            inquiryId: string;
-        };
-        ResumeInquiryResponseDto: {
-            inquiryId: string;
-            sessionId: string;
-        };
-        IntegrationPersonaTemplateEntityDto: Record<string, never>;
-        FindAllIntegrationPersonaTemplatesResponseDto: {
-            /** @example 20 */
-            total: number;
-            /** @description Data */
-            data: components["schemas"]["IntegrationPersonaTemplateEntityDto"][];
-            /** @description Has more data flag */
-            readonly has_more: boolean;
-        };
         WalletUserInfoDto: {
             /** @deprecated */
             id: number;
@@ -3007,6 +3093,39 @@ export interface operations {
             };
         };
     };
+    ReferralsController_getCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReferralCodeResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Referral program is not available */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ReferralsController_getLevels: {
         parameters: {
             query?: never;
@@ -3031,6 +3150,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Referral program is not available */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     ReferralsController_getIncomeList: {
@@ -3067,6 +3193,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Referral program is not available */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     ReferralsController_getProgress: {
@@ -3093,6 +3226,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Referral program is not available */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     ReferralsController_getSummary: {
@@ -3119,6 +3259,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Referral program is not available */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     WalletsController_all: {
@@ -3496,12 +3643,64 @@ export interface operations {
             };
         };
     };
-    ExchangeRatesController_findAll: {
+    CurrenciesController_pin: {
         parameters: {
-            query: {
-                order_type: "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_PREPAID" | "WITHDRAWAL_CRYPTO" | "DEPOSIT_CRYPTO" | "DEPOSIT_FIAT_SEPA" | "DEPOSIT_FIAT_SWIFT" | "EXCHANGE_CRYPTO_INTERNAL" | "WITHDRAWAL_FIAT_SEPA" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_WHOLESALE" | "CARD_ISSUING_FEE";
-                from_uuid?: string;
-                to_uuid?: string;
+            query?: never;
+            header?: never;
+            path: {
+                currency_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    CurrenciesController_unpin: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                currency_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ExchangeRatesController_findAll: {
+        parameters: {
+            query: {
+                order_type: "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_PREPAID" | "WITHDRAWAL_CRYPTO" | "DEPOSIT_CRYPTO" | "DEPOSIT_FIAT_SEPA" | "DEPOSIT_FIAT_SWIFT" | "EXCHANGE_CRYPTO_INTERNAL" | "WITHDRAWAL_FIAT_SEPA" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_WHOLESALE" | "CARD_ISSUING_FEE";
+                from_uuid?: string;
+                to_uuid?: string;
             };
             header?: never;
             path?: never;
@@ -3526,6 +3725,85 @@ export interface operations {
             };
         };
     };
+    KycController_initDataCollection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                wallet_id: string;
+                type: "individual" | "business" | "universal";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InitKycDataCollectionResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description You don't have access to current wallet. Allowed roles: owner */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    KycController_resumeDataCollection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                wallet_id: string;
+                verification_ref: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ResumeKycDataCollectionResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description You don't have access to current wallet. Allowed roles: owner */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Provider verification not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     KycFormsController_getFormConfigByType: {
         parameters: {
             query?: never;
@@ -3835,6 +4113,117 @@ export interface operations {
             };
         };
     };
+    PersonaController_initInquiry: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                wallet_id: string;
+                type: "individual" | "business" | "universal";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InitInquiryResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description You don't have access to current wallet. Allowed roles: owner */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    PersonaController_resumeInquiry: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                wallet_id: string;
+                inquiry_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ResumeInquiryResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description You don't have access to current wallet. Allowed roles: owner */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Persona reference or Inquiry not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    IntegrationPersonaTemplateController_findAll: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FindAllIntegrationPersonaTemplatesResponseDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     CounterpartyAccountsController_findAll: {
         parameters: {
             query?: {
@@ -4454,117 +4843,6 @@ export interface operations {
             };
         };
     };
-    PersonaController_initInquiry: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                wallet_id: string;
-                type: "individual" | "business" | "universal";
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["InitInquiryResponseDto"];
-                };
-            };
-            /** @description Unauthorized */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description You don't have access to current wallet. Allowed roles: owner */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    PersonaController_resumeInquiry: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                wallet_id: string;
-                inquiry_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ResumeInquiryResponseDto"];
-                };
-            };
-            /** @description Unauthorized */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description You don't have access to current wallet. Allowed roles: owner */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Persona reference or Inquiry not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    IntegrationPersonaTemplateController_findAll: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["FindAllIntegrationPersonaTemplatesResponseDto"];
-                };
-            };
-            /** @description Unauthorized */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
     PersonaAdminController_syncKycEntityWithPersona: {
         parameters: {
             query?: never;

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

@@ -378,6 +378,7 @@ export declare namespace API {
                     bank_name: string;
                     note: string;
                     swift_bic?: string;
+                    sort_code?: string;
                     iban?: string;
                     address: {
                         city: string;

package/package.json

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