@fuul/sdk 7.31.0 → 7.32.0
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.
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
import { CurrentTier } from '../../types/api';
|
|
1
2
|
import { UserIdentifierType } from '../../types/user';
|
|
2
3
|
export type AffiliateStatus = 'Active' | 'Paused' | 'Flagged' | 'Terminated';
|
|
3
|
-
export type AffiliateRegion = 'All' | 'CN' | 'JP' | 'KR' | 'SEA' | 'EN' | 'LATAM' | 'Other';
|
|
4
|
+
export type AffiliateRegion = 'All' | 'CN' | 'JP' | 'KR' | 'SEA' | 'IND' | 'EN' | 'LATAM' | 'CIS' | 'GE' | 'SP' | 'SA' | 'EU' | 'Other';
|
|
5
|
+
export type AffiliatePortalTierView = CurrentTier;
|
|
4
6
|
export interface GetAffiliateStatsParams {
|
|
5
7
|
user_identifier: string;
|
|
6
8
|
/** @deprecated Not supported by the server. Will be removed in the next major version. */
|
|
@@ -20,14 +22,36 @@ export interface AffiliateEarning {
|
|
|
20
22
|
export interface GetAffiliateStatsResponse {
|
|
21
23
|
user_identifier: string;
|
|
22
24
|
user_identifier_type: UserIdentifierType;
|
|
25
|
+
/**
|
|
26
|
+
* Movement-based commission totals per currency, across ALL referrer levels combined.
|
|
27
|
+
* Native token units (already divided by decimals). Includes POINT rewards.
|
|
28
|
+
*/
|
|
23
29
|
total_earnings: AffiliateEarning[];
|
|
30
|
+
/** USD volume attributed to this affiliate as the direct (L1) referrer. */
|
|
24
31
|
referred_volume: number;
|
|
25
32
|
r2_volume: number;
|
|
26
33
|
r3_volume: number;
|
|
34
|
+
r4_volume: number;
|
|
35
|
+
/** Sum of r2_volume + r3_volume + r4_volume. */
|
|
27
36
|
multilevel_volume: number;
|
|
37
|
+
/** referred_volume + multilevel_volume. */
|
|
28
38
|
total_volume: number;
|
|
29
39
|
end_user_volume: number;
|
|
40
|
+
/** USD attributed revenue for L1 direct referrals. */
|
|
30
41
|
referred_revenue: number;
|
|
42
|
+
r2_revenue: number;
|
|
43
|
+
r3_revenue: number;
|
|
44
|
+
r4_revenue: number;
|
|
45
|
+
/** Count of L1 attribution events for this affiliate, scoped to the same date range as volumes. */
|
|
46
|
+
referred_attributions: number;
|
|
47
|
+
/** Confirmed payout commissions in USD for L1 (direct) referrals. Excludes POINT-denomination payouts. */
|
|
48
|
+
r1_earnings: number;
|
|
49
|
+
/** Confirmed payout commissions in USD for L2 referrals. Excludes POINT-denomination payouts. */
|
|
50
|
+
r2_earnings: number;
|
|
51
|
+
/** Confirmed payout commissions in USD for L3 referrals. Excludes POINT-denomination payouts. */
|
|
52
|
+
r3_earnings: number;
|
|
53
|
+
/** Confirmed payout commissions in USD for L4 referrals. Excludes POINT-denomination payouts. */
|
|
54
|
+
r4_earnings: number;
|
|
31
55
|
/** Analytics-based referred-user count (existing semantics). Same value as `active_referrers`. */
|
|
32
56
|
referred_users: number;
|
|
33
57
|
/** Same as `referred_users` (analytics pipeline). */
|
|
@@ -39,6 +63,10 @@ export interface GetAffiliateStatsResponse {
|
|
|
39
63
|
status: AffiliateStatus;
|
|
40
64
|
region: AffiliateRegion | null;
|
|
41
65
|
referral_codes: string[];
|
|
66
|
+
/** Tier after audience/default rules; no tier-protection overlay. */
|
|
67
|
+
effective_tier: AffiliatePortalTierView | null;
|
|
68
|
+
/** Tier shown to the affiliate; includes tier-protection overlay when active. */
|
|
69
|
+
current_tier: AffiliatePortalTierView | null;
|
|
42
70
|
}
|
|
43
71
|
export interface GetNewTradersParams {
|
|
44
72
|
user_identifier: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/affiliate-portal/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAAC;AAE7E,MAAM,MAAM,eAAe,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/affiliate-portal/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAAC;AAE7E,MAAM,MAAM,eAAe,GACvB,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,OAAO,GACP,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,CAAC;AAEZ,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC;AAElD,MAAM,WAAW,uBAAuB;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,0FAA0F;IAC1F,oBAAoB,CAAC,EAAE,kBAAkB,CAAC;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mGAAmG;IACnG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;IACzC;;;OAGG;IACH,cAAc,EAAE,gBAAgB,EAAE,CAAC;IACnC,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,sDAAsD;IACtD,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,mGAAmG;IACnG,qBAAqB,EAAE,MAAM,CAAC;IAC9B,0GAA0G;IAC1G,WAAW,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;IACpB,kGAAkG;IAClG,cAAc,EAAE,MAAM,CAAC;IACvB,qDAAqD;IACrD,gBAAgB,EAAE,MAAM,CAAC;IACzB,8HAA8H;IAC9H,eAAe,EAAE,MAAM,CAAC;IACxB,4HAA4H;IAC5H,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,eAAe,CAAC;IACxB,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,qEAAqE;IACrE,cAAc,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAC/C,iFAAiF;IACjF,YAAY,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACtC;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAErD,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEtE,MAAM,WAAW,gCAAgC;IAC/C,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,gBAAgB,EAAE,CAAC;CACpC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { default as Fuul } from './core';
|
|
2
|
-
export type { AffiliateEarning, AffiliateRegion, AffiliateStatus, DateRangePreset, GetAffiliateStatsBreakdownParams, GetAffiliateStatsBreakdownResponse, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetAffiliateTotalStatsParams, GetAffiliateTotalStatsResponse, GetNewTradersParams, GetReferralTreeParams, GroupByPeriod, NewTraderResponse, ReferralTreeNodeResponse, StatsBreakdownResult, } from './affiliate-portal/types';
|
|
2
|
+
export type { AffiliateEarning, AffiliatePortalTierView, AffiliateRegion, AffiliateStatus, DateRangePreset, GetAffiliateStatsBreakdownParams, GetAffiliateStatsBreakdownResponse, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetAffiliateTotalStatsParams, GetAffiliateTotalStatsResponse, GetNewTradersParams, GetReferralTreeParams, GroupByPeriod, NewTraderResponse, ReferralTreeNodeResponse, StatsBreakdownResult, } from './affiliate-portal/types';
|
|
3
3
|
export * from './affiliates/errors';
|
|
4
4
|
export type { ClaimCheckItem, ClaimCheckReason, ClaimCheckTotalItem, ClaimResponse, CloseClaimChecksParams, CloseClaimChecksResponse, GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimChecksParams, GetClaimChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse, } from './claim-checks/types';
|
|
5
5
|
export { ClaimCheckStatus } from './claim-checks/types';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,eAAe,EACf,gCAAgC,EAChC,kCAAkC,EAClC,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,0BAA0B,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EACV,SAAS,EACT,sBAAsB,EACtB,UAAU,EACV,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEnF,OAAO,EAAE,IAAI,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,YAAY,EACV,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,eAAe,EACf,gCAAgC,EAChC,kCAAkC,EAClC,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,0BAA0B,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EACV,SAAS,EACT,sBAAsB,EACtB,UAAU,EACV,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEnF,OAAO,EAAE,IAAI,EAAE,CAAC"}
|