@whop/sdk 0.0.26 → 0.0.28

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:
    *
@@ -52,7 +53,9 @@ export type PaymentProvider =
   | 'splitit'
   | 'platform_balance'
   | 'multi_psp'
-  | 'adyen';
+  | 'adyen'
+  | 'claritypay'
+  | 'checkout_dot_com';
 
 /**
  * The status of the refund reference.
@@ -73,41 +76,45 @@ export type RefundReferenceType =
 export type RefundStatus = 'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled';
 
 /**
- * An object representing a refund made on a payment.
+ * A refund represents a full or partial reversal of a payment, including the
+ * amount, status, and payment provider.
  */
 export interface RefundRetrieveResponse {
   /**
-   * The ID of the refund.
+   * The unique identifier for the refund.
    */
   id: string;
 
   /**
-   * The amount of the refund.
+   * The refunded amount as a decimal in the specified currency, such as 10.43 for
+   * $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   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;
 
@@ -122,23 +129,26 @@ 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 {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
 
@@ -153,12 +163,13 @@ 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;
 
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
 
@@ -183,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;
 
@@ -219,7 +231,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Member {
       /**
-       * The ID of the member
+       * The unique identifier for the company member.
        */
       id: string;
 
@@ -234,7 +246,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Membership {
       /**
-       * The internal ID of the membership.
+       * The unique identifier for the membership.
        */
       id: string;
 
@@ -249,22 +261,23 @@ export namespace RefundRetrieveResponse {
      */
     export interface User {
       /**
-       * The internal ID of the user.
+       * The unique identifier for the user.
        */
       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;
     }
@@ -272,41 +285,45 @@ export namespace RefundRetrieveResponse {
 }
 
 /**
- * An object representing a refund made on a payment.
+ * A refund represents a full or partial reversal of a payment, including the
+ * amount, status, and payment provider.
  */
 export interface RefundListResponse {
   /**
-   * The ID of the refund.
+   * The unique identifier for the refund.
    */
   id: string;
 
   /**
-   * The amount of the refund.
+   * The refunded amount as a decimal in the specified currency, such as 10.43 for
+   * $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   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;
 
@@ -321,23 +338,26 @@ 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 {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }
@@ -345,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;
 
@@ -355,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;
 

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,77 +34,80 @@ 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 {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   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;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   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;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   user: ReviewRetrieveResponse.User;
 }
@@ -114,145 +118,153 @@ 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 {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     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 {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     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 {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     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 {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   id: string;
 
   /**
-   * The attachments attached to the review.
+   * A list of files and media attached to the review.
    */
   attachments: Array<ReviewListResponse.Attachment>;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   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;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
   /**
-   * The user account that performed the action.
+   * The user account of the person who wrote this review.
    */
   user: ReviewListResponse.User;
 }
@@ -263,43 +275,47 @@ 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 {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     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;
 }