@whop/sdk 0.0.27 → 0.0.28

package/src/resources/shipments.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class Shipments extends APIResource {
   /**
-   * Creates a new shipment
+   * Create a new shipment with a tracking code for a specific payment within a
+   * company.
    *
    * Required permissions:
    *
@@ -30,7 +31,7 @@ export class Shipments extends APIResource {
   }
 
   /**
-   * Retrieves a shipment by ID
+   * Retrieves the details of an existing shipment.
    *
    * Required permissions:
    *
@@ -49,7 +50,8 @@ export class Shipments extends APIResource {
   }
 
   /**
-   * Lists shipments for a payment
+   * Returns a paginated list of shipments, with optional filtering by payment,
+   * company, or user.
    *
    * Required permissions:
    *
@@ -75,7 +77,8 @@ export class Shipments extends APIResource {
 export type ShipmentListResponsesCursorPage = CursorPage<ShipmentListResponse>;
 
 /**
- * A shipment
+ * A physical shipment associated with a payment, including carrier details and
+ * tracking information.
  */
 export interface ShipmentListResponse {
   /**
@@ -84,7 +87,7 @@ export interface ShipmentListResponse {
   id: string;
 
   /**
-   * The carrier of the shipment
+   * The shipping carrier responsible for delivering this shipment.
    */
   carrier: Shared.ShipmentCarrier;
 
@@ -94,22 +97,25 @@ export interface ShipmentListResponse {
   created_at: string;
 
   /**
-   * The delivery estimate of the shipment
+   * The estimated delivery date for this shipment. Null if the carrier has not
+   * provided an estimate.
    */
   delivery_estimate: string | null;
 
   /**
-   * The payment of the shipment
+   * The payment associated with this shipment. Null if the payment has been deleted
+   * or is inaccessible.
    */
   payment: ShipmentListResponse.Payment | null;
 
   /**
-   * The service of the shipment
+   * The shipping service level used for this shipment. Null if the carrier does not
+   * specify a service tier.
    */
   service: string | null;
 
   /**
-   * The status of the shipment
+   * The current delivery status of this shipment.
    */
   status: Shared.ShipmentStatus;
 
@@ -119,7 +125,7 @@ export interface ShipmentListResponse {
   substatus: Shared.ShipmentSubstatus | null;
 
   /**
-   * The tracking code of the shipment
+   * The carrier-assigned tracking number used to look up shipment progress.
    */
   tracking_code: string;
 
@@ -131,7 +137,8 @@ export interface ShipmentListResponse {
 
 export namespace ShipmentListResponse {
   /**
-   * The payment of the shipment
+   * The payment associated with this shipment. Null if the payment has been deleted
+   * or is inaccessible.
    */
   export interface Payment {
     /**
@@ -143,17 +150,19 @@ export namespace ShipmentListResponse {
 
 export interface ShipmentCreateParams {
   /**
-   * The ID of the company to create the shipment for
+   * The unique identifier of the company to create the shipment for, starting with
+   * 'biz\_'.
    */
   company_id: string;
 
   /**
-   * The ID of the payment to create the shipment for
+   * The unique identifier of the payment to associate the shipment with.
    */
   payment_id: string;
 
   /**
-   * The tracking code for the shipment
+   * The carrier tracking code for the shipment, such as a USPS, UPS, or FedEx
+   * tracking number.
    */
   tracking_code: string;
 }
@@ -165,7 +174,7 @@ export interface ShipmentListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The ID of the company
+   * Filter shipments to only those belonging to this company.
    */
   company_id?: string | null;
 
@@ -180,12 +189,12 @@ export interface ShipmentListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The ID of the payment
+   * Filter shipments to only those associated with this specific payment.
    */
   payment_id?: string | null;
 
   /**
-   * The ID of the user
+   * Filter shipments to only those for this specific user.
    */
   user_id?: string | null;
 }

package/src/resources/support-channels.ts

@@ -9,8 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class SupportChannels extends APIResource {
   /**
-   * Create a new support channel for a user in a company. If one already exists, it
-   * will return the existing one.
+   * Open a new support channel between a company team member and a customer. Returns
+   * the existing channel if one already exists for that user.
    *
    * Required permissions:
    *
@@ -29,7 +29,7 @@ export class SupportChannels extends APIResource {
   }
 
   /**
-   * Retrieves a support channel
+   * Retrieves the details of an existing support channel.
    *
    * Required permissions:
    *
@@ -46,7 +46,8 @@ export class SupportChannels extends APIResource {
   }
 
   /**
-   * Lists chat channels inside a company
+   * Returns a paginated list of support channels for a specific company, with
+   * optional filtering by resolution status and custom sorting.
    *
    * Required permissions:
    *
@@ -76,7 +77,8 @@ export class SupportChannels extends APIResource {
 export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
 
 /**
- * Represents a DM channel
+ * A messaging channel that can be a one-on-one DM, group chat, company support
+ * conversation, or platform-level direct message.
  */
 export interface SupportChannelListResponse {
   /**
@@ -85,34 +87,40 @@ export interface SupportChannelListResponse {
   id: string;
 
   /**
-   * The bot ID if this is a support chat
+   * The unique identifier of the company associated with this channel. Null if this
+   * is not a support or company-scoped conversation.
    */
   company_id: string | null;
 
   /**
-   * The custom name of the DM channel, if any
+   * A custom display name assigned to this channel by the user. Null if no custom
+   * name has been set.
    */
   custom_name: string | null;
 
   /**
-   * The customer user if this is a support chat
+   * The customer who initiated this support conversation. Null if this is not a
+   * support chat.
    */
   customer_user: SupportChannelListResponse.CustomerUser | null;
 
   /**
-   * When the last message was sent
+   * The timestamp when the most recent message was sent in this channel. Null if no
+   * messages have been sent.
    */
   last_message_at: string | null;
 
   /**
-   * When the support ticket was resolved (null if unresolved)
+   * The timestamp when the linked support ticket was marked as resolved. Null if
+   * unresolved or not a support chat.
    */
   resolved_at: string | null;
 }
 
 export namespace SupportChannelListResponse {
   /**
-   * The customer user if this is a support chat
+   * The customer who initiated this support conversation. Null if this is not a
+   * support chat.
    */
   export interface CustomerUser {
     /**
@@ -121,12 +129,12 @@ export namespace SupportChannelListResponse {
     id: string;
 
     /**
-     * The name of the user from their Whop account.
+     * The user's display name shown on their public profile.
      */
     name: string | null;
 
     /**
-     * The username of the user from their Whop account.
+     * The user's unique username shown on their public profile.
      */
     username: string;
   }
@@ -134,19 +142,20 @@ export namespace SupportChannelListResponse {
 
 export interface SupportChannelCreateParams {
   /**
-   * The ID of the company to create the support chat in
+   * The unique identifier of the company to create the support channel in.
    */
   company_id: string;
 
   /**
-   * The ID (user_xxx) or username of the user to create the support chat for
+   * The user ID (e.g. 'user_xxxxx') or username of the customer to open a support
+   * channel for.
    */
   user_id: string;
 }
 
 export interface SupportChannelListParams extends CursorPageParams {
   /**
-   * The ID of the company to list chat channels for
+   * The unique identifier of the company to list support channels for.
    */
   company_id: string;
 
@@ -171,9 +180,8 @@ export interface SupportChannelListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * Filter for tickets where customer sent the last message (needs response) AND not
-   * resolved. Set to true to only return open channels, false to only return
-   * resolved channels.
+   * Whether to filter by open or resolved support channels. Set to true to only
+   * return channels awaiting a response, or false for resolved channels.
    */
   open?: boolean | null;
 

package/src/resources/topups.ts

@@ -7,7 +7,8 @@ import { RequestOptions } from '../internal/request-options';
 
 export class Topups extends APIResource {
   /**
-   * Add funds to your platform balance by charging a stored payment method.
+   * Add funds to a company's platform balance by charging a stored payment method.
+   * Top-ups have no fees or taxes and do not count as revenue.
    *
    * Required permissions:
    *
@@ -29,8 +30,8 @@ export class Topups extends APIResource {
 }
 
 /**
- * A payment represents a completed or attempted charge for a membership. Payments
- * track the amount, status, currency, and payment method used.
+ * A payment represents a completed or attempted charge. Payments track the amount,
+ * status, currency, and payment method used.
  */
 export interface TopupCreateResponse {
   /**
@@ -54,7 +55,8 @@ export interface TopupCreateResponse {
   failure_message: string | null;
 
   /**
-   * The datetime the payment was paid
+   * The time at which this payment was successfully collected. Null if the payment
+   * has not yet succeeded. As a Unix timestamp.
    */
   paid_at: string | null;
 
@@ -71,23 +73,23 @@ export interface TopupCreateResponse {
 
 export interface TopupCreateParams {
   /**
-   * The amount to add to the balance. Provided as a number in the specified
-   * currency. Eg: 50.00 for $50.00 USD.
+   * The amount to add to the balance in the specified currency. For example, 50.00
+   * for $50.00 USD.
    */
   amount: number;
 
   /**
-   * The ID of the company to add funds to.
+   * The unique identifier of the company to add funds to, starting with 'biz\_'.
    */
   company_id: string;
 
   /**
-   * The currency of the top-up.
+   * The currency for the top-up amount, such as 'usd'.
    */
   currency: Shared.Currency;
 
   /**
-   * The ID of the payment method to charge for the top-up.
+   * The unique identifier of the stored payment method to charge for the top-up.
    */
   payment_method_id: string;
 }

package/src/resources/transfers.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class Transfers extends APIResource {
   /**
-   * Creates a new transfer between ledger accounts
+   * Transfer funds between two ledger accounts, such as from a company balance to a
+   * user balance.
    *
    * Required permissions:
    *
@@ -30,7 +31,7 @@ export class Transfers extends APIResource {
   }
 
   /**
-   * Retrieves a transfer by ID
+   * Retrieves the details of an existing transfer.
    *
    * Required permissions:
    *
@@ -48,7 +49,8 @@ export class Transfers extends APIResource {
   }
 
   /**
-   * Lists transfers
+   * Returns a paginated list of fund transfers, filtered by origin or destination
+   * account, with optional sorting and date filtering.
    *
    * Required permissions:
    *
@@ -73,7 +75,7 @@ export class Transfers extends APIResource {
 export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
 
 /**
- * Credit Transaction Transfer
+ * A transfer of credit between two ledger accounts.
  */
 export interface TransferListResponse {
   /**
@@ -82,8 +84,8 @@ export interface TransferListResponse {
   id: string;
 
   /**
-   * The amount of the transfer. Provided as a number in the specified currency. Eg:
-   * 10.43 for $10.43 USD.
+   * The transfer amount in the currency specified by the currency field. For
+   * example, 10.43 represents $10.43 USD.
    */
   amount: number;
 
@@ -93,73 +95,77 @@ export interface TransferListResponse {
   created_at: string;
 
   /**
-   * The currency of the credit transaction transfer
+   * The currency in which this transfer amount is denominated.
    */
   currency: Shared.Currency;
 
   /**
-   * The ID of the destination ledger account
+   * The unique identifier of the ledger account receiving the funds.
    */
   destination_ledger_account_id: string;
 
   /**
-   * The decimal fee of the credit transaction transfer
+   * The flat fee amount deducted from this transfer, in the transfer's currency.
+   * Null if no flat fee was applied.
    */
   fee_amount: number | null;
 
   /**
-   * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
-   * 5000 chars per value.
+   * Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
+   * characters per key, 5000 characters per value.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The notes of the credit transaction transfer
+   * A free-text note attached to this transfer by the sender. Null if no note was
+   * provided.
    */
   notes: string | null;
 
   /**
-   * The ID of the origin ledger account
+   * The unique identifier of the ledger account that sent the funds.
    */
   origin_ledger_account_id: string;
 }
 
 export interface TransferCreateParams {
   /**
-   * The amount to transfer. Provided as a number in the specified currency. Eg:
-   * 25.00 for $25.00 USD.
+   * The amount to transfer in the specified currency. For example, 25.00 for $25.00
+   * USD.
    */
   amount: number;
 
   /**
-   * The currency that is being withdrawn.
+   * The currency of the transfer amount, such as 'usd'.
    */
   currency: Shared.Currency;
 
   /**
-   * The ID of the destination account which will receive the funds (either a User
-   * ID, Company ID, or LedgerAccount ID)
+   * The identifier of the account receiving the funds. Accepts a user ID
+   * ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
    */
   destination_id: string;
 
   /**
-   * The ID of the origin account which will send the funds (either a User ID,
-   * Company ID, or LedgerAccount ID)
+   * The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
+   * company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
    */
   origin_id: string;
 
   /**
-   * A unique key to ensure idempotence. Use a UUID or similar.
+   * A unique key to prevent duplicate transfers. Use a UUID or similar unique
+   * string.
    */
   idempotence_key?: string | null;
 
   /**
-   * A hash of metadata to attach to the transfer.
+   * A JSON object of custom metadata to attach to the transfer for tracking
+   * purposes.
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Notes for the transfer. Maximum of 50 characters.
+   * A short note describing the transfer, up to 50 characters.
    */
   notes?: string | null;
 }
@@ -171,18 +177,18 @@ export interface TransferListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return transfers created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return transfers created before this timestamp.
    */
   created_before?: string | null;
 
   /**
-   * Filter transfers to only those that were sent to this destination account.
-   * (user_xxx, biz_xxx, ldgr_xxx)
+   * Filter to transfers received by this account. Accepts a user, company, or ledger
+   * account ID.
    */
   destination_id?: string | null;
 
@@ -207,8 +213,8 @@ export interface TransferListParams extends CursorPageParams {
   order?: 'amount' | 'created_at' | null;
 
   /**
-   * Filter transfers to only those that were sent from this origin account.
-   * (user_xxx, biz_xxx, ldgr_xxx)
+   * Filter to transfers sent from this account. Accepts a user, company, or ledger
+   * account ID.
    */
   origin_id?: string | null;
 }

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<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,
@@ -27,7 +28,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Updates the current user's profile
+   * Update the currently authenticated user's profile.
    *
    * Required permissions:
    *
@@ -52,7 +53,7 @@ export interface User {
   id: string;
 
   /**
-   * The user's bio
+   * A short biography written by the user, displayed on their public profile.
    */
   bio: string | null;
 
@@ -62,29 +63,31 @@ export interface User {
   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: 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 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;
   }
@@ -107,36 +110,37 @@ 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 {
   /**
-   * User biography
+   * A short biography displayed on the user's public profile.
    */
   bio?: string | null;
 
   /**
-   * Display name
+   * The user's display name shown on their public profile. Maximum 100 characters.
    */
   name?: string | null;
 
   /**
-   * Profile picture
+   * The user's profile picture image attachment.
    */
   profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
 
   /**
-   * Username (alphanumeric and hyphens)
+   * The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
+   * characters.
    */
   username?: string | null;
 }
 
 export namespace UserUpdateProfileParams {
   /**
-   * Profile picture
+   * The user's profile picture image attachment.
    */
   export interface ProfilePicture {
     /**

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,7 +61,8 @@ 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 {
   /**
@@ -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;
 }