@whop/sdk 0.0.37 → 0.0.39

package/src/resources/users.ts

@@ -13,14 +13,55 @@ import { path } from '../internal/utils/path';
 export class Users extends APIResource {
   /**
    * Retrieves the details of an existing user.
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.retrieve(
+   *   'user_xxxxxxxxxxxxx',
+   * );
+   * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
-    return this._client.get(path`/users/${id}`, options);
+  retrieve(
+    id: string,
+    query: UserRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<User> {
+    return this._client.get(path`/users/${id}`, { query, ...options });
+  }
+
+  /**
+   * Update a user's profile by their ID.
+   *
+   * Required permissions:
+   *
+   * - `user:profile:update`
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.update(
+   *   'user_xxxxxxxxxxxxx',
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    body: UserUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<User> {
+    return this._client.patch(path`/users/${id}`, { body, ...options });
   }
 
   /**
    * Search for users by name or username, ranked by social proximity to the
    * authenticated user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const userListResponse of client.users.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: UserListParams | null | undefined = {},
@@ -32,6 +73,14 @@ export class Users extends APIResource {
   /**
    * Check whether a user has access to a specific resource, and return their access
    * level.
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.checkAccess(
+   *   'resource_id',
+   *   { id: 'user_xxxxxxxxxxxxx' },
+   * );
+   * ```
    */
   checkAccess(
     resourceID: string,
@@ -41,20 +90,6 @@ 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 });
-  }
 }
 
 export type UserListResponsesCursorPage = CursorPage<UserListResponse>;
@@ -176,40 +211,26 @@ export interface UserCheckAccessResponse {
   has_access: boolean;
 }
 
-export interface UserListParams extends CursorPageParams {
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
+export interface UserRetrieveParams {
   /**
-   * Returns the last _n_ elements from the list.
+   * When provided, returns the user's company-specific profile overrides (name,
+   * profile picture) instead of their global profile.
    */
-  last?: number | null;
-
-  /**
-   * Search term to filter by name or username.
-   */
-  query?: string | null;
+  company_id?: string | null;
 }
 
-export interface UserCheckAccessParams {
+export interface UserUpdateParams {
   /**
-   * The unique identifier or username of the user.
+   * A short biography displayed on the user's public profile.
    */
-  id: string;
-}
+  bio?: string | null;
 
-export interface UserUpdateProfileParams {
   /**
-   * A short biography displayed on the user's public profile.
+   * When provided, updates the user's profile overrides for this company instead of
+   * the global profile. Pass name and profile_picture to set overrides, or null to
+   * clear them.
    */
-  bio?: string | null;
+  company_id?: string | null;
 
   /**
    * The user's display name shown on their public profile. Maximum 100 characters.
@@ -219,7 +240,7 @@ export interface UserUpdateProfileParams {
   /**
    * The user's profile picture image attachment.
    */
-  profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
+  profile_picture?: UserUpdateParams.ProfilePicture | null;
 
   /**
    * The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
@@ -228,7 +249,7 @@ export interface UserUpdateProfileParams {
   username?: string | null;
 }
 
-export namespace UserUpdateProfileParams {
+export namespace UserUpdateParams {
   /**
    * The user's profile picture image attachment.
    */
@@ -240,14 +261,44 @@ export namespace UserUpdateProfileParams {
   }
 }
 
+export interface UserListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * Search term to filter by name or username.
+   */
+  query?: string | null;
+}
+
+export interface UserCheckAccessParams {
+  /**
+   * The unique identifier or username of the user.
+   */
+  id: string;
+}
+
 export declare namespace Users {
   export {
     type User as User,
     type UserListResponse as UserListResponse,
     type UserCheckAccessResponse as UserCheckAccessResponse,
     type UserListResponsesCursorPage as UserListResponsesCursorPage,
+    type UserRetrieveParams as UserRetrieveParams,
+    type UserUpdateParams as UserUpdateParams,
     type UserListParams as UserListParams,
     type UserCheckAccessParams as UserCheckAccessParams,
-    type UserUpdateProfileParams as UserUpdateProfileParams,
   };
 }

package/src/resources/verifications.ts

@@ -82,7 +82,8 @@ export type VerificationStatus =
   | 'resubmission_requested'
   | 'expired'
   | 'abandoned'
-  | 'review';
+  | 'review'
+  | 'action_required';
 
 /**
  * An identity verification session used to confirm a person or entity's identity

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.37'; // x-release-please-version
+export const VERSION = '0.0.39'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.37";
+export declare const VERSION = "0.0.39";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.37";
+export declare const VERSION = "0.0.39";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.37'; // x-release-please-version
+exports.VERSION = '0.0.39'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.37'; // x-release-please-version
+export const VERSION = '0.0.39'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map