@whop/sdk 0.0.26 → 0.0.28

package/src/resources/webhooks.ts

@@ -35,7 +35,7 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Retrieves a webhook by ID
+   * Retrieves the details of an existing webhook.
    *
    * Required permissions:
    *
@@ -75,7 +75,8 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Lists webhooks for a company
+   * Returns a paginated list of webhook endpoints configured for a company, ordered
+   * by most recently created.
    *
    * Required permissions:
    *
@@ -138,53 +139,54 @@ export type WebhookListResponsesCursorPage = CursorPage<WebhookListResponse>;
 export type APIVersion = 'v1' | 'v2' | 'v5';
 
 /**
- * A webhook object, which can be configured to be sent updates about a company
+ * A webhook endpoint that receives event notifications for a company via HTTP
+ * POST.
  */
 export interface Webhook {
   /**
-   * The ID of the webhook
+   * The unique identifier for the webhook.
    */
   id: string;
 
   /**
-   * The API version for this webhook
+   * The API version used to format payloads sent to this webhook endpoint.
    */
   api_version: APIVersion;
 
   /**
-   * Whether or not to send events for child resources. For example, if the webhook
-   * is created for a Company, enabling this will only send events from the Company's
-   * sub-merchants (child companies).
+   * Whether events are sent for child resources. For example, if the webhook is on a
+   * company, enabling this sends events only from the company's sub-merchants (child
+   * companies).
    */
   child_resource_events: boolean;
 
   /**
-   * The timestamp of when the webhook was created
+   * The datetime the webhook was created.
    */
   created_at: string;
 
   /**
-   * Whether or not this webhook is turned on or not
+   * Whether this webhook endpoint is currently active and receiving events.
    */
   enabled: boolean;
 
   /**
-   * The number of events this webhooks is configured to receive
+   * The list of event types this webhook is subscribed to.
    */
   events: Array<WebhookEvent>;
 
   /**
-   * The resource ID
+   * The ID of the resource (company or product) this webhook is attached to.
    */
   resource_id: string;
 
   /**
-   * The list of events that can be tested with this webhook
+   * The subset of subscribed event types that support sending test payloads.
    */
   testable_events: Array<WebhookEvent>;
 
   /**
-   * The URL the webhook events will be sent to
+   * The destination URL where webhook payloads are delivered via HTTP POST.
    */
   url: string;
 }
@@ -222,100 +224,103 @@ export type WebhookEvent =
   | 'membership.cancel_at_period_end_changed';
 
 /**
- * A webhook object, which can be configured to be sent updates about a company
+ * A webhook endpoint that receives event notifications for a company via HTTP
+ * POST.
  */
 export interface WebhookCreateResponse {
   /**
-   * The ID of the webhook
+   * The unique identifier for the webhook.
    */
   id: string;
 
   /**
-   * The API version for this webhook
+   * The API version used to format payloads sent to this webhook endpoint.
    */
   api_version: APIVersion;
 
   /**
-   * Whether or not to send events for child resources. For example, if the webhook
-   * is created for a Company, enabling this will only send events from the Company's
-   * sub-merchants (child companies).
+   * Whether events are sent for child resources. For example, if the webhook is on a
+   * company, enabling this sends events only from the company's sub-merchants (child
+   * companies).
    */
   child_resource_events: boolean;
 
   /**
-   * The timestamp of when the webhook was created
+   * The datetime the webhook was created.
    */
   created_at: string;
 
   /**
-   * Whether or not this webhook is turned on or not
+   * Whether this webhook endpoint is currently active and receiving events.
    */
   enabled: boolean;
 
   /**
-   * The number of events this webhooks is configured to receive
+   * The list of event types this webhook is subscribed to.
    */
   events: Array<WebhookEvent>;
 
   /**
-   * The resource ID
+   * The ID of the resource (company or product) this webhook is attached to.
    */
   resource_id: string;
 
   /**
-   * The list of events that can be tested with this webhook
+   * The subset of subscribed event types that support sending test payloads.
    */
   testable_events: Array<WebhookEvent>;
 
   /**
-   * The URL the webhook events will be sent to
+   * The destination URL where webhook payloads are delivered via HTTP POST.
    */
   url: string;
 
   /**
-   * A unique secret key that will be sent with each webhook event
+   * The secret key used to sign webhook payloads for verification. Include this in
+   * your HMAC validation logic.
    */
   webhook_secret: string;
 }
 
 /**
- * A webhook object, which can be configured to be sent updates about a company
+ * A webhook endpoint that receives event notifications for a company via HTTP
+ * POST.
  */
 export interface WebhookListResponse {
   /**
-   * The ID of the webhook
+   * The unique identifier for the webhook.
    */
   id: string;
 
   /**
-   * The API version for this webhook
+   * The API version used to format payloads sent to this webhook endpoint.
    */
   api_version: APIVersion;
 
   /**
-   * Whether or not to send events for child resources. For example, if the webhook
-   * is created for a Company, enabling this will only send events from the Company's
-   * sub-merchants (child companies).
+   * Whether events are sent for child resources. For example, if the webhook is on a
+   * company, enabling this sends events only from the company's sub-merchants (child
+   * companies).
    */
   child_resource_events: boolean;
 
   /**
-   * The timestamp of when the webhook was created
+   * The datetime the webhook was created.
    */
   created_at: string;
 
   /**
-   * Whether or not this webhook is turned on or not
+   * Whether this webhook endpoint is currently active and receiving events.
    */
   enabled: boolean;
 
   /**
-   * The number of events this webhooks is configured to receive
+   * The list of event types this webhook is subscribed to.
    */
   events: Array<WebhookEvent>;
 
   /**
-   * The URL the webhook events will be sent to
+   * The destination URL where webhook payloads are delivered via HTTP POST.
    */
   url: string;
 }
@@ -337,7 +342,9 @@ export interface InvoiceCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A statement that defines an amount due by a customer.
+   * An invoice represents an itemized bill sent by a company to a customer for a
+   * specific product and plan, tracking the amount owed, due date, and payment
+   * status.
    */
   data: Shared.Invoice;
 
@@ -369,7 +376,9 @@ export interface InvoicePaidWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A statement that defines an amount due by a customer.
+   * An invoice represents an itemized bill sent by a company to a customer for a
+   * specific product and plan, tracking the amount owed, due date, and payment
+   * status.
    */
   data: Shared.Invoice;
 
@@ -401,7 +410,9 @@ export interface InvoicePastDueWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A statement that defines an amount due by a customer.
+   * An invoice represents an itemized bill sent by a company to a customer for a
+   * specific product and plan, tracking the amount owed, due date, and payment
+   * status.
    */
   data: Shared.Invoice;
 
@@ -433,7 +444,9 @@ export interface InvoiceVoidedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A statement that defines an amount due by a customer.
+   * An invoice represents an itemized bill sent by a company to a customer for a
+   * specific product and plan, tracking the amount owed, due date, and payment
+   * status.
    */
   data: Shared.Invoice;
 
@@ -465,8 +478,8 @@ export interface MembershipActivatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A membership represents a purchase between a User and a Company for a specific
-   * Product.
+   * A membership represents an active relationship between a user and a product. It
+   * tracks the user's access, billing status, and renewal schedule.
    */
   data: Shared.Membership;
 
@@ -498,8 +511,8 @@ export interface MembershipDeactivatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A membership represents a purchase between a User and a Company for a specific
-   * Product.
+   * A membership represents an active relationship between a user and a product. It
+   * tracks the user's access, billing status, and renewal schedule.
    */
   data: Shared.Membership;
 
@@ -531,7 +544,7 @@ export interface EntryCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an entry in a waitlist.
+   * An entry represents a user's signup for a waitlisted plan.
    */
   data: Shared.Entry;
 
@@ -563,7 +576,7 @@ export interface EntryApprovedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an entry in a waitlist.
+   * An entry represents a user's signup for a waitlisted plan.
    */
   data: Shared.Entry;
 
@@ -595,7 +608,7 @@ export interface EntryDeniedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an entry in a waitlist.
+   * An entry represents a user's signup for a waitlisted plan.
    */
   data: Shared.Entry;
 
@@ -627,7 +640,7 @@ export interface EntryDeletedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an entry in a waitlist.
+   * An entry represents a user's signup for a waitlisted plan.
    */
   data: Shared.Entry;
 
@@ -659,8 +672,8 @@ export interface SetupIntentRequiresActionWebhookEvent {
   api_version: 'v1';
 
   /**
-   * 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 for future use without
+   * making an immediate purchase.
    */
   data: SetupIntentsAPI.SetupIntent;
 
@@ -692,8 +705,8 @@ export interface SetupIntentSucceededWebhookEvent {
   api_version: 'v1';
 
   /**
-   * 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 for future use without
+   * making an immediate purchase.
    */
   data: SetupIntentsAPI.SetupIntent;
 
@@ -725,8 +738,8 @@ export interface SetupIntentCanceledWebhookEvent {
   api_version: 'v1';
 
   /**
-   * 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 for future use without
+   * making an immediate purchase.
    */
   data: SetupIntentsAPI.SetupIntent;
 
@@ -758,7 +771,8 @@ export interface WithdrawalCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A withdrawal request.
+   * A withdrawal represents a request to transfer funds from a ledger account to an
+   * external payout method.
    */
   data: WithdrawalsAPI.Withdrawal;
 
@@ -790,7 +804,8 @@ export interface WithdrawalUpdatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A withdrawal request.
+   * A withdrawal represents a request to transfer funds from a ledger account to an
+   * external payout method.
    */
   data: WithdrawalsAPI.Withdrawal;
 
@@ -822,7 +837,8 @@ export interface CourseLessonInteractionCompletedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A lesson interaction tracking user progress in courses
+   * A record of a user's progress on a specific lesson, tracking whether they have
+   * completed it.
    */
   data: Shared.CourseLessonInteraction;
 
@@ -854,7 +870,8 @@ export interface PayoutMethodCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an user's setup payout destination.
+   * A configured payout destination where a user receives earned funds, such as a
+   * bank account or digital wallet.
    */
   data: PayoutMethodCreatedWebhookEvent.Data;
 
@@ -876,71 +893,78 @@ export interface PayoutMethodCreatedWebhookEvent {
 
 export namespace PayoutMethodCreatedWebhookEvent {
   /**
-   * An object representing an user's setup payout destination.
+   * A configured payout destination where a user receives earned funds, such as a
+   * bank account or digital wallet.
    */
   export interface Data {
     /**
-     * The ID of the payout token
+     * The unique identifier for the payout token.
      */
     id: string;
 
     /**
-     * A reference to identify the payout destination, such as the last 4 digits of an
-     * account number or an email address.
+     * A masked identifier for the payout destination, such as the last four digits of
+     * a bank account or an email address. Null if no reference is available.
      */
     account_reference: string | null;
 
     /**
-     * The company associated with the payout token
+     * The company associated with this payout destination. Null if not linked to a
+     * specific company.
      */
     company: Data.Company | null;
 
     /**
-     * The date and time the payout token was created
+     * The datetime the payout token was created.
      */
     created_at: string;
 
     /**
-     * The currency code of the payout destination. This is the currency that payouts
-     * will be made in for this token.
+     * The three-letter ISO currency code that payouts are delivered in for this
+     * destination.
      */
     currency: string;
 
     /**
-     * The payout destination associated with the payout token
+     * The payout destination configuration linked to this token. Null if not yet
+     * configured.
      */
     destination: Data.Destination | null;
 
     /**
-     * The name of the bank or financial institution.
+     * The name of the bank or financial institution receiving payouts. Null if not
+     * applicable or not provided.
      */
     institution_name: string | null;
 
     /**
-     * Whether this payout token is the default for the payout account
+     * Whether this is the default payout destination for the associated payout
+     * account.
      */
     is_default: boolean;
 
     /**
-     * An optional nickname for the payout token to help the user identify it. This is
-     * not used by the provider and is only for the user's reference.
+     * A user-defined label to help identify this payout destination. Not sent to the
+     * provider. Null if no nickname has been set.
      */
     nickname: string | null;
   }
 
   export namespace Data {
     /**
-     * The company associated with the payout token
+     * The company associated with this payout destination. Null if not linked to a
+     * specific company.
      */
     export interface Company {
       /**
-       * The ID (tag) of the company.
+       * The unique identifier for the company.
        */
       id: string;
     }
 
     /**
-     * The payout destination associated with the payout token
+     * The payout destination configuration linked to this token. Null if not yet
+     * configured.
      */
     export interface Destination {
       /**
@@ -973,7 +997,8 @@ export interface VerificationSucceededWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing an identity verification session
+   * An identity verification session used to confirm a person or entity's identity
+   * for payout account eligibility.
    */
   data: VerificationSucceededWebhookEvent.Data;
 
@@ -995,11 +1020,12 @@ export interface VerificationSucceededWebhookEvent {
 
 export namespace VerificationSucceededWebhookEvent {
   /**
-   * 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 Data {
     /**
-     * A unique identifier for the verification.
+     * The unique identifier for the verification.
      */
     id: string;
 
@@ -1009,12 +1035,13 @@ export namespace VerificationSucceededWebhookEvent {
     last_error_code: VerificationsAPI.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: VerificationsAPI.VerificationStatus;
   }
@@ -1032,7 +1059,8 @@ export interface PaymentCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a receipt for a membership.
+   * A payment represents a completed or attempted charge. Payments track the amount,
+   * status, currency, and payment method used.
    */
   data: Shared.Payment;
 
@@ -1064,7 +1092,8 @@ export interface PaymentSucceededWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a receipt for a membership.
+   * A payment represents a completed or attempted charge. Payments track the amount,
+   * status, currency, and payment method used.
    */
   data: Shared.Payment;
 
@@ -1096,7 +1125,8 @@ export interface PaymentFailedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a receipt for a membership.
+   * A payment represents a completed or attempted charge. Payments track the amount,
+   * status, currency, and payment method used.
    */
   data: Shared.Payment;
 
@@ -1128,7 +1158,8 @@ export interface PaymentPendingWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a receipt for a membership.
+   * A payment represents a completed or attempted charge. Payments track the amount,
+   * status, currency, and payment method used.
    */
   data: Shared.Payment;
 
@@ -1160,7 +1191,8 @@ export interface DisputeCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a dispute against a company.
+   * A dispute is a chargeback or payment challenge filed against a company,
+   * including evidence and response status.
    */
   data: DisputesAPI.Dispute;
 
@@ -1192,7 +1224,8 @@ export interface DisputeUpdatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * An object representing a dispute against a company.
+   * A dispute is a chargeback or payment challenge filed against a company,
+   * including evidence and response status.
    */
   data: DisputesAPI.Dispute;
 
@@ -1224,7 +1257,8 @@ export interface RefundCreatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * 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.
    */
   data: RefundCreatedWebhookEvent.Data;
 
@@ -1246,41 +1280,45 @@ export interface RefundCreatedWebhookEvent {
 
 export namespace RefundCreatedWebhookEvent {
   /**
-   * 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 Data {
     /**
-     * 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: Data.Payment | null;
 
     /**
-     * The provider of the refund.
+     * The payment provider that processed the refund.
      */
     provider: RefundsAPI.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;
 
@@ -1295,23 +1333,26 @@ export namespace RefundCreatedWebhookEvent {
     reference_type: RefundsAPI.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: RefundsAPI.RefundStatus;
   }
 
   export namespace Data {
     /**
-     * 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;
 
@@ -1326,12 +1367,13 @@ export namespace RefundCreatedWebhookEvent {
       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;
 
@@ -1356,7 +1398,8 @@ export namespace RefundCreatedWebhookEvent {
       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;
 
@@ -1392,7 +1435,7 @@ export namespace RefundCreatedWebhookEvent {
        */
       export interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
 
@@ -1407,7 +1450,7 @@ export namespace RefundCreatedWebhookEvent {
        */
       export interface Membership {
         /**
-         * The internal ID of the membership.
+         * The unique identifier for the membership.
          */
         id: string;
 
@@ -1422,22 +1465,23 @@ export namespace RefundCreatedWebhookEvent {
        */
       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;
       }
@@ -1457,7 +1501,8 @@ export interface RefundUpdatedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * 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.
    */
   data: RefundUpdatedWebhookEvent.Data;
 
@@ -1479,41 +1524,45 @@ export interface RefundUpdatedWebhookEvent {
 
 export namespace RefundUpdatedWebhookEvent {
   /**
-   * 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 Data {
     /**
-     * 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: Data.Payment | null;
 
     /**
-     * The provider of the refund.
+     * The payment provider that processed the refund.
      */
     provider: RefundsAPI.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;
 
@@ -1528,23 +1577,26 @@ export namespace RefundUpdatedWebhookEvent {
     reference_type: RefundsAPI.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: RefundsAPI.RefundStatus;
   }
 
   export namespace Data {
     /**
-     * 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;
 
@@ -1559,12 +1611,13 @@ export namespace RefundUpdatedWebhookEvent {
       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;
 
@@ -1589,7 +1642,8 @@ export namespace RefundUpdatedWebhookEvent {
       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;
 
@@ -1625,7 +1679,7 @@ export namespace RefundUpdatedWebhookEvent {
        */
       export interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
 
@@ -1640,7 +1694,7 @@ export namespace RefundUpdatedWebhookEvent {
        */
       export interface Membership {
         /**
-         * The internal ID of the membership.
+         * The unique identifier for the membership.
          */
         id: string;
 
@@ -1655,22 +1709,23 @@ export namespace RefundUpdatedWebhookEvent {
        */
       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;
       }
@@ -1690,8 +1745,8 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
   api_version: 'v1';
 
   /**
-   * A membership represents a purchase between a User and a Company for a specific
-   * Product.
+   * A membership represents an active relationship between a user and a product. It
+   * tracks the user's access, billing status, and renewal schedule.
    */
   data: Shared.Membership;
 
@@ -1803,7 +1858,7 @@ export interface WebhookUpdateParams {
 
 export interface WebhookListParams extends CursorPageParams {
   /**
-   * The ID of the company to list webhooks for
+   * The unique identifier of the company to list webhooks for.
    */
   company_id: string;