@whop/sdk 0.0.37 → 0.0.39

package/resources/users.d.mts

@@ -9,26 +9,56 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Users extends APIResource {
     /**
      * Retrieves the details of an existing user.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.retrieve(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<User>;
+    /**
+     * Update a user's profile by their ID.
+     *
+     * Required permissions:
+     *
+     * - `user:profile:update`
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.update(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<User>;
+    update(id: string, body?: UserUpdateParams | null | undefined, options?: RequestOptions): APIPromise<User>;
     /**
      * 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, options?: RequestOptions): PagePromise<UserListResponsesCursorPage, UserListResponse>;
     /**
      * Check whether a user has access to a specific resource, and return their access
      * level.
-     */
-    checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
-    /**
-     * Update the currently authenticated user's profile.
      *
-     * Required permissions:
-     *
-     * - `user:profile:update`
+     * @example
+     * ```ts
+     * const response = await client.users.checkAccess(
+     *   'resource_id',
+     *   { id: 'user_xxxxxxxxxxxxx' },
+     * );
+     * ```
      */
-    updateProfile(body?: UserUpdateProfileParams | null | undefined, options?: RequestOptions): APIPromise<User>;
+    checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
 }
 export type UserListResponsesCursorPage = CursorPage<UserListResponse>;
 /**
@@ -132,35 +162,24 @@ 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;
-    /**
-     * Returns the last _n_ elements from the list.
-     */
-    last?: number | null;
+export interface UserRetrieveParams {
     /**
-     * Search term to filter by name or username.
+     * When provided, returns the user's company-specific profile overrides (name,
+     * profile picture) instead of their global profile.
      */
-    query?: string | null;
+    company_id?: string | null;
 }
-export interface UserCheckAccessParams {
-    /**
-     * The unique identifier or username of the user.
-     */
-    id: string;
-}
-export interface UserUpdateProfileParams {
+export interface UserUpdateParams {
     /**
      * A short biography displayed on the user's public profile.
      */
     bio?: string | null;
+    /**
+     * 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.
+     */
+    company_id?: string | null;
     /**
      * The user's display name shown on their public profile. Maximum 100 characters.
      */
@@ -168,14 +187,14 @@ 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
      * characters.
      */
     username?: string | null;
 }
-export declare namespace UserUpdateProfileParams {
+export declare namespace UserUpdateParams {
     /**
      * The user's profile picture image attachment.
      */
@@ -186,7 +205,31 @@ export declare namespace UserUpdateProfileParams {
         id: string;
     }
 }
+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 UserListParams as UserListParams, type UserCheckAccessParams as UserCheckAccessParams, type UserUpdateProfileParams as UserUpdateProfileParams, };
+    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, };
 }
 //# sourceMappingURL=users.d.mts.map

package/resources/users.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;OAGG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;OAMG;IACH,aAAa,CACX,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAGpB;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;;OAWG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/users.d.ts

@@ -9,26 +9,56 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class Users extends APIResource {
     /**
      * Retrieves the details of an existing user.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.retrieve(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<User>;
+    /**
+     * Update a user's profile by their ID.
+     *
+     * Required permissions:
+     *
+     * - `user:profile:update`
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.update(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<User>;
+    update(id: string, body?: UserUpdateParams | null | undefined, options?: RequestOptions): APIPromise<User>;
     /**
      * 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, options?: RequestOptions): PagePromise<UserListResponsesCursorPage, UserListResponse>;
     /**
      * Check whether a user has access to a specific resource, and return their access
      * level.
-     */
-    checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
-    /**
-     * Update the currently authenticated user's profile.
      *
-     * Required permissions:
-     *
-     * - `user:profile:update`
+     * @example
+     * ```ts
+     * const response = await client.users.checkAccess(
+     *   'resource_id',
+     *   { id: 'user_xxxxxxxxxxxxx' },
+     * );
+     * ```
      */
-    updateProfile(body?: UserUpdateProfileParams | null | undefined, options?: RequestOptions): APIPromise<User>;
+    checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
 }
 export type UserListResponsesCursorPage = CursorPage<UserListResponse>;
 /**
@@ -132,35 +162,24 @@ 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;
-    /**
-     * Returns the last _n_ elements from the list.
-     */
-    last?: number | null;
+export interface UserRetrieveParams {
     /**
-     * Search term to filter by name or username.
+     * When provided, returns the user's company-specific profile overrides (name,
+     * profile picture) instead of their global profile.
      */
-    query?: string | null;
+    company_id?: string | null;
 }
-export interface UserCheckAccessParams {
-    /**
-     * The unique identifier or username of the user.
-     */
-    id: string;
-}
-export interface UserUpdateProfileParams {
+export interface UserUpdateParams {
     /**
      * A short biography displayed on the user's public profile.
      */
     bio?: string | null;
+    /**
+     * 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.
+     */
+    company_id?: string | null;
     /**
      * The user's display name shown on their public profile. Maximum 100 characters.
      */
@@ -168,14 +187,14 @@ 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
      * characters.
      */
     username?: string | null;
 }
-export declare namespace UserUpdateProfileParams {
+export declare namespace UserUpdateParams {
     /**
      * The user's profile picture image attachment.
      */
@@ -186,7 +205,31 @@ export declare namespace UserUpdateProfileParams {
         id: string;
     }
 }
+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 UserListParams as UserListParams, type UserCheckAccessParams as UserCheckAccessParams, type UserUpdateProfileParams as UserUpdateProfileParams, };
+    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, };
 }
 //# sourceMappingURL=users.d.ts.map

package/resources/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;OAGG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;OAMG;IACH,aAAa,CACX,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAGpB;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;;OAWG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/users.js

@@ -11,13 +11,45 @@ const path_1 = require("../internal/utils/path.js");
 class Users extends resource_1.APIResource {
     /**
      * Retrieves the details of an existing user.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.retrieve(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.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',
+     * );
+     * ```
      */
-    retrieve(id, options) {
-        return this._client.get((0, path_1.path) `/users/${id}`, options);
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.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 = {}, options) {
         return this._client.getAPIList('/users', (pagination_1.CursorPage), { query, ...options });
@@ -25,21 +57,19 @@ class Users extends resource_1.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, params, options) {
         const { id } = params;
         return this._client.get((0, path_1.path) `/users/${id}/access/${resourceID}`, options);
     }
-    /**
-     * Update the currently authenticated user's profile.
-     *
-     * Required permissions:
-     *
-     * - `user:profile:update`
-     */
-    updateProfile(body = {}, options) {
-        return this._client.patch('/users/me', { body, ...options });
-    }
 }
 exports.Users = Users;
 //# sourceMappingURL=users.js.map

package/resources/users.js.map

@@ -1 +1 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,WAAW,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CACX,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AA7CD,sBA6CC"}
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,WAAW,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AAhFD,sBAgFC"}

package/resources/users.mjs

@@ -8,13 +8,45 @@ import { path } from "../internal/utils/path.mjs";
 export class Users extends APIResource {
     /**
      * Retrieves the details of an existing user.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.retrieve(
+     *   'user_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        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',
+     * );
+     * ```
      */
-    retrieve(id, options) {
-        return this._client.get(path `/users/${id}`, options);
+    update(id, body = {}, options) {
+        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 = {}, options) {
         return this._client.getAPIList('/users', (CursorPage), { query, ...options });
@@ -22,20 +54,18 @@ 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, params, options) {
         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 = {}, options) {
-        return this._client.patch('/users/me', { body, ...options });
-    }
 }
 //# sourceMappingURL=users.mjs.map

package/resources/users.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,WAAW,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CACX,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF"}
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,WAAW,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/resources/verifications.d.mts

@@ -32,7 +32,7 @@ export type VerificationErrorCode = 'abandoned' | 'consent_declined' | 'country_
 /**
  * A status for a verification.
  */
-export type VerificationStatus = 'requires_input' | 'processing' | 'verified' | 'canceled' | 'created' | 'started' | 'submitted' | 'approved' | 'declined' | 'resubmission_requested' | 'expired' | 'abandoned' | 'review';
+export type VerificationStatus = 'requires_input' | 'processing' | 'verified' | 'canceled' | 'created' | 'started' | 'submitted' | 'approved' | 'declined' | 'resubmission_requested' | 'expired' | 'abandoned' | 'review' | 'action_required';
 /**
  * An identity verification session used to confirm a person or entity's identity
  * for payout account eligibility.

package/resources/verifications.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"verifications.d.mts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,kBAAkB,GAClB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,6BAA6B,GAC7B,2BAA2B,GAC3B,wBAAwB,GACxB,6BAA6B,GAC7B,sCAAsC,GACtC,oBAAoB,GACpB,4BAA4B,GAC5B,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,sBAAsB,GACtB,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,YAAY,GACZ,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,wBAAwB,GACxB,SAAS,GACT,WAAW,GACX,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"verifications.d.mts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,kBAAkB,GAClB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,6BAA6B,GAC7B,2BAA2B,GAC3B,wBAAwB,GACxB,6BAA6B,GAC7B,sCAAsC,GACtC,oBAAoB,GACpB,4BAA4B,GAC5B,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,sBAAsB,GACtB,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,YAAY,GACZ,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,wBAAwB,GACxB,SAAS,GACT,WAAW,GACX,QAAQ,GACR,iBAAiB,CAAC;AAEtB;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/verifications.d.ts

@@ -32,7 +32,7 @@ export type VerificationErrorCode = 'abandoned' | 'consent_declined' | 'country_
 /**
  * A status for a verification.
  */
-export type VerificationStatus = 'requires_input' | 'processing' | 'verified' | 'canceled' | 'created' | 'started' | 'submitted' | 'approved' | 'declined' | 'resubmission_requested' | 'expired' | 'abandoned' | 'review';
+export type VerificationStatus = 'requires_input' | 'processing' | 'verified' | 'canceled' | 'created' | 'started' | 'submitted' | 'approved' | 'declined' | 'resubmission_requested' | 'expired' | 'abandoned' | 'review' | 'action_required';
 /**
  * An identity verification session used to confirm a person or entity's identity
  * for payout account eligibility.

package/resources/verifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"verifications.d.ts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,kBAAkB,GAClB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,6BAA6B,GAC7B,2BAA2B,GAC3B,wBAAwB,GACxB,6BAA6B,GAC7B,sCAAsC,GACtC,oBAAoB,GACpB,4BAA4B,GAC5B,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,sBAAsB,GACtB,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,YAAY,GACZ,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,wBAAwB,GACxB,SAAS,GACT,WAAW,GACX,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"verifications.d.ts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,kBAAkB,GAClB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,6BAA6B,GAC7B,2BAA2B,GAC3B,wBAAwB,GACxB,6BAA6B,GAC7B,sCAAsC,GACtC,oBAAoB,GACpB,4BAA4B,GAC5B,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,sBAAsB,GACtB,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,YAAY,GACZ,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,wBAAwB,GACxB,SAAS,GACT,WAAW,GACX,QAAQ,GACR,iBAAiB,CAAC;AAEtB;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/src/client.ts

@@ -428,7 +428,8 @@ import {
   UserListParams,
   UserListResponse,
   UserListResponsesCursorPage,
-  UserUpdateProfileParams,
+  UserRetrieveParams,
+  UserUpdateParams,
   Users,
 } from './resources/users';
 import {
@@ -539,6 +540,19 @@ export interface ClientOptions {
    */
   appID?: string | null | undefined;
 
+  /**
+   * Static JWK (JSON string) used by `verifyUserToken` to verify user tokens.
+   * When set, the SDK skips remote JWKS fetching. Prefer `userTokenJwksUrl`
+   * (or the default) so key rotation is handled automatically.
+   */
+  userTokenPublicKey?: string | null | undefined;
+
+  /**
+   * URL of the JWKS endpoint used by `verifyUserToken`. Defaults to the
+   * canonical Whop JWKS. Override when pointing at a non-production backend.
+   */
+  userTokenJwksUrl?: string | null | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -615,6 +629,8 @@ export class Whop {
   apiKey: string;
   webhookKey: string | null;
   appID: string | null;
+  userTokenPublicKey: string | null;
+  userTokenJwksUrl: string | null;
   baseURL: string;
   maxRetries: number;
   timeout: number;
@@ -646,6 +662,8 @@ export class Whop {
     apiKey = readEnv('WHOP_API_KEY'),
     webhookKey = readEnv('WHOP_WEBHOOK_SECRET') ?? null,
     appID = readEnv('WHOP_APP_ID') ?? null,
+    userTokenPublicKey = readEnv('WHOP_USER_TOKEN_PUBLIC_KEY') ?? null,
+    userTokenJwksUrl = readEnv('WHOP_USER_TOKEN_JWKS_URL') ?? null,
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
@@ -658,6 +676,8 @@ export class Whop {
       apiKey,
       webhookKey,
       appID,
+      userTokenPublicKey,
+      userTokenJwksUrl,
       ...opts,
       baseURL: baseURL || `https://api.whop.com/api/v1`,
     };
@@ -682,6 +702,8 @@ export class Whop {
     this.apiKey = apiKey;
     this.webhookKey = webhookKey;
     this.appID = appID;
+    this.userTokenPublicKey = userTokenPublicKey;
+    this.userTokenJwksUrl = userTokenJwksUrl;
   }
 
   /**
@@ -700,6 +722,8 @@ export class Whop {
       apiKey: this.apiKey,
       webhookKey: this.webhookKey,
       appID: this.appID,
+      userTokenPublicKey: this.userTokenPublicKey,
+      userTokenJwksUrl: this.userTokenJwksUrl,
       ...options,
     });
     return client;
@@ -1737,9 +1761,10 @@ export declare namespace Whop {
     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,
   };
 
   export {