@fuul/sdk 7.19.0 → 7.21.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.
- package/dist/affiliate-portal/AffiliatePortalService.d.ts +2 -1
- package/dist/affiliate-portal/AffiliatePortalService.d.ts.map +1 -1
- package/dist/affiliate-portal/types/index.d.ts +16 -0
- package/dist/affiliate-portal/types/index.d.ts.map +1 -1
- package/dist/claim-checks/ClaimCheckService.d.ts +15 -1
- package/dist/claim-checks/ClaimCheckService.d.ts.map +1 -1
- package/dist/claim-checks/types/index.d.ts +31 -0
- package/dist/claim-checks/types/index.d.ts.map +1 -1
- package/dist/core.d.ts +49 -2
- package/dist/core.d.ts.map +1 -1
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +312 -257
- package/dist/index.umd.js +6 -6
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '../HttpClient';
|
|
2
|
-
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse } from './types';
|
|
2
|
+
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetAffiliateTotalStatsParams, GetAffiliateTotalStatsResponse, GetNewTradersParams, NewTraderResponse } from './types';
|
|
3
3
|
export type AffiliatePortalServiceSettings = {
|
|
4
4
|
httpClient: HttpClient;
|
|
5
5
|
};
|
|
@@ -7,6 +7,7 @@ export declare class AffiliatePortalService {
|
|
|
7
7
|
private readonly httpClient;
|
|
8
8
|
constructor(settings: AffiliatePortalServiceSettings);
|
|
9
9
|
getAffiliateStats(params: GetAffiliateStatsParams): Promise<GetAffiliateStatsResponse>;
|
|
10
|
+
getAffiliateTotalStats(params: GetAffiliateTotalStatsParams): Promise<GetAffiliateTotalStatsResponse>;
|
|
10
11
|
getAffiliateNewTraders(params: GetNewTradersParams): Promise<NewTraderResponse[]>;
|
|
11
12
|
}
|
|
12
13
|
//# sourceMappingURL=AffiliatePortalService.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AffiliatePortalService.d.ts","sourceRoot":"","sources":["../../src/affiliate-portal/AffiliatePortalService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,
|
|
1
|
+
{"version":3,"file":"AffiliatePortalService.d.ts","sourceRoot":"","sources":["../../src/affiliate-portal/AffiliatePortalService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAIF,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,QAAQ,EAAE,8BAA8B;IAIvC,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAetF,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAYrG,sBAAsB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;CAY/F"}
|
|
@@ -31,4 +31,20 @@ export interface NewTraderResponse {
|
|
|
31
31
|
referrer_identifier: string;
|
|
32
32
|
total_new_traders: string;
|
|
33
33
|
}
|
|
34
|
+
export interface GetAffiliateTotalStatsParams {
|
|
35
|
+
statuses?: string[];
|
|
36
|
+
regions?: string[];
|
|
37
|
+
audiences?: string[];
|
|
38
|
+
}
|
|
39
|
+
export interface GetAffiliateTotalStatsResponse {
|
|
40
|
+
total_affiliates: number;
|
|
41
|
+
active_affiliates: number;
|
|
42
|
+
suspended_affiliates: number;
|
|
43
|
+
total_regions: number;
|
|
44
|
+
total_volume: number;
|
|
45
|
+
total_revenue: number;
|
|
46
|
+
total_attributions: number;
|
|
47
|
+
total_referred_users: number;
|
|
48
|
+
total_earnings: AffiliateEarning[];
|
|
49
|
+
}
|
|
34
50
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -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,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,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,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,cAAc,EAAE,gBAAgB,EAAE,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;CACxB;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"}
|
|
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,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,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,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,cAAc,EAAE,gBAAgB,EAAE,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;CACxB;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,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,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"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '../HttpClient';
|
|
2
|
-
import { GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse } from './types';
|
|
2
|
+
import { CloseClaimChecksParams, CloseClaimChecksResponse, GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimChecksParams, GetClaimChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse } from './types';
|
|
3
3
|
export type ClaimCheckServiceSettings = {
|
|
4
4
|
httpClient: HttpClient;
|
|
5
5
|
debug?: boolean;
|
|
@@ -11,6 +11,20 @@ export declare class ClaimCheckService {
|
|
|
11
11
|
private readonly httpClient;
|
|
12
12
|
private readonly _debug;
|
|
13
13
|
constructor(settings: ClaimCheckServiceSettings);
|
|
14
|
+
/**
|
|
15
|
+
* Retrieves claim checks for a user with optional status filtering
|
|
16
|
+
*
|
|
17
|
+
* @param {GetClaimChecksParams} params - User identifier and optional status filter
|
|
18
|
+
* @returns {Promise<GetClaimChecksResponse>} List of claim checks
|
|
19
|
+
*/
|
|
20
|
+
getClaimChecks(params: GetClaimChecksParams): Promise<GetClaimChecksResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* Closes open claim checks, aggregating and signing them for on-chain claiming
|
|
23
|
+
*
|
|
24
|
+
* @param {CloseClaimChecksParams} params - User identifier and claim check IDs to close
|
|
25
|
+
* @returns {Promise<CloseClaimChecksResponse>} Array of signed claim responses ready for on-chain execution
|
|
26
|
+
*/
|
|
27
|
+
closeClaimChecks(params: CloseClaimChecksParams): Promise<CloseClaimChecksResponse>;
|
|
14
28
|
/**
|
|
15
29
|
* Retrieves all claimable claim checks for a user
|
|
16
30
|
* Returns only unclaimed checks with valid (non-expired) deadlines
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ClaimCheckService.d.ts","sourceRoot":"","sources":["../../src/claim-checks/ClaimCheckService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,
|
|
1
|
+
{"version":3,"file":"ClaimCheckService.d.ts","sourceRoot":"","sources":["../../src/claim-checks/ClaimCheckService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAIF;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;gBAEjC,QAAQ,EAAE,yBAAyB;IAK/C;;;;;OAKG;IACU,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiB1F;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAYhG;;;;;;OAMG;IACU,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAWtG;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAU1G"}
|
|
@@ -3,6 +3,37 @@ export interface GetClaimableChecksParams {
|
|
|
3
3
|
user_identifier: string;
|
|
4
4
|
user_identifier_type: UserIdentifierType;
|
|
5
5
|
}
|
|
6
|
+
export declare enum ClaimCheckStatus {
|
|
7
|
+
Open = "open",
|
|
8
|
+
Unclaimed = "unclaimed",
|
|
9
|
+
Claimed = "claimed"
|
|
10
|
+
}
|
|
11
|
+
export interface ClaimCheckItem {
|
|
12
|
+
id: string;
|
|
13
|
+
currency_address: string;
|
|
14
|
+
currency_chain_id: string;
|
|
15
|
+
currency_name: string;
|
|
16
|
+
currency_decimals: number;
|
|
17
|
+
reason: string;
|
|
18
|
+
amount: string;
|
|
19
|
+
status: string;
|
|
20
|
+
deadline_seconds: number;
|
|
21
|
+
created_at: string;
|
|
22
|
+
}
|
|
23
|
+
export interface GetClaimChecksParams {
|
|
24
|
+
user_identifier: string;
|
|
25
|
+
user_identifier_type: UserIdentifierType;
|
|
26
|
+
status?: ClaimCheckStatus;
|
|
27
|
+
}
|
|
28
|
+
export interface GetClaimChecksResponse {
|
|
29
|
+
claim_checks: ClaimCheckItem[];
|
|
30
|
+
}
|
|
31
|
+
export interface CloseClaimChecksParams {
|
|
32
|
+
user_identifier: string;
|
|
33
|
+
user_identifier_type: UserIdentifierType;
|
|
34
|
+
claim_check_ids: string[];
|
|
35
|
+
}
|
|
36
|
+
export type CloseClaimChecksResponse = ClaimResponse[];
|
|
6
37
|
export declare enum ClaimCheckReason {
|
|
7
38
|
AffiliatePayout = 0,
|
|
8
39
|
EndUserPayout = 1
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/claim-checks/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;CAC1C;AAED,oBAAY,gBAAgB;IAC1B,eAAe,IAAI;IACnB,aAAa,IAAI;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,0BAA0B,GAAG,aAAa,EAAE,CAAC;AAEzD,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/claim-checks/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;CAC1C;AAED,oBAAY,gBAAgB;IAC1B,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;IACzC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;IACzC,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,MAAM,wBAAwB,GAAG,aAAa,EAAE,CAAC;AAEvD,oBAAY,gBAAgB;IAC1B,eAAe,IAAI;IACnB,aAAa,IAAI;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,0BAA0B,GAAG,aAAa,EAAE,CAAC;AAEzD,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC"}
|
package/dist/core.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { UserIdentifierType } from '.';
|
|
2
|
-
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse } from './affiliate-portal/types';
|
|
3
|
-
import { GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse } from './claim-checks/types';
|
|
2
|
+
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetAffiliateTotalStatsParams, GetAffiliateTotalStatsResponse, GetNewTradersParams, NewTraderResponse } from './affiliate-portal/types';
|
|
3
|
+
import { CloseClaimChecksParams, CloseClaimChecksResponse, GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimChecksParams, GetClaimChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse } from './claim-checks/types';
|
|
4
4
|
import { Affiliate, Conversion, CreateAffiliateResponse, DeleteReferralParams, GenerateReferralCodesParams, GenerateReferralCodesResponse, GetConversionsParams, GetPayoutsByReferrerParams, GetPayoutsLeaderboardParams, GetPointsLeaderboardParams, GetReferralCodeParams, GetReferralCodeResponse, GetReferralStatusParams, GetReferralStatusResponse, GetReferredUsersLeaderboardParams, GetReferredVolumeParams, GetRevenueLeaderboardParams, GetUserAudiencesParams, GetUserAudiencesResponse, GetUserPayoutMovementsParams, GetUserPayoutsByConversionParams, GetUserPointsByConversionParams, GetUserPointsMovementsParams, GetVolumeLeaderboardParams, LeaderboardResponse, ListUserReferralCodesParams, ListUserReferralCodesResponse, PayoutsByReferrerResponse, PayoutsLeaderboard, PointsLeaderboard, ReferredUsersLeaderboard, ReferredVolumeResponse, RevenueLeaderboard, UpdateReferralCodeParams, UseReferralCodeParams, UserPayoutMovementsResponse, UserPayoutsByConversionResponse, UserPointsByConversionResponse, UserPointsMovementsResponse, VolumeLeaderboard } from './types/api';
|
|
5
5
|
import { AffiliateCodeParams, AffiliateLinkParams, EventArgs, FuulSettings, IdentifyUserParams, UpdateRebateRateParams } from './types/sdk';
|
|
6
6
|
import { GetUserReferrerParams, GetUserReferrerResponse } from './user/types';
|
|
@@ -466,6 +466,50 @@ export declare function getAffiliateStats(params: GetAffiliateStatsParams): Prom
|
|
|
466
466
|
* ```
|
|
467
467
|
*/
|
|
468
468
|
export declare function getAffiliateNewTraders(params: GetNewTradersParams): Promise<NewTraderResponse[]>;
|
|
469
|
+
/**
|
|
470
|
+
* Gets total stats for the project's affiliate portal
|
|
471
|
+
* @param {GetAffiliateTotalStatsParams} params Optional filters (statuses, regions, audiences)
|
|
472
|
+
* @returns {Promise<GetAffiliateTotalStatsResponse>} Project total stats
|
|
473
|
+
* @example
|
|
474
|
+
* ```typescript
|
|
475
|
+
* const totalStats = await Fuul.getAffiliateTotalStats({});
|
|
476
|
+
* ```
|
|
477
|
+
*/
|
|
478
|
+
export declare function getAffiliateTotalStats(params: GetAffiliateTotalStatsParams): Promise<GetAffiliateTotalStatsResponse>;
|
|
479
|
+
/**
|
|
480
|
+
* Retrieves claim checks for a user with optional status filtering
|
|
481
|
+
* @param {GetClaimChecksParams} params Get claim checks parameters
|
|
482
|
+
* @returns {Promise<GetClaimChecksResponse>} List of claim checks
|
|
483
|
+
* @example
|
|
484
|
+
* ```typescript
|
|
485
|
+
* const result = await Fuul.getClaimChecks({
|
|
486
|
+
* user_identifier: '0x12345',
|
|
487
|
+
* user_identifier_type: UserIdentifierType.EvmAddress,
|
|
488
|
+
* status: ClaimCheckStatus.Open,
|
|
489
|
+
* });
|
|
490
|
+
* result.claim_checks.forEach(check => {
|
|
491
|
+
* console.log(`${check.id}: ${check.amount} (${check.status})`);
|
|
492
|
+
* });
|
|
493
|
+
* ```
|
|
494
|
+
*/
|
|
495
|
+
export declare function getClaimChecks(params: GetClaimChecksParams): Promise<GetClaimChecksResponse>;
|
|
496
|
+
/**
|
|
497
|
+
* Closes open claim checks, aggregating and signing them for on-chain claiming
|
|
498
|
+
* @param {CloseClaimChecksParams} params User identifier and claim check IDs to close
|
|
499
|
+
* @returns {Promise<CloseClaimChecksResponse>} Array of signed claim responses
|
|
500
|
+
* @example
|
|
501
|
+
* ```typescript
|
|
502
|
+
* const claims = await Fuul.closeClaimChecks({
|
|
503
|
+
* user_identifier: '0x12345',
|
|
504
|
+
* user_identifier_type: UserIdentifierType.EvmAddress,
|
|
505
|
+
* claim_check_ids: ['uuid-1', 'uuid-2'],
|
|
506
|
+
* });
|
|
507
|
+
* claims.forEach(claim => {
|
|
508
|
+
* console.log(`Amount: ${claim.amount}, Proof: ${claim.proof}`);
|
|
509
|
+
* });
|
|
510
|
+
* ```
|
|
511
|
+
*/
|
|
512
|
+
export declare function closeClaimChecks(params: CloseClaimChecksParams): Promise<CloseClaimChecksResponse>;
|
|
469
513
|
/**
|
|
470
514
|
* Gets all claimable claim checks for a user within a project
|
|
471
515
|
* Returns only unclaimed checks with valid (non-expired) deadlines
|
|
@@ -538,6 +582,9 @@ declare const _default: {
|
|
|
538
582
|
deleteReferral: typeof deleteReferral;
|
|
539
583
|
getAffiliateStats: typeof getAffiliateStats;
|
|
540
584
|
getAffiliateNewTraders: typeof getAffiliateNewTraders;
|
|
585
|
+
getAffiliateTotalStats: typeof getAffiliateTotalStats;
|
|
586
|
+
getClaimChecks: typeof getClaimChecks;
|
|
587
|
+
closeClaimChecks: typeof closeClaimChecks;
|
|
541
588
|
getClaimableChecks: typeof getClaimableChecks;
|
|
542
589
|
getClaimCheckTotals: typeof getClaimCheckTotals;
|
|
543
590
|
};
|
package/dist/core.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAEvC,OAAO,
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAEvC,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAIlC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC;AAQ9B,OAAO,EACL,SAAS,EACT,UAAU,EACV,uBAAuB,EACvB,oBAAoB,EAEpB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,iCAAiC,EACjC,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,4BAA4B,EAC5B,0BAA0B,EAC1B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC3B,+BAA+B,EAC/B,8BAA8B,EAC9B,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAC5I,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAoB9E,wBAAgB,IAAI,CAAC,QAAQ,EAAE,YAAY,QAyB1C;AAQD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAc7E;AAED;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB1F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,YAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAkCnG;AAED;;;;;;;;;;;;;;;;;;;;IAoBI;AACJ,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAWvG;AAED;;;;;;;;;;;;;;;;;;;IAmBI;AACJ,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUpF;AAED;;;;;;;;;;;;;;;;;;;;;IAqBI;AACJ,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAYpF;AAED;;;;;;;;;IASI;AACJ,wBAAsB,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAG5H;AAED;;;;;;;;;;IAUI;AACJ,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAGxE;AAED;;;;;;;;;;IAUI;AACJ,wBAAsB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG7E;AAED;;;;;;;;;;;;;IAaI;AACJ,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAED;;;;;;;;IAQI;AACJ,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAE3H;AAED;;;;;;;;IAQI;AACJ,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAExH;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,iCAAiC,GAAG,OAAO,CAAC,mBAAmB,CAAC,wBAAwB,CAAC,CAAC,CAE7I;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAGlG;AAED;;;;;;;;IAQI;AACJ,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAGxH;AAED;;;;;;;;IAQI;AACJ,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAG3H;AAED;;;;;;;;IAQI;AACJ,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,gCAAgC,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAE7H;AAED;;;;;;;;IAQI;AACJ,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAE1H;AAED;;;;;;;;IAQI;AACJ,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAEjH;AAED;;;;;;;;IAQI;AACJ,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAEjH;AAED;;;;;;;;IAQI;AACJ,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAG3G;AAED;;;;;;;;IAQI;AACJ,wBAAsB,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAGzF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAGrG;AAED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAGxG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAGvH;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAGzH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAG3G;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAGrG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGlF;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGxF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGhF;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAG3G;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,sBAAsB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAGtG;AAED;;;;;;;;GAQG;AACH,wBAAsB,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAG1H;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAGlG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAGxG;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAG9G;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAGjH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BD,wBAwCE"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { default as Fuul } from './core';
|
|
2
|
-
export type { AffiliateEarning, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse, } from './affiliate-portal/types';
|
|
2
|
+
export type { AffiliateEarning, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetAffiliateTotalStatsParams, GetAffiliateTotalStatsResponse, GetNewTradersParams, NewTraderResponse, } from './affiliate-portal/types';
|
|
3
3
|
export * from './affiliates/errors';
|
|
4
|
-
export type { ClaimCheckReason, ClaimCheckTotalItem, ClaimResponse, GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse, } from './claim-checks/types';
|
|
4
|
+
export type { ClaimCheckItem, ClaimCheckReason, ClaimCheckTotalItem, ClaimResponse, CloseClaimChecksParams, CloseClaimChecksResponse, GetClaimableChecksParams, GetClaimableChecksResponse, GetClaimChecksParams, GetClaimChecksResponse, GetClaimCheckTotalsParams, GetClaimCheckTotalsResponse, } from './claim-checks/types';
|
|
5
|
+
export { ClaimCheckStatus } from './claim-checks/types';
|
|
5
6
|
export type { Affiliate, Conversion, CreateAffiliateResponse, DeleteReferralParams, EarningItem, GenerateReferralCodesParams, GenerateReferralCodesResponse, GetPayoutsByReferrerParams, GetReferralCodeParams, GetReferralCodeResponse, GetReferralStatusParams, GetReferralStatusResponse, GetReferredVolumeParams, GetRevenueLeaderboardParams, LeaderboardResponse, ListUserReferralCodesParams, ListUserReferralCodesResponse, PayoutsByReferrerResponse, ReferredVolumeItem, ReferredVolumeResponse, ReferrerPayoutData, RevenueLeaderboard, UpdateReferralCodeParams, UseReferralCodeParams, UserReferralCode, } from './types/api';
|
|
6
7
|
export type { EventArgs, FuulSettings, IdentifyUserParams, UpdateRebateRateParams } from './types/sdk';
|
|
7
8
|
export { UserIdentifierType } from './types/user';
|
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,uBAAuB,EACvB,yBAAyB,EACzB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,wBAAwB,EACxB,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,SAAS,EACT,UAAU,EACV,uBAAuB,EACvB,oBAAoB,EACpB,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,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,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,iBAAiB,GAClB,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,UAAU,EACV,uBAAuB,EACvB,oBAAoB,EACpB,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,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"}
|