squarefi-bff-api-module 1.34.20 → 1.34.22
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/README.md +1 -2
- package/dist/api/index.d.ts +0 -2
- package/dist/api/index.js +0 -2
- package/dist/api/kyc.d.ts +4 -0
- package/dist/api/kyc.js +4 -0
- package/dist/api/types/autogen/apiV2.types.d.ts +1 -135
- package/dist/api/types/types.d.ts +20 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -210,10 +210,9 @@ const publicUrl = getPublicUrl(path);
|
|
|
210
210
|
| **developer** | Vendor & API key management |
|
|
211
211
|
| **exchange** | Exchange rates per order type / currency |
|
|
212
212
|
| **issuing** | Virtual & physical cards, limits, controls, transactions |
|
|
213
|
-
| **kyc** | Sumsub flows, rails & form submission
|
|
213
|
+
| **kyc** | Data collection init/resume, Sumsub flows, rails & form submission |
|
|
214
214
|
| **list** | Static system lists – currencies, chains, countries |
|
|
215
215
|
| **orders** | Create / calculate orders (including internal transfer) |
|
|
216
|
-
| **persona** | Persona in-app KYC inquiries |
|
|
217
216
|
| **tenants** | Tenant configuration |
|
|
218
217
|
| **totp** | TOTP generation / verification / revoke helpers |
|
|
219
218
|
| **user** | User profile, contacts, OTP verification |
|
package/dist/api/index.d.ts
CHANGED
|
@@ -8,7 +8,6 @@ import { issuing } from './issuing';
|
|
|
8
8
|
import { kyc } from './kyc';
|
|
9
9
|
import { list } from './list';
|
|
10
10
|
import { orders } from './orders';
|
|
11
|
-
import { persona } from './persona';
|
|
12
11
|
import { referrals } from './referrals';
|
|
13
12
|
import { storage } from './storage';
|
|
14
13
|
import { tenants } from './tenants';
|
|
@@ -27,7 +26,6 @@ type Api = {
|
|
|
27
26
|
kyc: typeof kyc;
|
|
28
27
|
list: typeof list;
|
|
29
28
|
orders: typeof orders;
|
|
30
|
-
persona: typeof persona;
|
|
31
29
|
referrals: typeof referrals;
|
|
32
30
|
storage: typeof storage;
|
|
33
31
|
tenants: typeof tenants;
|
package/dist/api/index.js
CHANGED
|
@@ -8,7 +8,6 @@ import { issuing } from './issuing';
|
|
|
8
8
|
import { kyc } from './kyc';
|
|
9
9
|
import { list } from './list';
|
|
10
10
|
import { orders } from './orders';
|
|
11
|
-
import { persona } from './persona';
|
|
12
11
|
import { referrals } from './referrals';
|
|
13
12
|
import { storage } from './storage';
|
|
14
13
|
import { tenants } from './tenants';
|
|
@@ -27,7 +26,6 @@ export const squarefi_bff_api_client = {
|
|
|
27
26
|
kyc,
|
|
28
27
|
list,
|
|
29
28
|
orders,
|
|
30
|
-
persona,
|
|
31
29
|
referrals,
|
|
32
30
|
storage,
|
|
33
31
|
tenants,
|
package/dist/api/kyc.d.ts
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import { API } from './types/types';
|
|
2
2
|
export declare const kyc: {
|
|
3
|
+
dataCollection: {
|
|
4
|
+
init: ({ wallet_id, type, }: API.KYC.DataCollection.Init.Request) => Promise<API.KYC.DataCollection.Init.Response>;
|
|
5
|
+
resume: ({ wallet_id, verification_ref, }: API.KYC.DataCollection.Resume.Request) => Promise<API.KYC.DataCollection.Resume.Response>;
|
|
6
|
+
};
|
|
3
7
|
sumsub: {
|
|
4
8
|
generate_token: (data: API.KYC.Sumsub.GenerateToken.Request) => Promise<API.KYC.Sumsub.GenerateToken.Response>;
|
|
5
9
|
};
|
package/dist/api/kyc.js
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import { apiClientV1, apiClientV2 } from '../utils/apiClientFactory';
|
|
2
2
|
export const kyc = {
|
|
3
|
+
dataCollection: {
|
|
4
|
+
init: ({ wallet_id, type, }) => apiClientV2.postRequest(`/kyc/init/${wallet_id}/${type}`),
|
|
5
|
+
resume: ({ wallet_id, verification_ref, }) => apiClientV2.postRequest(`/kyc/resume/${wallet_id}/${verification_ref}`),
|
|
6
|
+
},
|
|
3
7
|
sumsub: {
|
|
4
8
|
generate_token: (data) => apiClientV1.postRequest('/kyc/sumsub/generate_token', { data }),
|
|
5
9
|
},
|
|
@@ -749,22 +749,6 @@ export interface paths {
|
|
|
749
749
|
patch?: never;
|
|
750
750
|
trace?: never;
|
|
751
751
|
};
|
|
752
|
-
"/kyc/wallet-kyc-rails-workflow": {
|
|
753
|
-
parameters: {
|
|
754
|
-
query?: never;
|
|
755
|
-
header?: never;
|
|
756
|
-
path?: never;
|
|
757
|
-
cookie?: never;
|
|
758
|
-
};
|
|
759
|
-
get: operations["WalletKycRailsWorkflowController_handle_get"];
|
|
760
|
-
put: operations["WalletKycRailsWorkflowController_handle_put"];
|
|
761
|
-
post: operations["WalletKycRailsWorkflowController_handle_post"];
|
|
762
|
-
delete: operations["WalletKycRailsWorkflowController_handle_delete"];
|
|
763
|
-
options: operations["WalletKycRailsWorkflowController_handle_options"];
|
|
764
|
-
head: operations["WalletKycRailsWorkflowController_handle_head"];
|
|
765
|
-
patch: operations["WalletKycRailsWorkflowController_handle_patch"];
|
|
766
|
-
trace?: never;
|
|
767
|
-
};
|
|
768
752
|
"/countries": {
|
|
769
753
|
parameters: {
|
|
770
754
|
query?: never;
|
|
@@ -2291,6 +2275,7 @@ export interface components {
|
|
|
2291
2275
|
readonly address?: string | null;
|
|
2292
2276
|
readonly website?: string | null;
|
|
2293
2277
|
readonly support_text?: string | null;
|
|
2278
|
+
readonly support_phone?: string | null;
|
|
2294
2279
|
};
|
|
2295
2280
|
SystemConfigDto: {
|
|
2296
2281
|
/** @enum {string} */
|
|
@@ -4149,125 +4134,6 @@ export interface operations {
|
|
|
4149
4134
|
};
|
|
4150
4135
|
};
|
|
4151
4136
|
};
|
|
4152
|
-
WalletKycRailsWorkflowController_handle_get: {
|
|
4153
|
-
parameters: {
|
|
4154
|
-
query?: never;
|
|
4155
|
-
header?: never;
|
|
4156
|
-
path?: never;
|
|
4157
|
-
cookie?: never;
|
|
4158
|
-
};
|
|
4159
|
-
requestBody?: never;
|
|
4160
|
-
responses: {
|
|
4161
|
-
200: {
|
|
4162
|
-
headers: {
|
|
4163
|
-
[name: string]: unknown;
|
|
4164
|
-
};
|
|
4165
|
-
content?: never;
|
|
4166
|
-
};
|
|
4167
|
-
};
|
|
4168
|
-
};
|
|
4169
|
-
WalletKycRailsWorkflowController_handle_put: {
|
|
4170
|
-
parameters: {
|
|
4171
|
-
query?: never;
|
|
4172
|
-
header?: never;
|
|
4173
|
-
path?: never;
|
|
4174
|
-
cookie?: never;
|
|
4175
|
-
};
|
|
4176
|
-
requestBody?: never;
|
|
4177
|
-
responses: {
|
|
4178
|
-
200: {
|
|
4179
|
-
headers: {
|
|
4180
|
-
[name: string]: unknown;
|
|
4181
|
-
};
|
|
4182
|
-
content?: never;
|
|
4183
|
-
};
|
|
4184
|
-
};
|
|
4185
|
-
};
|
|
4186
|
-
WalletKycRailsWorkflowController_handle_post: {
|
|
4187
|
-
parameters: {
|
|
4188
|
-
query?: never;
|
|
4189
|
-
header?: never;
|
|
4190
|
-
path?: never;
|
|
4191
|
-
cookie?: never;
|
|
4192
|
-
};
|
|
4193
|
-
requestBody?: never;
|
|
4194
|
-
responses: {
|
|
4195
|
-
200: {
|
|
4196
|
-
headers: {
|
|
4197
|
-
[name: string]: unknown;
|
|
4198
|
-
};
|
|
4199
|
-
content?: never;
|
|
4200
|
-
};
|
|
4201
|
-
};
|
|
4202
|
-
};
|
|
4203
|
-
WalletKycRailsWorkflowController_handle_delete: {
|
|
4204
|
-
parameters: {
|
|
4205
|
-
query?: never;
|
|
4206
|
-
header?: never;
|
|
4207
|
-
path?: never;
|
|
4208
|
-
cookie?: never;
|
|
4209
|
-
};
|
|
4210
|
-
requestBody?: never;
|
|
4211
|
-
responses: {
|
|
4212
|
-
200: {
|
|
4213
|
-
headers: {
|
|
4214
|
-
[name: string]: unknown;
|
|
4215
|
-
};
|
|
4216
|
-
content?: never;
|
|
4217
|
-
};
|
|
4218
|
-
};
|
|
4219
|
-
};
|
|
4220
|
-
WalletKycRailsWorkflowController_handle_options: {
|
|
4221
|
-
parameters: {
|
|
4222
|
-
query?: never;
|
|
4223
|
-
header?: never;
|
|
4224
|
-
path?: never;
|
|
4225
|
-
cookie?: never;
|
|
4226
|
-
};
|
|
4227
|
-
requestBody?: never;
|
|
4228
|
-
responses: {
|
|
4229
|
-
200: {
|
|
4230
|
-
headers: {
|
|
4231
|
-
[name: string]: unknown;
|
|
4232
|
-
};
|
|
4233
|
-
content?: never;
|
|
4234
|
-
};
|
|
4235
|
-
};
|
|
4236
|
-
};
|
|
4237
|
-
WalletKycRailsWorkflowController_handle_head: {
|
|
4238
|
-
parameters: {
|
|
4239
|
-
query?: never;
|
|
4240
|
-
header?: never;
|
|
4241
|
-
path?: never;
|
|
4242
|
-
cookie?: never;
|
|
4243
|
-
};
|
|
4244
|
-
requestBody?: never;
|
|
4245
|
-
responses: {
|
|
4246
|
-
200: {
|
|
4247
|
-
headers: {
|
|
4248
|
-
[name: string]: unknown;
|
|
4249
|
-
};
|
|
4250
|
-
content?: never;
|
|
4251
|
-
};
|
|
4252
|
-
};
|
|
4253
|
-
};
|
|
4254
|
-
WalletKycRailsWorkflowController_handle_patch: {
|
|
4255
|
-
parameters: {
|
|
4256
|
-
query?: never;
|
|
4257
|
-
header?: never;
|
|
4258
|
-
path?: never;
|
|
4259
|
-
cookie?: never;
|
|
4260
|
-
};
|
|
4261
|
-
requestBody?: never;
|
|
4262
|
-
responses: {
|
|
4263
|
-
200: {
|
|
4264
|
-
headers: {
|
|
4265
|
-
[name: string]: unknown;
|
|
4266
|
-
};
|
|
4267
|
-
content?: never;
|
|
4268
|
-
};
|
|
4269
|
-
};
|
|
4270
|
-
};
|
|
4271
4137
|
CountriesController_findAll: {
|
|
4272
4138
|
parameters: {
|
|
4273
4139
|
query?: never;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CurrencyType, IssuingProgramStatus, OrderType, SortingDirection, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionStatus, WalletTransactionType } from '../../constants';
|
|
2
|
-
import { components, operations } from './autogen/apiV2.types';
|
|
2
|
+
import { components, operations, paths } from './autogen/apiV2.types';
|
|
3
3
|
export declare namespace API {
|
|
4
4
|
namespace Auth {
|
|
5
5
|
namespace RefreshToken {
|
|
@@ -741,8 +741,21 @@ export declare namespace API {
|
|
|
741
741
|
}
|
|
742
742
|
}
|
|
743
743
|
namespace KYC {
|
|
744
|
-
type KYCStatus = components['schemas']['KycEntityDto']['status'];
|
|
745
|
-
|
|
744
|
+
export type KYCStatus = components['schemas']['KycEntityDto']['status'];
|
|
745
|
+
type InitDataCollectionEndpoint = paths['/kyc/init/{wallet_id}/{type}']['post'];
|
|
746
|
+
type ResumeDataCollectionEndpoint = paths['/kyc/resume/{wallet_id}/{verification_ref}']['post'];
|
|
747
|
+
export namespace DataCollection {
|
|
748
|
+
type Type = InitDataCollectionEndpoint['parameters']['path']['type'];
|
|
749
|
+
namespace Init {
|
|
750
|
+
type Request = InitDataCollectionEndpoint['parameters']['path'];
|
|
751
|
+
type Response = InitDataCollectionEndpoint['responses']['200']['content']['application/json'];
|
|
752
|
+
}
|
|
753
|
+
namespace Resume {
|
|
754
|
+
type Request = ResumeDataCollectionEndpoint['parameters']['path'];
|
|
755
|
+
type Response = ResumeDataCollectionEndpoint['responses']['200']['content']['application/json'];
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
export namespace Sumsub {
|
|
746
759
|
namespace GenerateToken {
|
|
747
760
|
interface Request {
|
|
748
761
|
user_data_id: number;
|
|
@@ -752,14 +765,14 @@ export declare namespace API {
|
|
|
752
765
|
}
|
|
753
766
|
}
|
|
754
767
|
}
|
|
755
|
-
namespace Entity {
|
|
768
|
+
export namespace Entity {
|
|
756
769
|
type Entity = components['schemas']['KycEntityDto'];
|
|
757
770
|
namespace Get {
|
|
758
771
|
type Request = operations['KycEntitiesController_findOne']['parameters']['path'];
|
|
759
772
|
type Response = operations['KycEntitiesController_findOne']['responses']['200']['content']['application/json'];
|
|
760
773
|
}
|
|
761
774
|
}
|
|
762
|
-
namespace Forms {
|
|
775
|
+
export namespace Forms {
|
|
763
776
|
namespace FormField {
|
|
764
777
|
type FormFieldType = 'text' | 'email' | 'password' | 'radio' | 'select' | 'checkbox' | 'textarea' | 'number' | 'date' | 'switch' | 'file';
|
|
765
778
|
interface FormFieldValidation {
|
|
@@ -806,7 +819,7 @@ export declare namespace API {
|
|
|
806
819
|
}
|
|
807
820
|
}
|
|
808
821
|
}
|
|
809
|
-
namespace Rails {
|
|
822
|
+
export namespace Rails {
|
|
810
823
|
type RailStatus = components['schemas']['WalletKycRailDto']['status'];
|
|
811
824
|
type WalletRail = components['schemas']['WalletKycRailDto'];
|
|
812
825
|
type WalletRailExtraActions = components['schemas']['WalletKycRailExtraActionDto'];
|
|
@@ -837,6 +850,7 @@ export declare namespace API {
|
|
|
837
850
|
}
|
|
838
851
|
}
|
|
839
852
|
}
|
|
853
|
+
export {};
|
|
840
854
|
}
|
|
841
855
|
namespace Location {
|
|
842
856
|
namespace Countries {
|
|
@@ -1641,19 +1655,6 @@ export declare namespace API {
|
|
|
1641
1655
|
}
|
|
1642
1656
|
}
|
|
1643
1657
|
}
|
|
1644
|
-
namespace Persona {
|
|
1645
|
-
namespace Inquiries {
|
|
1646
|
-
type InquiryType = operations['PersonaController_initInquiry']['parameters']['path']['type'];
|
|
1647
|
-
namespace Init {
|
|
1648
|
-
type Request = operations['PersonaController_initInquiry']['parameters']['path'];
|
|
1649
|
-
type Response = operations['PersonaController_initInquiry']['responses']['200']['content']['application/json'];
|
|
1650
|
-
}
|
|
1651
|
-
namespace Resume {
|
|
1652
|
-
type Request = operations['PersonaController_resumeInquiry']['parameters']['path'];
|
|
1653
|
-
type Response = operations['PersonaController_resumeInquiry']['responses']['200']['content']['application/json'];
|
|
1654
|
-
}
|
|
1655
|
-
}
|
|
1656
|
-
}
|
|
1657
1658
|
namespace Tenant {
|
|
1658
1659
|
type Config = components['schemas']['SystemConfigDto'];
|
|
1659
1660
|
}
|