@whop/sdk 0.0.26 → 0.0.27

package/src/resources/reactions.ts

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

package/src/resources/refunds.ts

@@ -52,7 +52,8 @@ export type PaymentProvider =
   | 'splitit'
   | 'platform_balance'
   | 'multi_psp'
-  | 'adyen';
+  | 'adyen'
+  | 'claritypay';
 
 /**
  * The status of the refund reference.
@@ -73,21 +74,23 @@ 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 amount of the refund. Provided as a number in the specified currency. Eg:
+   * 10.43 for $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   created_at: string;
 
@@ -138,7 +141,7 @@ export namespace RefundRetrieveResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
 
@@ -158,7 +161,7 @@ export namespace RefundRetrieveResponse {
     card_last4: string | null;
 
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
 
@@ -219,7 +222,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Member {
       /**
-       * The ID of the member
+       * The unique identifier for the company member.
        */
       id: string;
 
@@ -234,7 +237,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Membership {
       /**
-       * The internal ID of the membership.
+       * The unique identifier for the membership.
        */
       id: string;
 
@@ -249,7 +252,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface User {
       /**
-       * The internal ID of the user.
+       * The unique identifier for the user.
        */
       id: string;
 
@@ -272,21 +275,23 @@ 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 amount of the refund. Provided as a number in the specified currency. Eg:
+   * 10.43 for $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   created_at: string;
 
@@ -337,7 +342,7 @@ export namespace RefundListResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }

package/src/resources/reviews.ts

@@ -37,7 +37,7 @@ export type ReviewStatus = 'pending' | 'published' | 'removed';
  */
 export interface ReviewRetrieveResponse {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   id: string;
 
@@ -52,7 +52,7 @@ export interface ReviewRetrieveResponse {
   company: ReviewRetrieveResponse.Company;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   created_at: string;
 
@@ -98,7 +98,7 @@ export interface ReviewRetrieveResponse {
   title: string | null;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
@@ -140,7 +140,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -160,7 +160,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -175,7 +175,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -196,7 +196,7 @@ export namespace ReviewRetrieveResponse {
  */
 export interface ReviewListResponse {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   id: string;
 
@@ -206,7 +206,7 @@ export interface ReviewListResponse {
   attachments: Array<ReviewListResponse.Attachment>;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   created_at: string;
 
@@ -247,7 +247,7 @@ export interface ReviewListResponse {
   title: string | null;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
@@ -289,7 +289,7 @@ export namespace ReviewListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/setup-intents.ts

@@ -53,12 +53,11 @@ export class SetupIntents extends APIResource {
 export type SetupIntentListResponsesCursorPage = CursorPage<SetupIntentListResponse>;
 
 /**
- * An object representing a setup intent, which is a flow for allowing a customer
- * to add a payment method to their account without making a purchase.
+ * A setup intent allows a user to save a payment method without making a purchase.
  */
 export interface SetupIntent {
   /**
-   * The setup intent ID
+   * The unique identifier for the setup intent.
    */
   id: string;
 
@@ -73,7 +72,7 @@ export interface SetupIntent {
   company: SetupIntent.Company | null;
 
   /**
-   * The datetime the payment was created
+   * The datetime the setup intent was created.
    */
   created_at: string;
 
@@ -109,7 +108,7 @@ export namespace SetupIntent {
    */
   export interface CheckoutConfiguration {
     /**
-     * The ID of the checkout configuration
+     * The unique identifier for the checkout session.
      */
     id: string;
   }
@@ -119,7 +118,7 @@ export namespace SetupIntent {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -129,7 +128,7 @@ export namespace SetupIntent {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -145,7 +144,7 @@ export namespace SetupIntent {
      */
     export interface User {
       /**
-       * The internal ID of the user account.
+       * The unique identifier for the company member user.
        */
       id: string;
 
@@ -171,7 +170,7 @@ export namespace SetupIntent {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -181,7 +180,7 @@ export namespace SetupIntent {
     card: PaymentMethod.Card | null;
 
     /**
-     * The date and time the payment method was created
+     * The datetime the payment token was created.
      */
     created_at: string;
 
@@ -225,12 +224,11 @@ export namespace SetupIntent {
 export type SetupIntentStatus = 'processing' | 'succeeded' | 'canceled' | 'requires_action';
 
 /**
- * An object representing a setup intent, which is a flow for allowing a customer
- * to add a payment method to their account without making a purchase.
+ * A setup intent allows a user to save a payment method without making a purchase.
  */
 export interface SetupIntentListResponse {
   /**
-   * The setup intent ID
+   * The unique identifier for the setup intent.
    */
   id: string;
 
@@ -245,7 +243,7 @@ export interface SetupIntentListResponse {
   company: SetupIntentListResponse.Company | null;
 
   /**
-   * The datetime the payment was created
+   * The datetime the setup intent was created.
    */
   created_at: string;
 
@@ -281,7 +279,7 @@ export namespace SetupIntentListResponse {
    */
   export interface CheckoutConfiguration {
     /**
-     * The ID of the checkout configuration
+     * The unique identifier for the checkout session.
      */
     id: string;
   }
@@ -291,7 +289,7 @@ export namespace SetupIntentListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -301,7 +299,7 @@ export namespace SetupIntentListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -317,7 +315,7 @@ export namespace SetupIntentListResponse {
      */
     export interface User {
       /**
-       * The internal ID of the user account.
+       * The unique identifier for the company member user.
        */
       id: string;
 
@@ -343,7 +341,7 @@ export namespace SetupIntentListResponse {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -353,7 +351,7 @@ export namespace SetupIntentListResponse {
     card: PaymentMethod.Card | null;
 
     /**
-     * The date and time the payment method was created
+     * The datetime the payment token was created.
      */
     created_at: string;