@fuul/sdk 7.0.10 → 7.2.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/core.d.ts +14 -8
- package/dist/core.d.ts.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +270 -269
- package/dist/index.umd.js +1 -1
- package/dist/invite-codes/InviteCodeService.d.ts.map +1 -1
- package/dist/release.json.d.ts +1 -1
- package/dist/types/api.d.ts +7 -3
- package/dist/types/api.d.ts.map +1 -1
- package/dist/user/UserService.d.ts +2 -2
- package/dist/user/UserService.d.ts.map +1 -1
- package/dist/user/types/index.d.ts +7 -8
- package/dist/user/types/index.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/core.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { UserIdentifierType } from '.';
|
|
2
2
|
import { CheckInviteCodeParams, CheckInviteCodeResponse, Conversion, GenerateInviteCodesParams, GenerateInviteCodesResponse, GetConversionsParams, GetInvitationStatusParams, GetInvitationStatusResponse, GetPayoutsLeaderboardParams, GetPointsLeaderboardParams, GetReferredUsersLeaderboardParams, GetUserAudiencesParams, GetUserAudiencesResponse, GetUserPayoutMovementsParams, GetUserPayoutsByConversionParams, GetUserPointsByConversionParams, GetUserPointsMovementsParams, GetVolumeLeaderboardParams, LeaderboardResponse, ListUserInviteCodesParams, ListUserInviteCodesResponse, PayoutsLeaderboard, PointsLeaderboard, ReferredUsersLeaderboard, UseInviteCodeParams, UserPayoutMovementsResponse, UserPayoutsByConversionResponse, UserPointsByConversionResponse, UserPointsMovementsResponse, VolumeLeaderboard } from './types/api';
|
|
3
3
|
import { AffiliateCodeParams, AffiliateLinkParams, EventArgs, FuulSettings, IdentifyUserParams } from './types/sdk';
|
|
4
|
-
import {
|
|
4
|
+
import { GetUserReferrerParams, GetUserReferrerResponse } from './user/types';
|
|
5
5
|
export declare function init(settings: FuulSettings): void;
|
|
6
6
|
/**
|
|
7
7
|
* @param {string} name Event name
|
|
@@ -222,15 +222,19 @@ export declare function getUserPointsMovements(params: GetUserPointsMovementsPar
|
|
|
222
222
|
**/
|
|
223
223
|
export declare function getConversions(params?: GetConversionsParams): Promise<Conversion[]>;
|
|
224
224
|
/**
|
|
225
|
-
*
|
|
226
|
-
* @param {
|
|
227
|
-
* @returns {Promise<
|
|
225
|
+
* Gets the referrer information for a user
|
|
226
|
+
* @param {GetUserReferrerParams} params The query params
|
|
227
|
+
* @returns {Promise<GetUserReferrerResponse>} User referrer information
|
|
228
228
|
* @example
|
|
229
229
|
* ```typescript
|
|
230
|
-
* const
|
|
230
|
+
* const result = await Fuul.getUserReferrer({
|
|
231
|
+
* user_identifier: '0x12345',
|
|
232
|
+
* user_identifier_type: UserIdentifierType.EvmAddress
|
|
233
|
+
* });
|
|
234
|
+
* // result: { user_identifier: '0x12345', referrer_identifier: '0xabcde' }
|
|
231
235
|
* ```
|
|
232
236
|
*/
|
|
233
|
-
export declare function
|
|
237
|
+
export declare function getUserReferrer(params: GetUserReferrerParams): Promise<GetUserReferrerResponse>;
|
|
234
238
|
/**
|
|
235
239
|
*
|
|
236
240
|
* @param {GetUserAudiencesParams} params The query params
|
|
@@ -264,7 +268,9 @@ export declare function listUserInviteCodes(params: ListUserInviteCodesParams):
|
|
|
264
268
|
* ```typescript
|
|
265
269
|
* const codes = await Fuul.generateInviteCodes({
|
|
266
270
|
* user_identifier: '0x12345',
|
|
267
|
-
* user_identifier_type: UserIdentifierType.EvmAddress
|
|
271
|
+
* user_identifier_type: UserIdentifierType.EvmAddress,
|
|
272
|
+
* quantity: 5,
|
|
273
|
+
* max_uses: 10
|
|
268
274
|
* });
|
|
269
275
|
* ```
|
|
270
276
|
*/
|
|
@@ -333,7 +339,7 @@ declare const _default: {
|
|
|
333
339
|
getUserPointsByConversion: typeof getUserPointsByConversion;
|
|
334
340
|
getUserPointsMovements: typeof getUserPointsMovements;
|
|
335
341
|
getUserPayoutMovements: typeof getUserPayoutMovements;
|
|
336
|
-
|
|
342
|
+
getUserReferrer: typeof getUserReferrer;
|
|
337
343
|
getVolumeLeaderboard: typeof getVolumeLeaderboard;
|
|
338
344
|
listUserInviteCodes: typeof listUserInviteCodes;
|
|
339
345
|
generateInviteCodes: typeof generateInviteCodes;
|
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;AAUvC,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EAEV,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,EACpB,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,iCAAiC,EACjC,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,4BAA4B,EAC5B,0BAA0B,EAC1B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,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,
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAUvC,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EAEV,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,EACpB,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,iCAAiC,EACjC,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,4BAA4B,EAC5B,0BAA0B,EAC1B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,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;AAkB9E,wBAAgB,IAAI,CAAC,QAAQ,EAAE,YAAY,QAuB1C;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;;;;;;;;;;;;;;;;;;;IAmBI;AACJ,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUpF;AAED;;;;;;;;;;;;;;;;;;;IAmBI;AACJ,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUpF;AAED;;;;;;;;;IASI;AACJ,wBAAsB,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAGzH;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,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;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAGxG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAGjH;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAGnH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAGjH;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAGrG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BD,wBA0BE"}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,5 +3,6 @@ export * from './affiliates/errors';
|
|
|
3
3
|
export type { CheckInviteCodeParams, CheckInviteCodeResponse, Conversion, GenerateInviteCodesParams, GenerateInviteCodesResponse, GetInvitationStatusParams, GetInvitationStatusResponse, ListUserInviteCodesParams, ListUserInviteCodesResponse, UseInviteCodeParams, UserInviteCode, } from './types/api';
|
|
4
4
|
export type { EventArgs, FuulSettings, IdentifyUserParams } from './types/sdk';
|
|
5
5
|
export { UserIdentifierType } from './types/user';
|
|
6
|
+
export type { GetUserReferrerParams, GetUserReferrerResponse } from './user/types';
|
|
6
7
|
export { Fuul };
|
|
7
8
|
//# 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,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACV,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,mBAAmB,EACnB,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,kBAAkB,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,cAAc,qBAAqB,CAAC;AACpC,YAAY,EACV,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACV,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,mBAAmB,EACnB,cAAc,GACf,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"}
|