@whop/sdk 0.0.25 → 0.0.27

package/src/resources/shipments.ts

@@ -79,7 +79,7 @@ export type ShipmentListResponsesCursorPage = CursorPage<ShipmentListResponse>;
  */
 export interface ShipmentListResponse {
   /**
-   * The ID of the shipment
+   * The unique identifier for the shipment.
    */
   id: string;
 
@@ -89,7 +89,7 @@ export interface ShipmentListResponse {
   carrier: Shared.ShipmentCarrier;
 
   /**
-   * The date and time the shipment was created
+   * The datetime the shipment was created.
    */
   created_at: string;
 
@@ -124,7 +124,7 @@ export interface ShipmentListResponse {
   tracking_code: string;
 
   /**
-   * The date and time the shipment was last updated
+   * The datetime the shipment was last updated.
    */
   updated_at: string;
 }
@@ -135,7 +135,7 @@ export namespace ShipmentListResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }

package/src/resources/support-channels.ts

@@ -116,7 +116,7 @@ export namespace SupportChannelListResponse {
    */
   export interface CustomerUser {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/topups.ts

@@ -29,16 +29,17 @@ export class Topups extends APIResource {
 }
 
 /**
- * An object representing a receipt for a membership.
+ * A payment represents a completed or attempted charge for a membership. Payments
+ * track the amount, status, currency, and payment method used.
  */
 export interface TopupCreateResponse {
   /**
-   * The payment ID
+   * The unique identifier for the payment.
    */
   id: string;
 
   /**
-   * The datetime the payment was created
+   * The datetime the payment was created.
    */
   created_at: string;
 
@@ -70,7 +71,8 @@ export interface TopupCreateResponse {
 
 export interface TopupCreateParams {
   /**
-   * The amount to add to the balance.
+   * The amount to add to the balance. Provided as a number in the specified
+   * currency. Eg: 50.00 for $50.00 USD.
    */
   amount: number;
 

package/src/resources/transfers.ts

@@ -77,17 +77,18 @@ export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
  */
 export interface TransferListResponse {
   /**
-   * The unique identifier of the credit transaction transfer
+   * The unique identifier for the credit transaction transfer.
    */
   id: string;
 
   /**
-   * The amount of the credit transaction transfer
+   * The amount of the transfer. Provided as a number in the specified currency. Eg:
+   * 10.43 for $10.43 USD.
    */
   amount: number;
 
   /**
-   * The timestamp when the credit transaction transfer was created
+   * The datetime the credit transaction transfer was created.
    */
   created_at: string;
 
@@ -107,7 +108,8 @@ export interface TransferListResponse {
   fee_amount: number | null;
 
   /**
-   * A hash of metadata attached to the transfer
+   * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
+   * 5000 chars per value.
    */
   metadata: { [key: string]: unknown } | null;
 
@@ -124,7 +126,8 @@ export interface TransferListResponse {
 
 export interface TransferCreateParams {
   /**
-   * The amount to withdraw
+   * The amount to transfer. Provided as a number in the specified currency. Eg:
+   * 25.00 for $25.00 USD.
    */
   amount: number;
 

package/src/resources/users.ts

@@ -10,7 +10,7 @@ export class Users extends APIResource {
   /**
    * Retrieves a user by ID or username
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
     return this._client.get(path`/users/${id}`, options);
   }
 
@@ -25,14 +25,29 @@ export class Users extends APIResource {
     const { id } = params;
     return this._client.get(path`/users/${id}/access/${resourceID}`, options);
   }
+
+  /**
+   * Updates the current 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;
 
@@ -42,7 +57,7 @@ export interface UserRetrieveResponse {
   bio: string | null;
 
   /**
-   * When the user was created.
+   * The datetime the user was created.
    */
   created_at: string;
 
@@ -54,7 +69,7 @@ export interface UserRetrieveResponse {
   /**
    * The user's profile picture
    */
-  profile_picture: UserRetrieveResponse.ProfilePicture | null;
+  profile_picture: User.ProfilePicture | null;
 
   /**
    * The username of the user from their Whop account.
@@ -62,7 +77,7 @@ export interface UserRetrieveResponse {
   username: string;
 }
 
-export namespace UserRetrieveResponse {
+export namespace User {
   /**
    * The user's profile picture
    */
@@ -97,10 +112,45 @@ export interface UserCheckAccessParams {
   id: string;
 }
 
+export interface UserUpdateProfileParams {
+  /**
+   * User biography
+   */
+  bio?: string | null;
+
+  /**
+   * Display name
+   */
+  name?: string | null;
+
+  /**
+   * Profile picture
+   */
+  profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
+
+  /**
+   * Username (alphanumeric and hyphens)
+   */
+  username?: string | null;
+}
+
+export namespace UserUpdateProfileParams {
+  /**
+   * Profile picture
+   */
+  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

@@ -18,39 +18,61 @@ export class Verifications extends APIResource {
   }
 }
 
+/**
+ * An error code for a verification attempt.
+ */
+export type VerificationErrorCode =
+  | 'abandoned'
+  | 'consent_declined'
+  | 'country_not_supported'
+  | 'device_not_supported'
+  | 'document_expired'
+  | 'document_type_not_supported'
+  | 'document_unverified_other'
+  | 'email_unverified_other'
+  | 'email_verification_declined'
+  | 'id_number_insufficient_document_data'
+  | 'id_number_mismatch'
+  | 'id_number_unverified_other'
+  | 'phone_unverified_other'
+  | 'phone_verification_declined'
+  | 'selfie_document_missing_photo'
+  | 'selfie_face_mismatch'
+  | 'selfie_manipulated'
+  | 'selfie_unverified_other'
+  | 'under_supported_age';
+
+/**
+ * A status for a verification.
+ */
+export type VerificationStatus =
+  | 'requires_input'
+  | 'processing'
+  | 'verified'
+  | 'canceled'
+  | 'created'
+  | 'started'
+  | 'submitted'
+  | 'approved'
+  | 'declined'
+  | 'resubmission_requested'
+  | 'expired'
+  | 'abandoned'
+  | 'review';
+
 /**
  * An object representing an identity verification session
  */
 export interface VerificationRetrieveResponse {
   /**
-   * A unique identifier for the verification.
+   * The unique identifier for the verification.
    */
   id: string;
 
   /**
    * An error code for a verification attempt.
    */
-  last_error_code:
-    | 'abandoned'
-    | 'consent_declined'
-    | 'country_not_supported'
-    | 'device_not_supported'
-    | 'document_expired'
-    | 'document_type_not_supported'
-    | 'document_unverified_other'
-    | 'email_unverified_other'
-    | 'email_verification_declined'
-    | 'id_number_insufficient_document_data'
-    | 'id_number_mismatch'
-    | 'id_number_unverified_other'
-    | 'phone_unverified_other'
-    | 'phone_verification_declined'
-    | 'selfie_document_missing_photo'
-    | 'selfie_face_mismatch'
-    | 'selfie_manipulated'
-    | 'selfie_unverified_other'
-    | 'under_supported_age'
-    | null;
+  last_error_code: VerificationErrorCode | null;
 
   /**
    * The last error reason that occurred during the verification.
@@ -60,22 +82,13 @@ export interface VerificationRetrieveResponse {
   /**
    * The status of the verification.
    */
-  status:
-    | 'requires_input'
-    | 'processing'
-    | 'verified'
-    | 'canceled'
-    | 'created'
-    | 'started'
-    | 'submitted'
-    | 'approved'
-    | 'declined'
-    | 'resubmission_requested'
-    | 'expired'
-    | 'abandoned'
-    | 'review';
+  status: VerificationStatus;
 }
 
 export declare namespace Verifications {
-  export { type VerificationRetrieveResponse as VerificationRetrieveResponse };
+  export {
+    type VerificationErrorCode as VerificationErrorCode,
+    type VerificationStatus as VerificationStatus,
+    type VerificationRetrieveResponse as VerificationRetrieveResponse,
+  };
 }