@whop/sdk 0.0.27 → 0.0.28

package/src/resources/reviews.ts

@@ -8,14 +8,15 @@ import { path } from '../internal/utils/path';
 
 export class Reviews extends APIResource {
   /**
-   * Retrieve a review by its ID
+   * Retrieves the details of an existing review.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ReviewRetrieveResponse> {
     return this._client.get(path`/reviews/${id}`, options);
   }
 
   /**
-   * List all reviews
+   * Returns a paginated list of customer reviews for a specific product, with
+   * optional filtering by star rating and creation date.
    */
   list(
     query: ReviewListParams,
@@ -33,7 +34,8 @@ export type ReviewListResponsesCursorPage = CursorPage<ReviewListResponse>;
 export type ReviewStatus = 'pending' | 'published' | 'removed';
 
 /**
- * An object representing a user review of a company.
+ * A user-submitted review of a company, including a star rating and optional text
+ * feedback.
  */
 export interface ReviewRetrieveResponse {
   /**
@@ -42,12 +44,12 @@ export interface ReviewRetrieveResponse {
   id: string;
 
   /**
-   * The attachments attached to the review.
+   * A list of files and media attached to the review.
    */
   attachments: Array<ReviewRetrieveResponse.Attachment>;
 
   /**
-   * The company the review is for.
+   * The company that this review was written for.
    */
   company: ReviewRetrieveResponse.Company;
 
@@ -57,43 +59,45 @@ export interface ReviewRetrieveResponse {
   created_at: string;
 
   /**
-   * The description of the review.
+   * The body text of the review containing the user's detailed feedback. Returns an
+   * empty string if no description was provided.
    */
   description: string | null;
 
   /**
-   * The timestamp of when the user joined the product.
+   * The timestamp of when the reviewer first joined the product. Null if unknown.
    */
   joined_at: string | null;
 
   /**
-   * Whether or not the user paid for the product. If null, the payment status is
+   * Whether the reviewer paid for the product. Null if the payment status is
    * unknown.
    */
   paid_for_product: boolean | null;
 
   /**
-   * The product the review is for.
+   * The product that this review was written for.
    */
   product: ReviewRetrieveResponse.Product;
 
   /**
-   * The timestamp of when the review was published.
+   * The timestamp of when the review was published. Null if the review has not been
+   * published yet.
    */
   published_at: string | null;
 
   /**
-   * The number of stars the user gave the product.
+   * The star rating given by the reviewer, from 1 to 5.
    */
   stars: number;
 
   /**
-   * The status of the review.
+   * The current moderation status of the review.
    */
   status: ReviewStatus;
 
   /**
-   * The title of the review.
+   * A short summary title for the review. Null if the reviewer did not provide one.
    */
   title: string | null;
 
@@ -103,7 +107,7 @@ export interface ReviewRetrieveResponse {
   updated_at: string;
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   user: ReviewRetrieveResponse.User;
 }
@@ -114,29 +118,33 @@ export namespace ReviewRetrieveResponse {
    */
   export interface Attachment {
     /**
-     * The ID of the attachment
+     * Represents a unique identifier that is Base64 obfuscated. It is often used to
+     * refetch an object or as key for a cache. The ID type appears in a JSON response
+     * as a String; however, it is not intended to be human-readable. When expected as
+     * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+     * input value will be accepted as an ID.
      */
     id: string;
 
     /**
-     * The attachment's content type (e.g., image/jpg, video/mp4)
+     * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
      */
     content_type: string | null;
 
     /**
-     * The name of the file
+     * The original filename of the uploaded attachment, including its file extension.
      */
     filename: string | null;
 
     /**
-     * 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;
   }
 
   /**
-   * The company the review is for.
+   * The company that this review was written for.
    */
   export interface Company {
     /**
@@ -145,18 +153,18 @@ export namespace ReviewRetrieveResponse {
     id: string;
 
     /**
-     * The slug/route of the company on the Whop site.
+     * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
      */
     route: string;
 
     /**
-     * The title of the company.
+     * The display name of the company shown to customers.
      */
     title: string;
   }
 
   /**
-   * The product the review is for.
+   * The product that this review was written for.
    */
   export interface Product {
     /**
@@ -165,13 +173,14 @@ export namespace ReviewRetrieveResponse {
     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;
   }
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   export interface User {
     /**
@@ -180,19 +189,20 @@ export namespace ReviewRetrieveResponse {
     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;
   }
 }
 
 /**
- * An object representing a user review of a company.
+ * A user-submitted review of a company, including a star rating and optional text
+ * feedback.
  */
 export interface ReviewListResponse {
   /**
@@ -201,7 +211,7 @@ export interface ReviewListResponse {
   id: string;
 
   /**
-   * The attachments attached to the review.
+   * A list of files and media attached to the review.
    */
   attachments: Array<ReviewListResponse.Attachment>;
 
@@ -211,38 +221,40 @@ export interface ReviewListResponse {
   created_at: string;
 
   /**
-   * The description of the review.
+   * The body text of the review containing the user's detailed feedback. Returns an
+   * empty string if no description was provided.
    */
   description: string | null;
 
   /**
-   * The timestamp of when the user joined the product.
+   * The timestamp of when the reviewer first joined the product. Null if unknown.
    */
   joined_at: string | null;
 
   /**
-   * Whether or not the user paid for the product. If null, the payment status is
+   * Whether the reviewer paid for the product. Null if the payment status is
    * unknown.
    */
   paid_for_product: boolean | null;
 
   /**
-   * The timestamp of when the review was published.
+   * The timestamp of when the review was published. Null if the review has not been
+   * published yet.
    */
   published_at: string | null;
 
   /**
-   * The number of stars the user gave the product.
+   * The star rating given by the reviewer, from 1 to 5.
    */
   stars: number;
 
   /**
-   * The status of the review.
+   * The current moderation status of the review.
    */
   status: ReviewStatus;
 
   /**
-   * The title of the review.
+   * A short summary title for the review. Null if the reviewer did not provide one.
    */
   title: string | null;
 
@@ -252,7 +264,7 @@ export interface ReviewListResponse {
   updated_at: string;
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   user: ReviewListResponse.User;
 }
@@ -263,29 +275,33 @@ export namespace ReviewListResponse {
    */
   export interface Attachment {
     /**
-     * The ID of the attachment
+     * Represents a unique identifier that is Base64 obfuscated. It is often used to
+     * refetch an object or as key for a cache. The ID type appears in a JSON response
+     * as a String; however, it is not intended to be human-readable. When expected as
+     * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+     * input value will be accepted as an ID.
      */
     id: string;
 
     /**
-     * The attachment's content type (e.g., image/jpg, video/mp4)
+     * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
      */
     content_type: string | null;
 
     /**
-     * The name of the file
+     * The original filename of the uploaded attachment, including its file extension.
      */
     filename: string | null;
 
     /**
-     * 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;
   }
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   export interface User {
     /**
@@ -294,12 +310,12 @@ export namespace ReviewListResponse {
     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;
   }
@@ -307,7 +323,7 @@ export namespace ReviewListResponse {
 
 export interface ReviewListParams extends CursorPageParams {
   /**
-   * The ID of the product
+   * The unique identifier of the product to list reviews for.
    */
   product_id: string;
 
@@ -317,12 +333,12 @@ export interface ReviewListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return reviews created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return reviews created before this timestamp.
    */
   created_before?: string | null;
 
@@ -337,12 +353,12 @@ export interface ReviewListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The maximum star rating of the review (inclusive)
+   * The maximum star rating to include in results, from 1 to 5 inclusive.
    */
   max_stars?: number | null;
 
   /**
-   * The minimum star rating of the review (inclusive)
+   * The minimum star rating to include in results, from 1 to 5 inclusive.
    */
   min_stars?: number | null;
 }

package/src/resources/setup-intents.ts

@@ -10,11 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class SetupIntents extends APIResource {
   /**
-   * A setup intent is an object used to securely collect and store a member’s
-   * payment method for future use without charging them immediately. It handles
-   * authentication steps up front so future off-session payments can be completed
-   * smoothly. This ensures the payment method is verified and ready for later
-   * billing.
+   * Retrieves the details of an existing setup intent.
    *
    * Required permissions:
    *
@@ -27,11 +23,9 @@ export class SetupIntents extends APIResource {
   }
 
   /**
-   * A setup intent is an object used to securely collect and store a member’s
-   * payment method for future use without charging them immediately. It handles
-   * authentication steps up front so future off-session payments can be completed
-   * smoothly. This ensures the payment method is verified and ready for later
-   * billing.
+   * Returns a paginated list of setup intents for a company, with optional filtering
+   * by creation date. A setup intent securely collects and stores a member's payment
+   * method for future use without charging them immediately.
    *
    * Required permissions:
    *
@@ -53,7 +47,8 @@ export class SetupIntents extends APIResource {
 export type SetupIntentListResponsesCursorPage = CursorPage<SetupIntentListResponse>;
 
 /**
- * A setup intent allows a user to save a payment method without making a purchase.
+ * A setup intent allows a user to save a payment method for future use without
+ * making an immediate purchase.
  */
 export interface SetupIntent {
   /**
@@ -62,12 +57,14 @@ export interface SetupIntent {
   id: string;
 
   /**
-   * The checkout configuration associated with the setup intent
+   * The checkout session configuration associated with this setup intent. Null if no
+   * checkout session was used.
    */
   checkout_configuration: SetupIntent.CheckoutConfiguration | null;
 
   /**
-   * The company of the setup intent
+   * The company that initiated this setup intent. Null if the company has been
+   * deleted.
    */
   company: SetupIntent.Company | null;
 
@@ -77,34 +74,39 @@ export interface SetupIntent {
   created_at: string;
 
   /**
-   * The error message, if any.
+   * A human-readable error message explaining why the setup intent failed. Null if
+   * no error occurred.
    */
   error_message: string | null;
 
   /**
-   * The member connected to the setup intent
+   * The company member associated with this setup intent. Null if the user is not a
+   * member.
    */
   member: SetupIntent.Member | null;
 
   /**
-   * The metadata associated with the setup intent
+   * Custom key-value pairs attached to this setup intent. Null if no metadata was
+   * provided.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The payment method created during the setup, if available.
+   * The saved payment method created by this setup intent. Null if the setup has not
+   * completed successfully.
    */
   payment_method: SetupIntent.PaymentMethod | null;
 
   /**
-   * The status of the setup intent
+   * The current status of the setup intent.
    */
   status: SetupIntentStatus;
 }
 
 export namespace SetupIntent {
   /**
-   * The checkout configuration associated with the setup intent
+   * The checkout session configuration associated with this setup intent. Null if no
+   * checkout session was used.
    */
   export interface CheckoutConfiguration {
     /**
@@ -114,7 +116,8 @@ export namespace SetupIntent {
   }
 
   /**
-   * The company of the setup intent
+   * The company that initiated this setup intent. Null if the company has been
+   * deleted.
    */
   export interface Company {
     /**
@@ -124,7 +127,8 @@ export namespace SetupIntent {
   }
 
   /**
-   * The member connected to the setup intent
+   * The company member associated with this setup intent. Null if the user is not a
+   * member.
    */
   export interface Member {
     /**
@@ -166,7 +170,8 @@ export namespace SetupIntent {
   }
 
   /**
-   * The payment method created during the setup, if available.
+   * The saved payment method created by this setup intent. Null if the setup has not
+   * completed successfully.
    */
   export interface PaymentMethod {
     /**
@@ -201,17 +206,18 @@ export namespace SetupIntent {
       brand: PaymentsAPI.CardBrands | null;
 
       /**
-       * Card expiration month, like 03 for March.
+       * The two-digit expiration month of the card (1-12). Null if not available.
        */
       exp_month: number | null;
 
       /**
-       * Card expiration year, like 27 for 2027.
+       * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
+       * available.
        */
       exp_year: number | null;
 
       /**
-       * Last four digits of the card.
+       * The last four digits of the card number. Null if not available.
        */
       last4: string | null;
     }
@@ -224,7 +230,8 @@ export namespace SetupIntent {
 export type SetupIntentStatus = 'processing' | 'succeeded' | 'canceled' | 'requires_action';
 
 /**
- * A setup intent allows a user to save a payment method without making a purchase.
+ * A setup intent allows a user to save a payment method for future use without
+ * making an immediate purchase.
  */
 export interface SetupIntentListResponse {
   /**
@@ -233,12 +240,14 @@ export interface SetupIntentListResponse {
   id: string;
 
   /**
-   * The checkout configuration associated with the setup intent
+   * The checkout session configuration associated with this setup intent. Null if no
+   * checkout session was used.
    */
   checkout_configuration: SetupIntentListResponse.CheckoutConfiguration | null;
 
   /**
-   * The company of the setup intent
+   * The company that initiated this setup intent. Null if the company has been
+   * deleted.
    */
   company: SetupIntentListResponse.Company | null;
 
@@ -248,34 +257,39 @@ export interface SetupIntentListResponse {
   created_at: string;
 
   /**
-   * The error message, if any.
+   * A human-readable error message explaining why the setup intent failed. Null if
+   * no error occurred.
    */
   error_message: string | null;
 
   /**
-   * The member connected to the setup intent
+   * The company member associated with this setup intent. Null if the user is not a
+   * member.
    */
   member: SetupIntentListResponse.Member | null;
 
   /**
-   * The metadata associated with the setup intent
+   * Custom key-value pairs attached to this setup intent. Null if no metadata was
+   * provided.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The payment method created during the setup, if available.
+   * The saved payment method created by this setup intent. Null if the setup has not
+   * completed successfully.
    */
   payment_method: SetupIntentListResponse.PaymentMethod | null;
 
   /**
-   * The status of the setup intent
+   * The current status of the setup intent.
    */
   status: SetupIntentStatus;
 }
 
 export namespace SetupIntentListResponse {
   /**
-   * The checkout configuration associated with the setup intent
+   * The checkout session configuration associated with this setup intent. Null if no
+   * checkout session was used.
    */
   export interface CheckoutConfiguration {
     /**
@@ -285,7 +299,8 @@ export namespace SetupIntentListResponse {
   }
 
   /**
-   * The company of the setup intent
+   * The company that initiated this setup intent. Null if the company has been
+   * deleted.
    */
   export interface Company {
     /**
@@ -295,7 +310,8 @@ export namespace SetupIntentListResponse {
   }
 
   /**
-   * The member connected to the setup intent
+   * The company member associated with this setup intent. Null if the user is not a
+   * member.
    */
   export interface Member {
     /**
@@ -337,7 +353,8 @@ export namespace SetupIntentListResponse {
   }
 
   /**
-   * The payment method created during the setup, if available.
+   * The saved payment method created by this setup intent. Null if the setup has not
+   * completed successfully.
    */
   export interface PaymentMethod {
     /**
@@ -372,17 +389,18 @@ export namespace SetupIntentListResponse {
       brand: PaymentsAPI.CardBrands | null;
 
       /**
-       * Card expiration month, like 03 for March.
+       * The two-digit expiration month of the card (1-12). Null if not available.
        */
       exp_month: number | null;
 
       /**
-       * Card expiration year, like 27 for 2027.
+       * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
+       * available.
        */
       exp_year: number | null;
 
       /**
-       * Last four digits of the card.
+       * The last four digits of the card number. Null if not available.
        */
       last4: string | null;
     }
@@ -391,7 +409,7 @@ export namespace SetupIntentListResponse {
 
 export interface SetupIntentListParams extends CursorPageParams {
   /**
-   * The ID of the company to list setup intents for
+   * The unique identifier of the company to list setup intents for.
    */
   company_id: string;
 
@@ -401,12 +419,12 @@ export interface SetupIntentListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return setup intents created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return setup intents created before this timestamp.
    */
   created_before?: string | null;