squarefi-bff-api-module 1.18.2 → 1.18.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.18.4] - 2025-05-23
9
+
10
+ ### Changed
11
+
12
+ - Streamlined KYC rail types by replacing interfaces with schema-based types for improved consistency and maintainability
13
+
14
+ ## [1.18.3] - 2025-05-22
15
+
16
+ ### Added
17
+
18
+ - Added new fields for KYC and integration vendor IDs in API types
19
+
8
20
  ## [1.18.1] - 2025-05-20
9
21
 
10
22
  ### Fixed
@@ -1293,12 +1293,21 @@ export interface components {
1293
1293
  total: number;
1294
1294
  data: components["schemas"]["ChainDto"][];
1295
1295
  };
1296
+ KycRailTermsAndConditionsEntity: {
1297
+ id: string;
1298
+ description: string | null;
1299
+ kyc_rail_id: string;
1300
+ link: string;
1301
+ title: string;
1302
+ };
1296
1303
  KycRailEntity: {
1297
1304
  id: string;
1298
1305
  code: string | null;
1299
1306
  name: string;
1300
1307
  /** @enum {string|null} */
1301
1308
  type: "individual" | "business" | null;
1309
+ /** @description Current terms and conditions data */
1310
+ terms_and_conditions?: components["schemas"]["KycRailTermsAndConditionsEntity"][];
1302
1311
  };
1303
1312
  IssuingProgramDto: {
1304
1313
  id: string;
@@ -1829,17 +1838,25 @@ export interface components {
1829
1838
  type: string;
1830
1839
  url: string;
1831
1840
  };
1841
+ WalletKycRailTermsAndConditionsDto: {
1842
+ description: string | null;
1843
+ link: string;
1844
+ title: string;
1845
+ };
1832
1846
  WalletKycRailDto: {
1833
1847
  message: string | null;
1834
1848
  /** @enum {string} */
1835
1849
  readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
1836
1850
  extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
1851
+ /** @description Accepted terms and conditions data */
1852
+ terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];
1837
1853
  };
1838
1854
  WalletKycRailTypeDto: {
1839
1855
  id: string;
1840
1856
  code: string | null;
1841
1857
  name: string;
1842
1858
  wallet_rail: components["schemas"]["WalletKycRailDto"] | null;
1859
+ terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];
1843
1860
  };
1844
1861
  GetWalletKycRailsResponseDto: {
1845
1862
  /** @example 20 */
@@ -112,8 +112,9 @@ export declare namespace API {
112
112
  card_limit: number;
113
113
  realtime_auth: boolean;
114
114
  tokenizable: boolean;
115
+ kyc_rails_id: string;
116
+ integration_vendor_id: string;
115
117
  vendor_id: string;
116
- purposes: string[] | null;
117
118
  type: CardType | string;
118
119
  order_types: IssuingProgramOrderType[];
119
120
  sub_account_type: SubAccountType | string;
@@ -900,42 +901,25 @@ export declare namespace API {
900
901
  }
901
902
  }
902
903
  namespace Rails {
903
- type RailStatus = 'APPROVED' | 'DECLINED' | 'PENDING' | 'HOLD' | 'DOUBLE' | 'SOFT_REJECT' | 'REJECT' | 'UNVERIFIED';
904
- interface WalletRail {
905
- id: string;
906
- status: API.KYC.Rails.RailStatus;
907
- }
904
+ type RailStatus = components['schemas']['WalletKycRailDto']['status'];
905
+ type WalletRail = components['schemas']['WalletKycRailDto'];
908
906
  namespace RailInfo {
909
- interface RailInfo {
910
- id: string;
911
- code: string;
912
- name: string;
913
- wallet_rail: WalletRail;
914
- }
907
+ type RailInfo = components['schemas']['WalletKycRailTypeDto'];
915
908
  namespace SingleRail {
916
- interface Request {
917
- wallet_id: string;
918
- rail_id: string;
919
- }
909
+ type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
920
910
  type Response = RailInfo;
921
911
  }
922
912
  namespace List {
923
- interface Request {
913
+ type Request = {
924
914
  wallet_id: string;
925
- }
926
- type Response = {
927
- total: number;
928
- data: RailInfo[];
929
915
  };
916
+ type Response = components['schemas']['GetWalletKycRailsResponseDto'];
930
917
  }
931
918
  }
932
919
  namespace Submit {
933
920
  namespace Single {
934
- interface Request {
935
- wallet_id: string;
936
- rail_id: string;
937
- }
938
- type Response = API.KYC.Rails.RailInfo.RailInfo;
921
+ type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
922
+ type Response = components['schemas']['WalletKycRailTypeDto'];
939
923
  }
940
924
  }
941
925
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.18.2",
3
+ "version": "1.18.4",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -1294,12 +1294,21 @@ export interface components {
1294
1294
  total: number;
1295
1295
  data: components["schemas"]["ChainDto"][];
1296
1296
  };
1297
+ KycRailTermsAndConditionsEntity: {
1298
+ id: string;
1299
+ description: string | null;
1300
+ kyc_rail_id: string;
1301
+ link: string;
1302
+ title: string;
1303
+ };
1297
1304
  KycRailEntity: {
1298
1305
  id: string;
1299
1306
  code: string | null;
1300
1307
  name: string;
1301
1308
  /** @enum {string|null} */
1302
1309
  type: "individual" | "business" | null;
1310
+ /** @description Current terms and conditions data */
1311
+ terms_and_conditions?: components["schemas"]["KycRailTermsAndConditionsEntity"][];
1303
1312
  };
1304
1313
  IssuingProgramDto: {
1305
1314
  id: string;
@@ -1830,17 +1839,25 @@ export interface components {
1830
1839
  type: string;
1831
1840
  url: string;
1832
1841
  };
1842
+ WalletKycRailTermsAndConditionsDto: {
1843
+ description: string | null;
1844
+ link: string;
1845
+ title: string;
1846
+ };
1833
1847
  WalletKycRailDto: {
1834
1848
  message: string | null;
1835
1849
  /** @enum {string} */
1836
1850
  readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
1837
1851
  extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
1852
+ /** @description Accepted terms and conditions data */
1853
+ terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];
1838
1854
  };
1839
1855
  WalletKycRailTypeDto: {
1840
1856
  id: string;
1841
1857
  code: string | null;
1842
1858
  name: string;
1843
1859
  wallet_rail: components["schemas"]["WalletKycRailDto"] | null;
1860
+ terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];
1844
1861
  };
1845
1862
  GetWalletKycRailsResponseDto: {
1846
1863
  /** @example 20 */
@@ -141,8 +141,9 @@ export namespace API {
141
141
  card_limit: number;
142
142
  realtime_auth: boolean;
143
143
  tokenizable: boolean;
144
+ kyc_rails_id: string;
145
+ integration_vendor_id: string;
144
146
  vendor_id: string;
145
- purposes: string[] | null;
146
147
  type: CardType | string; // MOCK
147
148
  order_types: IssuingProgramOrderType[];
148
149
  sub_account_type: SubAccountType | string;
@@ -1074,55 +1075,30 @@ export namespace API {
1074
1075
  }
1075
1076
 
1076
1077
  export namespace Rails {
1077
- export type RailStatus =
1078
- | 'APPROVED'
1079
- | 'DECLINED'
1080
- | 'PENDING'
1081
- | 'HOLD'
1082
- | 'DOUBLE'
1083
- | 'SOFT_REJECT'
1084
- | 'REJECT'
1085
- | 'UNVERIFIED';
1086
-
1087
- export interface WalletRail {
1088
- id: string;
1089
- status: API.KYC.Rails.RailStatus;
1090
- }
1078
+ export type RailStatus = components['schemas']['WalletKycRailDto']['status'];
1079
+
1080
+ export type WalletRail = components['schemas']['WalletKycRailDto'];
1091
1081
 
1092
1082
  export namespace RailInfo {
1093
- export interface RailInfo {
1094
- id: string;
1095
- code: string;
1096
- name: string;
1097
- wallet_rail: WalletRail;
1098
- }
1083
+ export type RailInfo = components['schemas']['WalletKycRailTypeDto'];
1099
1084
 
1100
1085
  export namespace SingleRail {
1101
- export interface Request {
1102
- wallet_id: string;
1103
- rail_id: string;
1104
- }
1086
+ export type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
1105
1087
  export type Response = RailInfo;
1106
1088
  }
1107
1089
 
1108
1090
  export namespace List {
1109
- export interface Request {
1091
+ export type Request = {
1110
1092
  wallet_id: string;
1111
- }
1112
- export type Response = {
1113
- total: number;
1114
- data: RailInfo[];
1115
1093
  };
1094
+ export type Response = components['schemas']['GetWalletKycRailsResponseDto'];
1116
1095
  }
1117
1096
  }
1118
1097
 
1119
1098
  export namespace Submit {
1120
1099
  export namespace Single {
1121
- export interface Request {
1122
- wallet_id: string;
1123
- rail_id: string;
1124
- }
1125
- export type Response = API.KYC.Rails.RailInfo.RailInfo;
1100
+ export type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
1101
+ export type Response = components['schemas']['WalletKycRailTypeDto'];
1126
1102
  }
1127
1103
  }
1128
1104
  }