@whop/sdk 0.0.27 → 0.0.28

package/src/resources/promo-codes.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class PromoCodes extends APIResource {
   /**
-   * Create a new promo code for a product or plan
+   * Create a new promo code that applies a discount at checkout. Can be scoped to
+   * specific products or plans.
    *
    * Required permissions:
    *
@@ -34,7 +35,7 @@ export class PromoCodes extends APIResource {
   }
 
   /**
-   * Retrieves a promo code by ID
+   * Retrieves the details of an existing promo code.
    *
    * Required permissions:
    *
@@ -53,7 +54,8 @@ export class PromoCodes extends APIResource {
   }
 
   /**
-   * Lists promo codes for a company
+   * Returns a paginated list of promo codes belonging to a company, with optional
+   * filtering by product, plan, and status.
    *
    * Required permissions:
    *
@@ -78,7 +80,8 @@ export class PromoCodes extends APIResource {
   }
 
   /**
-   * Archive a promo code, preventing further use
+   * Archive a promo code, preventing it from being used in future checkouts.
+   * Existing memberships are not affected.
    *
    * Required permissions:
    *
@@ -229,7 +232,8 @@ export namespace PromoCode {
     id: string;
 
     /**
-     * The title of the product. Use for Whop 4.0.
+     * The display name of the product shown to customers on the product page and in
+     * search results.
      */
     title: string;
   }
@@ -356,7 +360,8 @@ export namespace PromoCodeListResponse {
     id: string;
 
     /**
-     * The title of the product. Use for Whop 4.0.
+     * The display name of the product shown to customers on the product page and in
+     * search results.
      */
     title: string;
   }
@@ -369,89 +374,94 @@ export type PromoCodeDeleteResponse = boolean;
 
 export interface PromoCodeCreateParams {
   /**
-   * The discount amount. Interpretation depends on promo_type: if 'percentage', this
-   * is the percentage (e.g., 20 means 20% off); if 'flat_amount', this is dollars
-   * off (e.g., 10.00 means $10.00 off).
+   * The discount amount. When promo_type is percentage, this is the percent off
+   * (e.g., 20 for 20% off). When promo_type is flat_amount, this is the currency
+   * amount off (e.g., 10.00 for $10.00 off).
    */
   amount_off: number;
 
   /**
-   * The monetary currency of the promo code.
+   * The three-letter ISO currency code for the promo code discount.
    */
   base_currency: Shared.Currency;
 
   /**
-   * The specific code used to apply the promo at checkout.
+   * The alphanumeric code customers enter at checkout to apply the discount.
    */
   code: string;
 
   /**
-   * The id of the company to create the promo code for.
+   * The unique identifier of the company to create this promo code for.
    */
   company_id: string;
 
   /**
-   * Restricts promo use to only users who have never purchased from the company
-   * before.
+   * Whether to restrict this promo code to only users who have never purchased from
+   * the company before.
    */
   new_users_only: boolean;
 
   /**
-   * The number of months this promo code is applied and valid for.
+   * The number of billing months the discount remains active. For example, 3 means
+   * the discount applies to the first 3 billing cycles.
    */
   promo_duration_months: number;
 
   /**
-   * The type (% or flat amount) of the promo.
+   * The discount type, either percentage or flat_amount.
    */
   promo_type: Shared.PromoType;
 
   /**
-   * Restricts promo use to only users who have churned from the company before.
+   * Whether to restrict this promo code to only users who have previously churned
+   * from the company.
    */
   churned_users_only?: boolean | null;
 
   /**
-   * Whether this promo code is for existing memberships only (cancelations)
+   * Whether this promo code can only be applied to existing memberships, such as for
+   * cancellation retention offers.
    */
   existing_memberships_only?: boolean | null;
 
   /**
-   * The date/time of when the promo expires.
+   * The datetime when the promo code expires and can no longer be used. Null means
+   * it never expires.
    */
   expires_at?: string | null;
 
   /**
-   * Restricts promo use to only be applied once per customer.
+   * Whether each customer can only use this promo code once.
    */
   one_per_customer?: boolean | null;
 
   /**
-   * The IDs of the plans that the promo code applies to. If product_id is provided,
-   * it will only apply to plans attached to that product
+   * The identifiers of plans this promo code applies to. When product_id is also
+   * provided, only plans attached to that product are included.
    */
   plan_ids?: Array<string> | null;
 
   /**
-   * The product to lock the promo code to, if any. If provided will filter out any
-   * plan ids not attached to this product
+   * The identifier of the product to scope this promo code to. When provided, the
+   * promo code only applies to plans attached to this product.
    */
   product_id?: string | null;
 
   /**
-   * The quantity limit on the number of uses.
+   * The maximum number of times this promo code can be used. Ignored when
+   * unlimited_stock is true.
    */
   stock?: number | null;
 
   /**
-   * Whether or not the promo code should have unlimited stock.
+   * Whether the promo code can be used an unlimited number of times.
    */
   unlimited_stock?: boolean | null;
 }
 
 export interface PromoCodeListParams extends CursorPageParams {
   /**
-   * The ID of the company to list promo codes for
+   * The unique identifier of the company to list promo codes for.
    */
   company_id: string;
 
@@ -461,12 +471,12 @@ export interface PromoCodeListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return promo codes created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return promo codes created before this timestamp.
    */
   created_before?: string | null;
 
@@ -481,12 +491,12 @@ export interface PromoCodeListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * Filter promo codes by plan ID(s)
+   * Filter to only promo codes scoped to these plan identifiers.
    */
   plan_ids?: Array<string> | null;
 
   /**
-   * Filter promo codes by product ID(s)
+   * Filter to only promo codes scoped to these product identifiers.
    */
   product_ids?: Array<string> | null;
 

package/src/resources/reactions.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class Reactions extends APIResource {
   /**
-   * Creates a new reaction
+   * Add an emoji reaction or poll vote to a message or forum post. In forums, the
+   * reaction is always a like.
    *
    * Required permissions:
    *
@@ -20,7 +21,7 @@ export class Reactions extends APIResource {
   }
 
   /**
-   * Retrieves a reaction
+   * Retrieves the details of an existing reaction.
    *
    * Required permissions:
    *
@@ -31,7 +32,8 @@ export class Reactions extends APIResource {
   }
 
   /**
-   * Lists reactions for a post or a message
+   * Returns a paginated list of emoji reactions on a specific message or forum post,
+   * sorted by most recent.
    *
    * Required permissions:
    *
@@ -45,7 +47,8 @@ export class Reactions extends APIResource {
   }
 
   /**
-   * Deletes a reaction
+   * Remove an emoji reaction from a message or forum post. Only the reaction author
+   * or a channel admin can remove a reaction.
    *
    * Required permissions:
    *
@@ -64,7 +67,7 @@ export class Reactions extends APIResource {
 export type ReactionListResponsesCursorPage = CursorPage<ReactionListResponse>;
 
 /**
- * Represents a reaction to a feed post
+ * A single reaction left by a user on a feed post, such as a like or emoji.
  */
 export interface ReactionListResponse {
   /**
@@ -73,24 +76,25 @@ export interface ReactionListResponse {
   id: string;
 
   /**
-   * The emoji that was used in shortcode format (:heart:)
+   * The emoji used for this reaction in shortcode format. Null if the reaction type
+   * is not emoji.
    */
   emoji: string | null;
 
   /**
-   * The ID of the post this reaction belongs to
+   * The unique identifier of the post this reaction was left on.
    */
   resource_id: string;
 
   /**
-   * The user who reacted to the post
+   * The user who left this reaction on the post.
    */
   user: ReactionListResponse.User;
 }
 
 export namespace ReactionListResponse {
   /**
-   * The user who reacted to the post
+   * The user who left this reaction on the post.
    */
   export interface User {
     /**
@@ -99,12 +103,12 @@ export namespace ReactionListResponse {
     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;
   }
@@ -117,26 +121,26 @@ export type ReactionDeleteResponse = boolean;
 
 export interface ReactionCreateParams {
   /**
-   * The ID of the post or message to react to.
+   * The unique identifier of the message or forum post to react to.
    */
   resource_id: string;
 
   /**
-   * The emoji to react with (e.g., :heart: or '😀'). It will be ignored in forums,
-   * as everything will be :heart:
+   * The emoji to react with, in shortcode or unicode format. For example, ':heart:'
+   * or a unicode emoji. Ignored in forums where reactions are always likes.
    */
   emoji?: string | null;
 
   /**
-   * The ID of the poll option to vote for. Only valid for messages or posts with
-   * polls.
+   * The unique identifier of a poll option to vote for. Only valid when the target
+   * message or post contains a poll.
    */
   poll_option_id?: string | null;
 }
 
 export interface ReactionListParams extends CursorPageParams {
   /**
-   * The ID of the post or message to list reactions for
+   * The unique identifier of the message or forum post to list reactions for.
    */
   resource_id: string;
 
@@ -158,7 +162,9 @@ export interface ReactionListParams extends CursorPageParams {
 
 export interface ReactionDeleteParams {
   /**
-   * The emoji to remove (e.g., :heart: or '😀').
+   * The emoji to remove, in shortcode or unicode format. For example, ':heart:' or a
+   * unicode emoji. Required when the id refers to a message or post instead of a
+   * reaction.
    */
   emoji?: string | null;
 }

package/src/resources/refunds.ts

@@ -10,7 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class Refunds extends APIResource {
   /**
-   * Retrieves a Refund by ID
+   * Retrieves the details of an existing refund.
    *
    * Required permissions:
    *
@@ -24,7 +24,8 @@ export class Refunds extends APIResource {
   }
 
   /**
-   * Lists Refunds for a payment.
+   * Returns a paginated list of refunds for a specific payment, with optional
+   * filtering by creation date.
    *
    * Required permissions:
    *
@@ -53,7 +54,8 @@ export type PaymentProvider =
   | 'platform_balance'
   | 'multi_psp'
   | 'adyen'
-  | 'claritypay';
+  | 'claritypay'
+  | 'checkout_dot_com';
 
 /**
  * The status of the refund reference.
@@ -84,8 +86,8 @@ export interface RefundRetrieveResponse {
   id: string;
 
   /**
-   * The amount of the refund. Provided as a number in the specified currency. Eg:
-   * 10.43 for $10.43 USD.
+   * The refunded amount as a decimal in the specified currency, such as 10.43 for
+   * $10.43 USD.
    */
   amount: number;
 
@@ -95,22 +97,24 @@ export interface RefundRetrieveResponse {
   created_at: string;
 
   /**
-   * The currency of the refund.
+   * The three-letter ISO currency code for the refunded amount.
    */
   currency: Shared.Currency;
 
   /**
-   * The payment associated with the refund.
+   * The original payment that this refund was issued against. Null if the payment is
+   * no longer available.
    */
   payment: RefundRetrieveResponse.Payment | null;
 
   /**
-   * The provider of the refund.
+   * The payment provider that processed the refund.
    */
   provider: PaymentProvider;
 
   /**
-   * The time the refund was created by the provider.
+   * The timestamp when the refund was created in the payment provider's system. Null
+   * if not available from the provider.
    */
   provider_created_at: string | null;
 
@@ -125,19 +129,22 @@ export interface RefundRetrieveResponse {
   reference_type: RefundReferenceType | null;
 
   /**
-   * The value of the reference.
+   * The tracking reference value from the payment processor, used to trace the
+   * refund through banking networks. Null if no reference was provided.
    */
   reference_value: string | null;
 
   /**
-   * The status of the refund.
+   * The current processing status of the refund, such as pending, succeeded, or
+   * failed.
    */
   status: RefundStatus;
 }
 
 export namespace RefundRetrieveResponse {
   /**
-   * The payment associated with the refund.
+   * The original payment that this refund was issued against. Null if the payment is
+   * no longer available.
    */
   export interface Payment {
     /**
@@ -156,7 +163,8 @@ export namespace RefundRetrieveResponse {
     card_brand: PaymentsAPI.CardBrands | null;
 
     /**
-     * The last 4 digits of the card used to make the payment.
+     * The last four digits of the card used to make this payment. Null if the payment
+     * was not made with a card.
      */
     card_last4: string | null;
 
@@ -186,7 +194,8 @@ export namespace RefundRetrieveResponse {
     membership: Payment.Membership | 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;
 
@@ -257,17 +266,18 @@ export namespace RefundRetrieveResponse {
       id: string;
 
       /**
-       * The email of the user
+       * The user's email address. Requires the member:email:read permission to access.
+       * Null if not authorized.
        */
       email: string | null;
 
       /**
-       * 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;
     }
@@ -285,8 +295,8 @@ export interface RefundListResponse {
   id: string;
 
   /**
-   * The amount of the refund. Provided as a number in the specified currency. Eg:
-   * 10.43 for $10.43 USD.
+   * The refunded amount as a decimal in the specified currency, such as 10.43 for
+   * $10.43 USD.
    */
   amount: number;
 
@@ -296,22 +306,24 @@ export interface RefundListResponse {
   created_at: string;
 
   /**
-   * The currency of the refund.
+   * The three-letter ISO currency code for the refunded amount.
    */
   currency: Shared.Currency;
 
   /**
-   * The payment associated with the refund.
+   * The original payment that this refund was issued against. Null if the payment is
+   * no longer available.
    */
   payment: RefundListResponse.Payment | null;
 
   /**
-   * The provider of the refund.
+   * The payment provider that processed the refund.
    */
   provider: PaymentProvider;
 
   /**
-   * The time the refund was created by the provider.
+   * The timestamp when the refund was created in the payment provider's system. Null
+   * if not available from the provider.
    */
   provider_created_at: string | null;
 
@@ -326,19 +338,22 @@ export interface RefundListResponse {
   reference_type: RefundReferenceType | null;
 
   /**
-   * The value of the reference.
+   * The tracking reference value from the payment processor, used to trace the
+   * refund through banking networks. Null if no reference was provided.
    */
   reference_value: string | null;
 
   /**
-   * The status of the refund.
+   * The current processing status of the refund, such as pending, succeeded, or
+   * failed.
    */
   status: RefundStatus;
 }
 
 export namespace RefundListResponse {
   /**
-   * The payment associated with the refund.
+   * The original payment that this refund was issued against. Null if the payment is
+   * no longer available.
    */
   export interface Payment {
     /**
@@ -350,7 +365,7 @@ export namespace RefundListResponse {
 
 export interface RefundListParams extends CursorPageParams {
   /**
-   * The ID of the payment to list refunds for
+   * The unique identifier of the payment to list refunds for.
    */
   payment_id: string;
 
@@ -360,12 +375,12 @@ export interface RefundListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return refunds created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return refunds created before this timestamp.
    */
   created_before?: string | null;