@proofchain/sdk 2.5.2 → 2.7.0

package/dist/index.d.mts

@@ -1582,61 +1582,49 @@ declare class EndUsersClient {
      */
     list(options?: ListEndUsersOptions): Promise<EndUserListResponse>;
     /**
-     * Get an end-user by ID
+     * Get an end-user by external ID
      */
-    get(userId: string): Promise<EndUser>;
+    get(externalId: string): Promise<EndUser>;
     /**
-     * Get an end-user by external ID
+     * Get an end-user by internal UUID (admin use)
      */
-    getByExternalId(externalId: string): Promise<EndUser>;
+    getByInternalId(userId: string): Promise<EndUser>;
     /**
      * Create an end-user manually
      */
     create(data: CreateEndUserRequest): Promise<EndUser>;
     /**
-     * Update an end-user profile
+     * Update an end-user profile by external ID
      */
-    update(userId: string, data: UpdateEndUserRequest): Promise<EndUser>;
+    update(externalId: string, data: UpdateEndUserRequest): Promise<EndUser>;
     /**
      * Delete an end-user
      */
     delete(userId: string): Promise<void>;
     /**
-     * Link a wallet to an end-user
+     * Link a wallet to an end-user by external ID
      */
-    linkWallet(userId: string, request: LinkWalletRequest): Promise<EndUser>;
+    linkWallet(externalId: string, request: LinkWalletRequest): Promise<EndUser>;
     /**
-     * Unlink wallet from an end-user
+     * Get user activity/events by external ID
      */
-    unlinkWallet(userId: string): Promise<EndUser>;
-    /**
-     * Get user activity/events
-     */
-    getActivity(userId: string, options?: {
+    getActivity(externalId: string, options?: {
         page?: number;
         page_size?: number;
         event_type?: string;
     }): Promise<UserActivityResponse>;
     /**
-     * Add points to a user
-     */
-    addPoints(userId: string, points: number, reason?: string): Promise<EndUser>;
-    /**
-     * Add a segment to a user
-     */
-    addSegment(userId: string, segment: string): Promise<EndUser>;
-    /**
-     * Remove a segment from a user
+     * Add points to a user by external ID
      */
-    removeSegment(userId: string, segment: string): Promise<EndUser>;
+    addPoints(externalId: string, points: number, reason?: string): Promise<EndUser>;
     /**
      * Merge two users (moves all data from source to target)
      */
     merge(request: MergeUsersRequest): Promise<EndUser>;
     /**
-     * Update user attributes (convenience method)
+     * Update user attributes (convenience method) by external ID
      */
-    updateAttributes(userId: string, attributes: Record<string, any>): Promise<EndUser>;
+    updateAttributes(externalId: string, attributes: Record<string, any>): Promise<EndUser>;
     /**
      * Export users as CSV
      */
@@ -2486,6 +2474,8 @@ interface CohortLeaderboardResponse {
     total_users: number;
     group_stats: CohortGroupStats;
     leaderboard: CohortLeaderboardEntry[];
+    current_user: CohortLeaderboardEntry | null;
+    current_user_in_leaderboard: boolean;
 }
 interface CohortDefinition {
     id: string;
@@ -2523,6 +2513,7 @@ interface CohortLeaderboardOptions {
     limit?: number;
     top_n?: number;
     fresh?: boolean;
+    userId?: string;
 }
 interface ListCohortsOptions {
     status?: 'active' | 'inactive' | 'draft';
@@ -2581,6 +2572,8 @@ interface FanpassLeaderboardResponse {
     total_users: number;
     group_stats: FanpassGroupStats;
     leaderboard: FanpassLeaderboardEntry[];
+    current_user: FanpassLeaderboardEntry | null;
+    current_user_in_leaderboard: boolean;
 }
 interface FanpassUserComparisonResponse {
     user_id: string;
@@ -2594,6 +2587,7 @@ interface FanpassLeaderboardOptions {
     limit?: number;
     top_n?: number;
     fresh?: boolean;
+    userId?: string;
 }
 declare class FanpassLeaderboardClient {
     private http;

package/dist/index.d.ts

@@ -1582,61 +1582,49 @@ declare class EndUsersClient {
      */
     list(options?: ListEndUsersOptions): Promise<EndUserListResponse>;
     /**
-     * Get an end-user by ID
+     * Get an end-user by external ID
      */
-    get(userId: string): Promise<EndUser>;
+    get(externalId: string): Promise<EndUser>;
     /**
-     * Get an end-user by external ID
+     * Get an end-user by internal UUID (admin use)
      */
-    getByExternalId(externalId: string): Promise<EndUser>;
+    getByInternalId(userId: string): Promise<EndUser>;
     /**
      * Create an end-user manually
      */
     create(data: CreateEndUserRequest): Promise<EndUser>;
     /**
-     * Update an end-user profile
+     * Update an end-user profile by external ID
      */
-    update(userId: string, data: UpdateEndUserRequest): Promise<EndUser>;
+    update(externalId: string, data: UpdateEndUserRequest): Promise<EndUser>;
     /**
      * Delete an end-user
      */
     delete(userId: string): Promise<void>;
     /**
-     * Link a wallet to an end-user
+     * Link a wallet to an end-user by external ID
      */
-    linkWallet(userId: string, request: LinkWalletRequest): Promise<EndUser>;
+    linkWallet(externalId: string, request: LinkWalletRequest): Promise<EndUser>;
     /**
-     * Unlink wallet from an end-user
+     * Get user activity/events by external ID
      */
-    unlinkWallet(userId: string): Promise<EndUser>;
-    /**
-     * Get user activity/events
-     */
-    getActivity(userId: string, options?: {
+    getActivity(externalId: string, options?: {
         page?: number;
         page_size?: number;
         event_type?: string;
     }): Promise<UserActivityResponse>;
     /**
-     * Add points to a user
-     */
-    addPoints(userId: string, points: number, reason?: string): Promise<EndUser>;
-    /**
-     * Add a segment to a user
-     */
-    addSegment(userId: string, segment: string): Promise<EndUser>;
-    /**
-     * Remove a segment from a user
+     * Add points to a user by external ID
      */
-    removeSegment(userId: string, segment: string): Promise<EndUser>;
+    addPoints(externalId: string, points: number, reason?: string): Promise<EndUser>;
     /**
      * Merge two users (moves all data from source to target)
      */
     merge(request: MergeUsersRequest): Promise<EndUser>;
     /**
-     * Update user attributes (convenience method)
+     * Update user attributes (convenience method) by external ID
      */
-    updateAttributes(userId: string, attributes: Record<string, any>): Promise<EndUser>;
+    updateAttributes(externalId: string, attributes: Record<string, any>): Promise<EndUser>;
     /**
      * Export users as CSV
      */
@@ -2486,6 +2474,8 @@ interface CohortLeaderboardResponse {
     total_users: number;
     group_stats: CohortGroupStats;
     leaderboard: CohortLeaderboardEntry[];
+    current_user: CohortLeaderboardEntry | null;
+    current_user_in_leaderboard: boolean;
 }
 interface CohortDefinition {
     id: string;
@@ -2523,6 +2513,7 @@ interface CohortLeaderboardOptions {
     limit?: number;
     top_n?: number;
     fresh?: boolean;
+    userId?: string;
 }
 interface ListCohortsOptions {
     status?: 'active' | 'inactive' | 'draft';
@@ -2581,6 +2572,8 @@ interface FanpassLeaderboardResponse {
     total_users: number;
     group_stats: FanpassGroupStats;
     leaderboard: FanpassLeaderboardEntry[];
+    current_user: FanpassLeaderboardEntry | null;
+    current_user_in_leaderboard: boolean;
 }
 interface FanpassUserComparisonResponse {
     user_id: string;
@@ -2594,6 +2587,7 @@ interface FanpassLeaderboardOptions {
     limit?: number;
     top_n?: number;
     fresh?: boolean;
+    userId?: string;
 }
 declare class FanpassLeaderboardClient {
     private http;

package/dist/index.js

@@ -1148,16 +1148,16 @@ var EndUsersClient = class {
     return this.http.get(`/end-users?${params.toString()}`);
   }
   /**
-   * Get an end-user by ID
+   * Get an end-user by external ID
    */
-  async get(userId) {
-    return this.http.get(`/end-users/${userId}`);
+  async get(externalId) {
+    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}`);
   }
   /**
-   * Get an end-user by external ID
+   * Get an end-user by internal UUID (admin use)
    */
-  async getByExternalId(externalId) {
-    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}`);
+  async getByInternalId(userId) {
+    return this.http.get(`/end-users/${userId}`);
   }
   /**
    * Create an end-user manually
@@ -1166,10 +1166,10 @@ var EndUsersClient = class {
     return this.http.post("/end-users", data);
   }
   /**
-   * Update an end-user profile
+   * Update an end-user profile by external ID
    */
-  async update(userId, data) {
-    return this.http.patch(`/end-users/${userId}`, data);
+  async update(externalId, data) {
+    return this.http.patch(`/end-users/by-external/${encodeURIComponent(externalId)}`, data);
   }
   /**
    * Delete an end-user
@@ -1178,44 +1178,29 @@ var EndUsersClient = class {
     await this.http.delete(`/end-users/${userId}`);
   }
   /**
-   * Link a wallet to an end-user
+   * Link a wallet to an end-user by external ID
    */
-  async linkWallet(userId, request) {
-    return this.http.post(`/end-users/${userId}/wallet`, request);
+  async linkWallet(externalId, request) {
+    return this.http.post(`/end-users/by-external/${encodeURIComponent(externalId)}/link-wallet`, request);
   }
   /**
-   * Unlink wallet from an end-user
+   * Get user activity/events by external ID
    */
-  async unlinkWallet(userId) {
-    return this.http.delete(`/end-users/${userId}/wallet`);
-  }
-  /**
-   * Get user activity/events
-   */
-  async getActivity(userId, options = {}) {
+  async getActivity(externalId, options = {}) {
     const params = new URLSearchParams();
     if (options.page) params.append("page", options.page.toString());
     if (options.page_size) params.append("page_size", options.page_size.toString());
     if (options.event_type) params.append("event_type", options.event_type);
-    return this.http.get(`/end-users/${userId}/activity?${params.toString()}`);
-  }
-  /**
-   * Add points to a user
-   */
-  async addPoints(userId, points, reason) {
-    return this.http.post(`/end-users/${userId}/points`, { points, reason });
+    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}/activity?${params.toString()}`);
   }
   /**
-   * Add a segment to a user
+   * Add points to a user by external ID
    */
-  async addSegment(userId, segment) {
-    return this.http.post(`/end-users/${userId}/segments`, { segment });
-  }
-  /**
-   * Remove a segment from a user
-   */
-  async removeSegment(userId, segment) {
-    return this.http.delete(`/end-users/${userId}/segments/${encodeURIComponent(segment)}`);
+  async addPoints(externalId, points, reason) {
+    const params = new URLSearchParams();
+    params.append("points", points.toString());
+    if (reason) params.append("reason", reason);
+    return this.http.post(`/end-users/by-external/${encodeURIComponent(externalId)}/add-points?${params.toString()}`, {});
   }
   /**
    * Merge two users (moves all data from source to target)
@@ -1224,10 +1209,10 @@ var EndUsersClient = class {
     return this.http.post("/end-users/merge", request);
   }
   /**
-   * Update user attributes (convenience method)
+   * Update user attributes (convenience method) by external ID
    */
-  async updateAttributes(userId, attributes) {
-    return this.http.patch(`/end-users/${userId}`, { attributes });
+  async updateAttributes(externalId, attributes) {
+    return this.http.patch(`/end-users/by-external/${encodeURIComponent(externalId)}`, { attributes });
   }
   /**
    * Export users as CSV
@@ -1815,6 +1800,7 @@ var CohortLeaderboardClient = class {
     if (options.limit) params.limit = options.limit;
     if (options.top_n) params.top_n = options.top_n;
     if (options.fresh) params.fresh = "true";
+    if (options.userId) params.user_id = options.userId;
     return this.http.get(
       `/cohorts/definitions/${encodeURIComponent(cohortId)}/leaderboard`,
       params
@@ -1852,6 +1838,7 @@ var FanpassLeaderboardClient = class {
     if (options.limit) params.limit = options.limit;
     if (options.top_n) params.top_n = options.top_n;
     if (options.fresh) params.fresh = "true";
+    if (options.userId) params.user_id = options.userId;
     return this.http.get(
       "/passport-v2/fanpass/leaderboard",
       params

package/dist/index.mjs

@@ -1094,16 +1094,16 @@ var EndUsersClient = class {
     return this.http.get(`/end-users?${params.toString()}`);
   }
   /**
-   * Get an end-user by ID
+   * Get an end-user by external ID
    */
-  async get(userId) {
-    return this.http.get(`/end-users/${userId}`);
+  async get(externalId) {
+    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}`);
   }
   /**
-   * Get an end-user by external ID
+   * Get an end-user by internal UUID (admin use)
    */
-  async getByExternalId(externalId) {
-    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}`);
+  async getByInternalId(userId) {
+    return this.http.get(`/end-users/${userId}`);
   }
   /**
    * Create an end-user manually
@@ -1112,10 +1112,10 @@ var EndUsersClient = class {
     return this.http.post("/end-users", data);
   }
   /**
-   * Update an end-user profile
+   * Update an end-user profile by external ID
    */
-  async update(userId, data) {
-    return this.http.patch(`/end-users/${userId}`, data);
+  async update(externalId, data) {
+    return this.http.patch(`/end-users/by-external/${encodeURIComponent(externalId)}`, data);
   }
   /**
    * Delete an end-user
@@ -1124,44 +1124,29 @@ var EndUsersClient = class {
     await this.http.delete(`/end-users/${userId}`);
   }
   /**
-   * Link a wallet to an end-user
+   * Link a wallet to an end-user by external ID
    */
-  async linkWallet(userId, request) {
-    return this.http.post(`/end-users/${userId}/wallet`, request);
+  async linkWallet(externalId, request) {
+    return this.http.post(`/end-users/by-external/${encodeURIComponent(externalId)}/link-wallet`, request);
   }
   /**
-   * Unlink wallet from an end-user
+   * Get user activity/events by external ID
    */
-  async unlinkWallet(userId) {
-    return this.http.delete(`/end-users/${userId}/wallet`);
-  }
-  /**
-   * Get user activity/events
-   */
-  async getActivity(userId, options = {}) {
+  async getActivity(externalId, options = {}) {
     const params = new URLSearchParams();
     if (options.page) params.append("page", options.page.toString());
     if (options.page_size) params.append("page_size", options.page_size.toString());
     if (options.event_type) params.append("event_type", options.event_type);
-    return this.http.get(`/end-users/${userId}/activity?${params.toString()}`);
-  }
-  /**
-   * Add points to a user
-   */
-  async addPoints(userId, points, reason) {
-    return this.http.post(`/end-users/${userId}/points`, { points, reason });
+    return this.http.get(`/end-users/by-external/${encodeURIComponent(externalId)}/activity?${params.toString()}`);
   }
   /**
-   * Add a segment to a user
+   * Add points to a user by external ID
    */
-  async addSegment(userId, segment) {
-    return this.http.post(`/end-users/${userId}/segments`, { segment });
-  }
-  /**
-   * Remove a segment from a user
-   */
-  async removeSegment(userId, segment) {
-    return this.http.delete(`/end-users/${userId}/segments/${encodeURIComponent(segment)}`);
+  async addPoints(externalId, points, reason) {
+    const params = new URLSearchParams();
+    params.append("points", points.toString());
+    if (reason) params.append("reason", reason);
+    return this.http.post(`/end-users/by-external/${encodeURIComponent(externalId)}/add-points?${params.toString()}`, {});
   }
   /**
    * Merge two users (moves all data from source to target)
@@ -1170,10 +1155,10 @@ var EndUsersClient = class {
     return this.http.post("/end-users/merge", request);
   }
   /**
-   * Update user attributes (convenience method)
+   * Update user attributes (convenience method) by external ID
    */
-  async updateAttributes(userId, attributes) {
-    return this.http.patch(`/end-users/${userId}`, { attributes });
+  async updateAttributes(externalId, attributes) {
+    return this.http.patch(`/end-users/by-external/${encodeURIComponent(externalId)}`, { attributes });
   }
   /**
    * Export users as CSV
@@ -1761,6 +1746,7 @@ var CohortLeaderboardClient = class {
     if (options.limit) params.limit = options.limit;
     if (options.top_n) params.top_n = options.top_n;
     if (options.fresh) params.fresh = "true";
+    if (options.userId) params.user_id = options.userId;
     return this.http.get(
       `/cohorts/definitions/${encodeURIComponent(cohortId)}/leaderboard`,
       params
@@ -1798,6 +1784,7 @@ var FanpassLeaderboardClient = class {
     if (options.limit) params.limit = options.limit;
     if (options.top_n) params.top_n = options.top_n;
     if (options.fresh) params.fresh = "true";
+    if (options.userId) params.user_id = options.userId;
     return this.http.get(
       "/passport-v2/fanpass/leaderboard",
       params

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proofchain/sdk",
-  "version": "2.5.2",
+  "version": "2.7.0",
   "description": "Official JavaScript/TypeScript SDK for ProofChain - blockchain-anchored document attestation",
   "main": "dist/index.js",
   "module": "dist/index.mjs",