@offcoin/sdk
Advanced tools
+1
-1
@@ -58,4 +58,4 @@ /** | ||
| } | ||
| export type { OffcoinClientOptions, RetryOptions, Member, MemberBalance, MemberXp, TokenOperationResult, XpOperationResult, Achievement, UnlockResult, LeaderboardEntry, LeaderboardResponse, LeaderboardOptions, CreateMemberInput, UpdateMemberInput, MemberAlias, MemberAliasesResponse, AddAliasResult, RemoveAliasResult, Permission, PurchasePermissionResult, ListPermissionsOptions, ApiResponse } from './types.js'; | ||
| export type { OffcoinClientOptions, RetryOptions, Member, MemberBalance, MemberXp, TokenOperationResult, XpOperationResult, Achievement, UnlockResult, LeaderboardEntry, LeaderboardResponse, LeaderboardOptions, CreateMemberInput, UpdateMemberInput, MemberAlias, MemberAliasesResponse, AddAliasResult, RemoveAliasResult, UpdateAliasResult, Permission, PurchasePermissionResult, ListPermissionsOptions, ApiResponse } from './types.js'; | ||
| export { OffcoinError, AuthenticationError, NotFoundError, ValidationError, ForbiddenError, BadRequestError, InternalError, RateLimitedError, NetworkError } from './errors.js'; | ||
| export { verifyWebhookSignature, WebhookEventTypes, type WebhookEventType, type WebhookPayload, type BalanceUpdatedData, type XpUpdatedData, type AchievementUnlockedData, type PermissionGrantedData, type VerifyWebhookResult, type VerifyWebhookOptions } from './webhooks.js'; |
@@ -6,3 +6,3 @@ /** | ||
| import type { HttpClient } from '../client.js'; | ||
| import type { Member, MemberBalance, MemberXp, TokenOperationResult, XpOperationResult, CreateMemberInput, UpdateMemberInput, MemberAliasesResponse, AddAliasResult, RemoveAliasResult, ListMembersOptions } from '../types.js'; | ||
| import type { Member, MemberBalance, MemberXp, TokenOperationResult, XpOperationResult, CreateMemberInput, UpdateMemberInput, MemberAliasesResponse, AddAliasResult, RemoveAliasResult, UpdateAliasResult, ListMembersOptions } from '../types.js'; | ||
| export declare class MembersResource { | ||
@@ -78,2 +78,9 @@ private readonly client; | ||
| removeAlias(alias: string, aliasToRemove: string): Promise<RemoveAliasResult>; | ||
| /** | ||
| * Update an alias for a member (replace old alias with new alias) | ||
| * @param alias - Member alias or ID | ||
| * @param oldAlias - The existing alias to replace | ||
| * @param newAlias - The new alias to use (e.g., "discord:123456", "email:user@example.com") | ||
| */ | ||
| updateAlias(alias: string, oldAlias: string, newAlias: string): Promise<UpdateAliasResult>; | ||
| } |
@@ -115,2 +115,14 @@ /** | ||
| } | ||
| /** | ||
| * Update an alias for a member (replace old alias with new alias) | ||
| * @param alias - Member alias or ID | ||
| * @param oldAlias - The existing alias to replace | ||
| * @param newAlias - The new alias to use (e.g., "discord:123456", "email:user@example.com") | ||
| */ | ||
| updateAlias(alias, oldAlias, newAlias) { | ||
| return this.client.patch(`/api/v1/members/${encodeURIComponent(alias)}/aliases`, { | ||
| oldAlias, | ||
| newAlias | ||
| }); | ||
| } | ||
| } |
+8
-0
@@ -166,2 +166,10 @@ /** | ||
| } | ||
| export interface UpdateAliasResult { | ||
| id: string; | ||
| memberId: string; | ||
| memberName: string; | ||
| oldAlias: string; | ||
| newAlias: string; | ||
| createdAt: string; | ||
| } | ||
| export interface LeaderboardOptions { | ||
@@ -168,0 +176,0 @@ sort?: 'tokens' | 'xp' | 'level'; |
+1
-1
| { | ||
| "name": "@offcoin/sdk", | ||
| "version": "0.0.9", | ||
| "version": "0.0.10", | ||
| "description": "TypeScript/JavaScript SDK for the Offcoin API", | ||
@@ -5,0 +5,0 @@ "homepage": "https://offcoin.space", |
+16
-0
@@ -99,2 +99,18 @@ # @offcoin/sdk | ||
| ### Member Aliases | ||
| ```typescript | ||
| // List all aliases for a member | ||
| const aliases = await offcoin.members.listAliases('discord:123456'); | ||
| // Add alias 'github:johndoe' to a member with alias 'discord:johndoe' | ||
| const addResult = await offcoin.members.addAlias('discord:johndoe', 'github:johndoe'); | ||
| // Update alias 'discord:123456' to 'discord:789012' for a member with alias 'github:123456' | ||
| const updateResult = await offcoin.members.updateAlias('github:123456', 'discord:123456', 'discord:789012'); | ||
| // Remove alias 'github:johndoe' from a member with alias 'discord:123456' | ||
| const removeResult = await offcoin.members.removeAlias('discord:123456', 'github:johndoe'); | ||
| ``` | ||
| ### Achievements | ||
@@ -101,0 +117,0 @@ |
57247
3.12%1277
2.16%443
3.75%