squarefi-bff-api-module 1.36.54 → 1.36.55
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/dist/api/types/autogen/apiV1External.types.d.ts +2 -0
- package/dist/api/types/autogen/apiV1Frontend.types.d.ts +30 -6
- package/dist/api/types/autogen/apiV1Legacy.types.d.ts +54 -1
- package/dist/api/types/autogen/apiV1Tenant.types.d.ts +2 -0
- package/dist/api/types/types.d.ts +36 -0
- package/package.json +1 -1
|
@@ -7379,6 +7379,8 @@ export interface components {
|
|
|
7379
7379
|
* @description Associated issuing program ID
|
|
7380
7380
|
*/
|
|
7381
7381
|
issuing_program_id?: string;
|
|
7382
|
+
/** @description Cards issued to this person (every status, canceled included), including cards on sibling per-vendor rows of the same person. Always present on list/get/PATCH; 0 when none. */
|
|
7383
|
+
cards_count?: number;
|
|
7382
7384
|
address?: components["schemas"]["CardholderAddress"];
|
|
7383
7385
|
};
|
|
7384
7386
|
/** @description An uploaded KYC file, addressable before it is attached to a cardholder */
|
|
@@ -4602,8 +4602,8 @@ export interface paths {
|
|
|
4602
4602
|
code?: string | null;
|
|
4603
4603
|
/** @description Initial topup amount */
|
|
4604
4604
|
initial_topup?: number | null;
|
|
4605
|
-
/** @description Card design
|
|
4606
|
-
card_design?:
|
|
4605
|
+
/** @description Card artwork for this program; null = use the app's built-in design */
|
|
4606
|
+
card_design?: components["schemas"]["CardDesign"] | null;
|
|
4607
4607
|
/** @description Legal consent text for card creation */
|
|
4608
4608
|
consent_text?: string | null;
|
|
4609
4609
|
/** @description One-time card issuing fee */
|
|
@@ -4702,7 +4702,8 @@ export interface paths {
|
|
|
4702
4702
|
icon?: string | null;
|
|
4703
4703
|
code?: string | null;
|
|
4704
4704
|
initial_topup?: number | null;
|
|
4705
|
-
|
|
4705
|
+
/** @description Card artwork for this program; null = use the app's built-in design */
|
|
4706
|
+
card_design?: components["schemas"]["CardDesign"] | null;
|
|
4706
4707
|
consent_text?: string | null;
|
|
4707
4708
|
card_issuing_fee?: number | null;
|
|
4708
4709
|
card_monthly_fee?: number | null;
|
|
@@ -13533,6 +13534,27 @@ export interface components {
|
|
|
13533
13534
|
/** Format: date-time */
|
|
13534
13535
|
created_at: string;
|
|
13535
13536
|
};
|
|
13537
|
+
/** @description How a card issued on this program is painted. Normalized on read, so every field here is either absent or usable — the abandoned shapes still in the column (`style.color`, `front_img`/`back_img`, a double-encoded JSON string) never reach a client. `null` means the program has no design: fall back to the app's built-in artwork. */
|
|
13538
|
+
CardDesign: {
|
|
13539
|
+
/**
|
|
13540
|
+
* @description Contract version.
|
|
13541
|
+
* @enum {integer}
|
|
13542
|
+
*/
|
|
13543
|
+
version: 1;
|
|
13544
|
+
/** @description The card face. One artwork for both themes — a card is a printed object, it does not restyle when the app does. */
|
|
13545
|
+
cover?: {
|
|
13546
|
+
/**
|
|
13547
|
+
* Format: uri
|
|
13548
|
+
* @description Absolute https URL of the artwork, authored at 2x of 318×200 (636×400).
|
|
13549
|
+
*/
|
|
13550
|
+
image_url?: string;
|
|
13551
|
+
};
|
|
13552
|
+
/**
|
|
13553
|
+
* @description Hex colour for every text on the card (balance, nickname, masked PAN). Set it when the artwork needs contrast the app-wide card text colour does not give.
|
|
13554
|
+
* @example #ffffff
|
|
13555
|
+
*/
|
|
13556
|
+
text_color?: string;
|
|
13557
|
+
};
|
|
13536
13558
|
/** @description Issuing program configuration (`issuing_programs` row). When joined it also carries nested `order_types`, `kyc_rails` and `integration_vendors` (hence additionalProperties). */
|
|
13537
13559
|
IssuingProgram: {
|
|
13538
13560
|
/** Format: uuid */
|
|
@@ -13583,9 +13605,7 @@ export interface components {
|
|
|
13583
13605
|
initial_topup?: number | null;
|
|
13584
13606
|
/** @description Minimum top-up amount in program currency, compared against the credited amount (0 = no minimum) */
|
|
13585
13607
|
min_topup?: number;
|
|
13586
|
-
card_design?:
|
|
13587
|
-
[key: string]: unknown;
|
|
13588
|
-
} | null;
|
|
13608
|
+
card_design?: components["schemas"]["CardDesign"] | null;
|
|
13589
13609
|
/** Format: uuid */
|
|
13590
13610
|
kyc_rails_id?: string | null;
|
|
13591
13611
|
/** Format: uuid */
|
|
@@ -13692,6 +13712,8 @@ export interface components {
|
|
|
13692
13712
|
/** @description Embedded sub-account summary, or null when no sub-account is linked. Present on the normal (vendor-enriched) response; omitted only in the degraded local-only error mode. */
|
|
13693
13713
|
sub_account: components["schemas"]["IssuingCardSubAccount"] | null;
|
|
13694
13714
|
limits?: components["schemas"]["IssuingCardLimits"] | null;
|
|
13715
|
+
/** @description This card's artwork, copied from its issuing program so a client needs no second request to paint the card. `null` = the program has no design, use the app's built-in artwork. */
|
|
13716
|
+
card_design?: components["schemas"]["CardDesign"] | null;
|
|
13695
13717
|
/** Format: date-time */
|
|
13696
13718
|
created_at?: string;
|
|
13697
13719
|
/** Format: date-time */
|
|
@@ -13881,6 +13903,8 @@ export interface components {
|
|
|
13881
13903
|
* @description CORE user this cardholder is linked to (user_data provisioning mode); null for manually-created cardholders.
|
|
13882
13904
|
*/
|
|
13883
13905
|
user_data_uuid?: string | null;
|
|
13906
|
+
/** @description Cards issued to this person (every status, canceled included), including cards on sibling per-vendor rows of the same person. Always present on list/get/PATCH; 0 when none. */
|
|
13907
|
+
cards_count?: number;
|
|
13884
13908
|
vendor_id?: string | null;
|
|
13885
13909
|
vendor_name?: string | null;
|
|
13886
13910
|
vendor_type?: string | null;
|
|
@@ -7528,6 +7528,60 @@ export interface components {
|
|
|
7528
7528
|
mon_min_usd?: number;
|
|
7529
7529
|
} | null;
|
|
7530
7530
|
};
|
|
7531
|
+
AuthResponse: {
|
|
7532
|
+
/** @description JWT access token */
|
|
7533
|
+
access_token?: string;
|
|
7534
|
+
/**
|
|
7535
|
+
* @description Token type (bearer)
|
|
7536
|
+
* @enum {string}
|
|
7537
|
+
*/
|
|
7538
|
+
token_type?: "bearer";
|
|
7539
|
+
/** @description Seconds until token expiration */
|
|
7540
|
+
expires_in?: number;
|
|
7541
|
+
/** @description Token expiration timestamp */
|
|
7542
|
+
expires_at?: number;
|
|
7543
|
+
/** @description Refresh token for obtaining new access token */
|
|
7544
|
+
refresh_token?: string;
|
|
7545
|
+
user?: components["schemas"]["User"];
|
|
7546
|
+
};
|
|
7547
|
+
User: {
|
|
7548
|
+
/** @description User's unique identifier */
|
|
7549
|
+
id?: string;
|
|
7550
|
+
/** @description Audience for the token */
|
|
7551
|
+
aud?: string;
|
|
7552
|
+
/** @description User's role */
|
|
7553
|
+
role?: string;
|
|
7554
|
+
/** @description User's email address */
|
|
7555
|
+
email?: string;
|
|
7556
|
+
/**
|
|
7557
|
+
* Format: date-time
|
|
7558
|
+
* @description When email was confirmed
|
|
7559
|
+
*/
|
|
7560
|
+
email_confirmed_at?: string;
|
|
7561
|
+
/** @description User's phone number */
|
|
7562
|
+
phone?: string;
|
|
7563
|
+
/**
|
|
7564
|
+
* Format: date-time
|
|
7565
|
+
* @description When user was confirmed
|
|
7566
|
+
*/
|
|
7567
|
+
confirmed_at?: string;
|
|
7568
|
+
/**
|
|
7569
|
+
* Format: date-time
|
|
7570
|
+
* @description When recovery email was sent
|
|
7571
|
+
*/
|
|
7572
|
+
recovery_sent_at?: string;
|
|
7573
|
+
/**
|
|
7574
|
+
* Format: date-time
|
|
7575
|
+
* @description Last sign in timestamp
|
|
7576
|
+
*/
|
|
7577
|
+
last_sign_in_at?: string;
|
|
7578
|
+
identities?: Record<string, never>[];
|
|
7579
|
+
/** Format: date-time */
|
|
7580
|
+
created_at?: string;
|
|
7581
|
+
/** Format: date-time */
|
|
7582
|
+
updated_at?: string;
|
|
7583
|
+
is_anonymous?: boolean;
|
|
7584
|
+
};
|
|
7531
7585
|
SubAccount: {
|
|
7532
7586
|
/**
|
|
7533
7587
|
* @description Unique identifier for the sub-account
|
|
@@ -8311,7 +8365,6 @@ export interface components {
|
|
|
8311
8365
|
[key: string]: unknown;
|
|
8312
8366
|
};
|
|
8313
8367
|
};
|
|
8314
|
-
User: unknown;
|
|
8315
8368
|
Wallet: unknown;
|
|
8316
8369
|
WalletDetailed: unknown;
|
|
8317
8370
|
CryptoAddress: unknown;
|
|
@@ -8043,6 +8043,8 @@ export interface components {
|
|
|
8043
8043
|
* @description Associated issuing program ID
|
|
8044
8044
|
*/
|
|
8045
8045
|
issuing_program_id?: string;
|
|
8046
|
+
/** @description Cards issued to this person (every status, canceled included), including cards on sibling per-vendor rows of the same person. Always present on list/get/PATCH; 0 when none. */
|
|
8047
|
+
cards_count?: number;
|
|
8046
8048
|
address?: components["schemas"]["CardholderAddress"];
|
|
8047
8049
|
};
|
|
8048
8050
|
/** @description An uploaded KYC file, addressable before it is attached to a cardholder */
|
|
@@ -88,6 +88,27 @@ export declare namespace API {
|
|
|
88
88
|
}
|
|
89
89
|
}
|
|
90
90
|
namespace Cards {
|
|
91
|
+
/**
|
|
92
|
+
* How a card is painted: the artwork of the issuing program it belongs to.
|
|
93
|
+
*
|
|
94
|
+
* Normalized by the BFF on every read, so each field is either absent or
|
|
95
|
+
* usable — the abandoned shapes the `card_design` column still holds
|
|
96
|
+
* (`style.color`, `front_img`/`back_img`, a double-encoded JSON string)
|
|
97
|
+
* never reach a client. `null` means the program has no design and the app
|
|
98
|
+
* paints its own built-in artwork instead.
|
|
99
|
+
*
|
|
100
|
+
* One artwork covers both themes: a card face is a printed object, not a UI
|
|
101
|
+
* surface, so it does not restyle when the app does.
|
|
102
|
+
*/
|
|
103
|
+
interface CardDesign {
|
|
104
|
+
version: 1;
|
|
105
|
+
cover?: {
|
|
106
|
+
/** Absolute https URL of the artwork, authored at 636×400 (2× the card). */
|
|
107
|
+
image_url?: string;
|
|
108
|
+
};
|
|
109
|
+
/** Hex colour for every text on the card face (balance, nickname, PAN). */
|
|
110
|
+
text_color?: string;
|
|
111
|
+
}
|
|
91
112
|
namespace Config {
|
|
92
113
|
type IssuingProgramOrderType = {
|
|
93
114
|
id: string;
|
|
@@ -127,6 +148,12 @@ export declare namespace API {
|
|
|
127
148
|
*/
|
|
128
149
|
min_topup?: number;
|
|
129
150
|
status?: IssuingProgramStatus | string;
|
|
151
|
+
/**
|
|
152
|
+
* The program's artwork. Present on DETAILED program responses only;
|
|
153
|
+
* `null` when the program has none. Cards carry their own copy
|
|
154
|
+
* (`IssuingCardListItem.card_design`) — read that when painting a card.
|
|
155
|
+
*/
|
|
156
|
+
card_design?: API.Cards.CardDesign | null;
|
|
130
157
|
}
|
|
131
158
|
}
|
|
132
159
|
interface User {
|
|
@@ -204,6 +231,13 @@ export declare namespace API {
|
|
|
204
231
|
type: CardType | string;
|
|
205
232
|
form_factor: CardFormFactor | string;
|
|
206
233
|
tokenizable: boolean;
|
|
234
|
+
/**
|
|
235
|
+
* This card's artwork, copied from its issuing program. Served WITH the
|
|
236
|
+
* card on purpose: joining against the program catalogue client-side
|
|
237
|
+
* costs a second request AND makes the card visibly swap artwork once
|
|
238
|
+
* that lands. `null` = no design, paint the app's built-in one.
|
|
239
|
+
*/
|
|
240
|
+
card_design?: API.Cards.CardDesign | null;
|
|
207
241
|
}
|
|
208
242
|
interface IssuingCardDetailItem {
|
|
209
243
|
id: string;
|
|
@@ -220,6 +254,8 @@ export declare namespace API {
|
|
|
220
254
|
tokenizable: boolean;
|
|
221
255
|
issuing_programs: API.Cards.Config.Program;
|
|
222
256
|
limits?: API.Cards.Limits.Limits;
|
|
257
|
+
/** This card's artwork; see `IssuingCardListItem.card_design`. */
|
|
258
|
+
card_design?: API.Cards.CardDesign | null;
|
|
223
259
|
}
|
|
224
260
|
interface SubAccountCardListItem {
|
|
225
261
|
type: string;
|