@fuul/sdk 7.6.0 → 7.7.1
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/affiliates/AffiliateService.d.ts +3 -2
- package/dist/affiliates/AffiliateService.d.ts.map +1 -1
- package/dist/core.d.ts +8 -6
- package/dist/core.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +371 -369
- package/dist/index.umd.js +6 -6
- package/dist/release.json.d.ts +1 -1
- package/dist/types/api.d.ts +11 -0
- package/dist/types/api.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { UserIdentifierType } from '..';
|
|
2
2
|
import { HttpClient } from '../HttpClient';
|
|
3
|
+
import { Affiliate } from '../types/api';
|
|
3
4
|
export type AffiliateServiceSettings = {
|
|
4
5
|
httpClient: HttpClient;
|
|
5
6
|
debug?: boolean;
|
|
@@ -9,8 +10,8 @@ export declare class AffiliateService {
|
|
|
9
10
|
private readonly _debug;
|
|
10
11
|
constructor(settings: AffiliateServiceSettings);
|
|
11
12
|
create(address: string, identifier_type: UserIdentifierType, code: string, signature: string, signaturePublicKey?: string, accountChainId?: number, userSplitPercentage?: number): Promise<void>;
|
|
12
|
-
update(user_identifier: string, identifier_type: UserIdentifierType, code: string, signature: string, signaturePublicKey?: string, accountChainId?: number): Promise<void>;
|
|
13
|
+
update(user_identifier: string, identifier_type: UserIdentifierType, code: string, signature: string, signaturePublicKey?: string, accountChainId?: number, userSplitPercentage?: number): Promise<void>;
|
|
13
14
|
isCodeFree(code: string): Promise<boolean>;
|
|
14
|
-
getCode(address: string, identifier_type: UserIdentifierType): Promise<
|
|
15
|
+
getCode(address: string, identifier_type: UserIdentifierType): Promise<Affiliate | null>;
|
|
15
16
|
}
|
|
16
17
|
//# sourceMappingURL=AffiliateService.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AffiliateService.d.ts","sourceRoot":"","sources":["../../src/affiliates/AffiliateService.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,IAAI,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"AffiliateService.d.ts","sourceRoot":"","sources":["../../src/affiliates/AffiliateService.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,IAAI,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,SAAS,EAA0C,MAAM,cAAc,CAAC;AAGjF,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;gBAEjC,QAAQ,EAAE,wBAAwB;IAKjC,MAAM,CACjB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,kBAAkB,EACnC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,cAAc,CAAC,EAAE,MAAM,EACvB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,IAAI,CAAC;IAuCH,MAAM,CACjB,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,kBAAkB,EACnC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,cAAc,CAAC,EAAE,MAAM,EACvB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,IAAI,CAAC;IAsCH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU1C,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CActG"}
|
package/dist/core.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { UserIdentifierType } from '.';
|
|
2
|
-
import {
|
|
2
|
+
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse } from './affiliate-portal/types';
|
|
3
|
+
import { Affiliate, Conversion, GenerateReferralCodesParams, GenerateReferralCodesResponse, GetConversionsParams, GetPayoutsByReferrerParams, GetPayoutsLeaderboardParams, GetPointsLeaderboardParams, GetReferralCodeParams, GetReferralCodeResponse, GetReferralStatusParams, GetReferralStatusResponse, GetReferredUsersLeaderboardParams, GetUserAudiencesParams, GetUserAudiencesResponse, GetUserPayoutMovementsParams, GetUserPayoutsByConversionParams, GetUserPointsByConversionParams, GetUserPointsMovementsParams, GetVolumeLeaderboardParams, LeaderboardResponse, ListUserReferralCodesParams, ListUserReferralCodesResponse, PayoutsByReferrerResponse, PayoutsLeaderboard, PointsLeaderboard, ReferredUsersLeaderboard, UpdateReferralCodeParams, UseReferralCodeParams, UserPayoutMovementsResponse, UserPayoutsByConversionResponse, UserPointsByConversionResponse, UserPointsMovementsResponse, VolumeLeaderboard } from './types/api';
|
|
3
4
|
import { AffiliateCodeParams, AffiliateLinkParams, EventArgs, FuulSettings, IdentifyUserParams } from './types/sdk';
|
|
4
5
|
import { GetUserReferrerParams, GetUserReferrerResponse } from './user/types';
|
|
5
|
-
import { GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse } from './affiliate-portal/types';
|
|
6
6
|
export declare function init(settings: FuulSettings): void;
|
|
7
7
|
/**
|
|
8
8
|
* @param {string} name Event name
|
|
@@ -61,6 +61,7 @@ export declare function identifyUser(params: IdentifyUserParams, projectIds?: st
|
|
|
61
61
|
* @param {string} params.signature Signed message authenticating address ownership. Message to be signed: `I confirm that I am creating the ${code} code on Fuul`
|
|
62
62
|
* @param {string} [params.signaturePublicKey] Public key used for signature verification
|
|
63
63
|
* @param {number} [params.accountChainId] Account chain id (required for EIP-1271 signature validation)
|
|
64
|
+
* @param {number} [params.userSplitPercentage] Percentage of rewards split to the user
|
|
64
65
|
* @example
|
|
65
66
|
* ```typescript
|
|
66
67
|
* await Fuul.createAffiliateCode({
|
|
@@ -82,6 +83,7 @@ export declare function createAffiliateCode(params: AffiliateCodeParams): Promis
|
|
|
82
83
|
* @param {string} params.signature Signed message authenticating code update. Message to be signed: `I confirm that I am updating my code to ${code} on Fuul`
|
|
83
84
|
* @param {string} [params.signaturePublicKey] Public key used for signature verification
|
|
84
85
|
* @param {number} [params.accountChainId] Account chain id (required for EIP-1271 signature validation)
|
|
86
|
+
* @param {number} [params.userSplitPercentage] Percentage of rewards split to the user
|
|
85
87
|
* @example
|
|
86
88
|
* ```typescript
|
|
87
89
|
* await Fuul.updateAffiliateCode({
|
|
@@ -95,16 +97,16 @@ export declare function createAffiliateCode(params: AffiliateCodeParams): Promis
|
|
|
95
97
|
**/
|
|
96
98
|
export declare function updateAffiliateCode(params: AffiliateCodeParams): Promise<void>;
|
|
97
99
|
/**
|
|
98
|
-
* Gets the code
|
|
100
|
+
* Gets the affiliate code for a given identifier
|
|
99
101
|
* @param {string} userIdentifier Affiliate identifier
|
|
100
102
|
* @param {UserIdentifierType} identifierType Affiliate identifier type
|
|
101
|
-
* @returns {
|
|
103
|
+
* @returns {Affiliate | null} Affiliate code data
|
|
102
104
|
* @example
|
|
103
105
|
* ```typescript
|
|
104
|
-
* const
|
|
106
|
+
* const affiliateCode = await Fuul.getAffiliateCode('0x12345', UserIdentifierType.EvmAddress);
|
|
105
107
|
* ```
|
|
106
108
|
**/
|
|
107
|
-
export declare function getAffiliateCode(userIdentifier: string, identifierType: UserIdentifierType): Promise<
|
|
109
|
+
export declare function getAffiliateCode(userIdentifier: string, identifierType: UserIdentifierType): Promise<Affiliate | null>;
|
|
108
110
|
/**
|
|
109
111
|
* Checks if an affiliate code is free to use
|
|
110
112
|
* @param {string} code Affiliate code to check
|
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;
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAEvC,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAUtI,OAAO,EACL,SAAS,EACT,UAAU,EAEV,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,iCAAiC,EACjC,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,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,MAAM,aAAa,CAAC;AACpH,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAmB9E,wBAAgB,IAAI,CAAC,QAAQ,EAAE,YAAY,QAwB1C;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,IAAI,CAAC,CAWpF;AAED;;;;;;;;;;;;;;;;;;;;IAoBI;AACJ,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAWpF;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;;;;;;;;;;;;;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;;;;;;;;IAQI;AACJ,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAExH;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;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BD,wBA8BE"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { default as Fuul } from './core';
|
|
2
|
+
export type { AffiliateEarning, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse, } from './affiliate-portal/types';
|
|
2
3
|
export * from './affiliates/errors';
|
|
3
|
-
export type { Conversion, EarningItem, GenerateReferralCodesParams, GenerateReferralCodesResponse, GetPayoutsByReferrerParams, GetReferralCodeParams, GetReferralCodeResponse, GetReferralStatusParams, GetReferralStatusResponse, ListUserReferralCodesParams, ListUserReferralCodesResponse, PayoutsByReferrerResponse, ReferrerPayoutData, UpdateReferralCodeParams, UseReferralCodeParams, UserReferralCode, } from './types/api';
|
|
4
|
+
export type { Affiliate, Conversion, EarningItem, GenerateReferralCodesParams, GenerateReferralCodesResponse, GetPayoutsByReferrerParams, GetReferralCodeParams, GetReferralCodeResponse, GetReferralStatusParams, GetReferralStatusResponse, ListUserReferralCodesParams, ListUserReferralCodesResponse, PayoutsByReferrerResponse, ReferrerPayoutData, UpdateReferralCodeParams, UseReferralCodeParams, UserReferralCode, } from './types/api';
|
|
4
5
|
export type { EventArgs, FuulSettings, IdentifyUserParams } from './types/sdk';
|
|
5
6
|
export { UserIdentifierType } from './types/user';
|
|
6
7
|
export type { GetUserReferrerParams, GetUserReferrerResponse } from './user/types';
|
|
7
|
-
export type { AffiliateEarning, GetAffiliateStatsParams, GetAffiliateStatsResponse, GetNewTradersParams, NewTraderResponse, } from './affiliate-portal/types';
|
|
8
8
|
export { Fuul };
|
|
9
9
|
//# sourceMappingURL=index.d.ts.map
|
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,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,UAAU,EACV,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,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,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,SAAS,EACT,UAAU,EACV,WAAW,EACX,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEnF,OAAO,EAAE,IAAI,EAAE,CAAC"}
|