@whop/sdk 0.0.26 → 0.0.28

package/src/resources/users.ts

@@ -8,14 +8,15 @@ import { path } from '../internal/utils/path';
 
 export class Users extends APIResource {
   /**
-   * Retrieves a user by ID or username
+   * Retrieves the details of an existing user.
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
     return this._client.get(path`/users/${id}`, options);
   }
 
   /**
-   * Check if a user has access (and their access level) to a resource
+   * Check whether a user has access to a specific resource, and return their access
+   * level.
    */
   checkAccess(
     resourceID: string,
@@ -25,51 +26,68 @@ export class Users extends APIResource {
     const { id } = params;
     return this._client.get(path`/users/${id}/access/${resourceID}`, options);
   }
+
+  /**
+   * Update the currently authenticated user's profile.
+   *
+   * Required permissions:
+   *
+   * - `user:profile:update`
+   */
+  updateProfile(
+    body: UserUpdateProfileParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<User> {
+    return this._client.patch('/users/me', { body, ...options });
+  }
 }
 
 /**
- * An object representing a (sanitized) user of the site.
+ * A user account on Whop. Contains profile information, identity details, and
+ * social connections.
  */
-export interface UserRetrieveResponse {
+export interface User {
   /**
-   * The internal ID of the user.
+   * The unique identifier for the user.
    */
   id: string;
 
   /**
-   * The user's bio
+   * A short biography written by the user, displayed on their public profile.
    */
   bio: string | null;
 
   /**
-   * When the user was created.
+   * The datetime the user was created.
    */
   created_at: string;
 
   /**
-   * The name of the user from their Whop account.
+   * The user's display name shown on their public profile.
    */
   name: string | null;
 
   /**
-   * The user's profile picture
+   * The user's profile picture attachment with URL, content type, and file metadata.
+   * Null if using a legacy profile picture.
    */
-  profile_picture: UserRetrieveResponse.ProfilePicture | null;
+  profile_picture: User.ProfilePicture | null;
 
   /**
-   * The username of the user from their Whop account.
+   * The user's unique username shown on their public profile.
    */
   username: string;
 }
 
-export namespace UserRetrieveResponse {
+export namespace User {
   /**
-   * The user's profile picture
+   * The user's profile picture attachment with URL, content type, and file metadata.
+   * Null if using a legacy profile picture.
    */
   export interface ProfilePicture {
     /**
-     * This is the URL you use to render optimized attachments on the client. This
-     * should be used for apps.
+     * A pre-optimized URL for rendering this attachment on the client. This should be
+     * used for displaying attachments in apps.
      */
     url: string | null;
   }
@@ -92,15 +110,51 @@ export interface UserCheckAccessResponse {
 
 export interface UserCheckAccessParams {
   /**
-   * The ID (user_xxx) or username of the user
+   * The unique identifier or username of the user.
    */
   id: string;
 }
 
+export interface UserUpdateProfileParams {
+  /**
+   * A short biography displayed on the user's public profile.
+   */
+  bio?: string | null;
+
+  /**
+   * The user's display name shown on their public profile. Maximum 100 characters.
+   */
+  name?: string | null;
+
+  /**
+   * The user's profile picture image attachment.
+   */
+  profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
+
+  /**
+   * The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
+   * characters.
+   */
+  username?: string | null;
+}
+
+export namespace UserUpdateProfileParams {
+  /**
+   * The user's profile picture image attachment.
+   */
+  export interface ProfilePicture {
+    /**
+     * The ID of an existing file object.
+     */
+    id: string;
+  }
+}
+
 export declare namespace Users {
   export {
-    type UserRetrieveResponse as UserRetrieveResponse,
+    type User as User,
     type UserCheckAccessResponse as UserCheckAccessResponse,
     type UserCheckAccessParams as UserCheckAccessParams,
+    type UserUpdateProfileParams as UserUpdateProfileParams,
   };
 }

package/src/resources/verifications.ts

@@ -7,7 +7,7 @@ import { path } from '../internal/utils/path';
 
 export class Verifications extends APIResource {
   /**
-   * Retrieves a verification by ID
+   * Retrieves the details of an existing verification.
    *
    * Required permissions:
    *
@@ -61,11 +61,12 @@ export type VerificationStatus =
   | 'review';
 
 /**
- * An object representing an identity verification session
+ * An identity verification session used to confirm a person or entity's identity
+ * for payout account eligibility.
  */
 export interface VerificationRetrieveResponse {
   /**
-   * A unique identifier for the verification.
+   * The unique identifier for the verification.
    */
   id: string;
 
@@ -75,12 +76,13 @@ export interface VerificationRetrieveResponse {
   last_error_code: VerificationErrorCode | null;
 
   /**
-   * The last error reason that occurred during the verification.
+   * A human-readable explanation of the most recent verification error. Null if no
+   * error has occurred.
    */
   last_error_reason: string | null;
 
   /**
-   * The status of the verification.
+   * The current status of this verification session.
    */
   status: VerificationStatus;
 }