@fuul/sdk 7.0.5 → 7.0.6
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/HttpClient.d.ts +1 -0
- package/dist/HttpClient.d.ts.map +1 -1
- package/dist/core.d.ts +79 -1
- package/dist/core.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +693 -592
- package/dist/index.umd.js +6 -6
- package/dist/invite-codes/InviteCodeService.d.ts +17 -0
- package/dist/invite-codes/InviteCodeService.d.ts.map +1 -0
- package/dist/release.json.d.ts +1 -1
- package/dist/types/api.d.ts +43 -0
- package/dist/types/api.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/HttpClient.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export declare class HttpClient {
|
|
|
22
22
|
get<T>(req: Request): Promise<AxiosResponse<T>>;
|
|
23
23
|
post<T>(req: Request): Promise<AxiosResponse<T>>;
|
|
24
24
|
put<T>(req: Request): Promise<AxiosResponse<T>>;
|
|
25
|
+
patch<T>(req: Request): Promise<AxiosResponse<T>>;
|
|
25
26
|
delete<T>(req: Request): Promise<AxiosResponse<T>>;
|
|
26
27
|
}
|
|
27
28
|
export {};
|
package/dist/HttpClient.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpClient.d.ts","sourceRoot":"","sources":["../src/HttpClient.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AAI5D,UAAU,iBAAiB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,kBAAkB,CAA0B;gBAExC,OAAO,EAAE,iBAAiB;IAYtC,OAAO,CAAC,eAAe;IAIjB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAQ/C,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAShD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAS/C,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAOzD"}
|
|
1
|
+
{"version":3,"file":"HttpClient.d.ts","sourceRoot":"","sources":["../src/HttpClient.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AAI5D,UAAU,iBAAiB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,kBAAkB,CAA0B;gBAExC,OAAO,EAAE,iBAAiB;IAYtC,OAAO,CAAC,eAAe;IAIjB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAQ/C,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAShD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAS/C,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IASjD,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAOzD"}
|
package/dist/core.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { UserIdentifierType } from '.';
|
|
2
|
-
import { Conversion, GetConversionsParams, GetPayoutsLeaderboardParams, GetPointsLeaderboardParams, GetReferredUsersLeaderboardParams, GetUserAudiencesParams, GetUserAudiencesResponse, GetUserPayoutMovementsParams, GetUserPayoutsByConversionParams, GetUserPointsByConversionParams, GetUserPointsMovementsParams, GetVolumeLeaderboardParams, LeaderboardResponse, PayoutsLeaderboard, PointsLeaderboard, ReferredUsersLeaderboard, UserPayoutMovementsResponse, UserPayoutsByConversionResponse, UserPointsByConversionResponse, UserPointsMovementsResponse, VolumeLeaderboard } from './types/api';
|
|
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
4
|
import { GetUserAffiliatesParams, UserAffiliate } from './user/types';
|
|
5
5
|
export declare function init(settings: FuulSettings): void;
|
|
@@ -241,6 +241,79 @@ export declare function getUserAffiliates(params: GetUserAffiliatesParams): Prom
|
|
|
241
241
|
*
|
|
242
242
|
*/
|
|
243
243
|
export declare function getUserAudiences(params: GetUserAudiencesParams): Promise<GetUserAudiencesResponse>;
|
|
244
|
+
/**
|
|
245
|
+
* Lists invite codes for a user
|
|
246
|
+
* @param {ListUserInviteCodesParams} params List user invite codes parameters
|
|
247
|
+
* @returns {Promise<ListUserInviteCodesResponse>} List of user invite codes with pagination
|
|
248
|
+
* @example
|
|
249
|
+
* ```typescript
|
|
250
|
+
* const result = await Fuul.listUserInviteCodes({
|
|
251
|
+
* user_identifier: '0x12345',
|
|
252
|
+
* user_identifier_type: UserIdentifierType.EvmAddress,
|
|
253
|
+
* page: 1,
|
|
254
|
+
* page_size: 25
|
|
255
|
+
* });
|
|
256
|
+
* ```
|
|
257
|
+
*/
|
|
258
|
+
export declare function listUserInviteCodes(params: ListUserInviteCodesParams): Promise<ListUserInviteCodesResponse>;
|
|
259
|
+
/**
|
|
260
|
+
* Generates invite codes for a user
|
|
261
|
+
* @param {GenerateInviteCodesParams} params Generate invite codes parameters
|
|
262
|
+
* @returns {Promise<GenerateInviteCodesResponse[]>} Generated invite codes
|
|
263
|
+
* @example
|
|
264
|
+
* ```typescript
|
|
265
|
+
* const codes = await Fuul.generateInviteCodes({
|
|
266
|
+
* user_identifier: '0x12345',
|
|
267
|
+
* user_identifier_type: UserIdentifierType.EvmAddress
|
|
268
|
+
* });
|
|
269
|
+
* ```
|
|
270
|
+
*/
|
|
271
|
+
export declare function generateInviteCodes(params: GenerateInviteCodesParams): Promise<GenerateInviteCodesResponse[]>;
|
|
272
|
+
/**
|
|
273
|
+
* Gets the invitation status for a user
|
|
274
|
+
* @param {GetInvitationStatusParams} params Get invitation status parameters
|
|
275
|
+
* @returns {Promise<GetInvitationStatusResponse>} Invitation status
|
|
276
|
+
* @example
|
|
277
|
+
* ```typescript
|
|
278
|
+
* const status = await Fuul.getInvitationStatus({
|
|
279
|
+
* user_identifier: '0x12345',
|
|
280
|
+
* user_identifier_type: UserIdentifierType.EvmAddress
|
|
281
|
+
* });
|
|
282
|
+
* if (status.invited) {
|
|
283
|
+
* console.log('User was invited with code:', status.code);
|
|
284
|
+
* }
|
|
285
|
+
* ```
|
|
286
|
+
*/
|
|
287
|
+
export declare function getInvitationStatus(params: GetInvitationStatusParams): Promise<GetInvitationStatusResponse>;
|
|
288
|
+
/**
|
|
289
|
+
* Checks if an invite code is free to use
|
|
290
|
+
* @param {CheckInviteCodeParams} params Check invite code parameters
|
|
291
|
+
* @returns {Promise<CheckInviteCodeResponse>} Check result
|
|
292
|
+
* @example
|
|
293
|
+
* ```typescript
|
|
294
|
+
* const result = await Fuul.checkInviteCode({ code: 'WELCOME2024' });
|
|
295
|
+
* if (result.is_free) {
|
|
296
|
+
* console.log('Invite code is available!');
|
|
297
|
+
* }
|
|
298
|
+
* ```
|
|
299
|
+
*/
|
|
300
|
+
export declare function checkInviteCode(params: CheckInviteCodeParams): Promise<CheckInviteCodeResponse>;
|
|
301
|
+
/**
|
|
302
|
+
* Uses an invite code
|
|
303
|
+
* @param {UseInviteCodeParams} params Use invite code parameters
|
|
304
|
+
* @returns {Promise<void>}
|
|
305
|
+
* @example
|
|
306
|
+
* ```typescript
|
|
307
|
+
* await Fuul.useInviteCode({
|
|
308
|
+
* code: 'WELCOME2024',
|
|
309
|
+
* user_identifier: '0x12345',
|
|
310
|
+
* user_identifier_type: UserIdentifierType.EvmAddress,
|
|
311
|
+
* signature: '0xaad9a0b62f87c15a248cb99ca926785b828b5',
|
|
312
|
+
* signature_message: 'Accept invitation'
|
|
313
|
+
* });
|
|
314
|
+
* ```
|
|
315
|
+
*/
|
|
316
|
+
export declare function useInviteCode(params: UseInviteCodeParams): Promise<void>;
|
|
244
317
|
declare const _default: {
|
|
245
318
|
init: typeof init;
|
|
246
319
|
sendEvent: typeof sendEvent;
|
|
@@ -262,6 +335,11 @@ declare const _default: {
|
|
|
262
335
|
getUserPayoutMovements: typeof getUserPayoutMovements;
|
|
263
336
|
getUserAffiliates: typeof getUserAffiliates;
|
|
264
337
|
getVolumeLeaderboard: typeof getVolumeLeaderboard;
|
|
338
|
+
listUserInviteCodes: typeof listUserInviteCodes;
|
|
339
|
+
generateInviteCodes: typeof generateInviteCodes;
|
|
340
|
+
getInvitationStatus: typeof getInvitationStatus;
|
|
341
|
+
checkInviteCode: typeof checkInviteCode;
|
|
342
|
+
useInviteCode: typeof useInviteCode;
|
|
265
343
|
};
|
|
266
344
|
export default _default;
|
|
267
345
|
//# sourceMappingURL=core.d.ts.map
|
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;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,uBAAuB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAkBtE,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;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAGjG;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;;;;;;;;;;;GAWG;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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { default as Fuul } from './core';
|
|
2
2
|
export * from './affiliates/errors';
|
|
3
|
-
export type { Conversion } from './types/api';
|
|
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
6
|
export { Fuul };
|
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,
|
|
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;AAElD,OAAO,EAAE,IAAI,EAAE,CAAC"}
|