@whop/sdk 0.0.27 → 0.0.29

package/resources/webhooks.d.ts

@@ -1,4 +1,5 @@
 import { APIResource } from "../core/resource.js";
+import * as DisputeAlertsAPI from "./dispute-alerts.js";
 import * as DisputesAPI from "./disputes.js";
 import * as PaymentsAPI from "./payments.js";
 import * as PayoutMethodsAPI from "./payout-methods.js";
@@ -27,7 +28,7 @@ export declare class Webhooks extends APIResource {
      */
     create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
     /**
-     * Retrieves a webhook by ID
+     * Retrieves the details of an existing webhook.
      *
      * Required permissions:
      *
@@ -57,7 +58,8 @@ export declare class Webhooks extends APIResource {
      */
     update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
     /**
-     * Lists webhooks for a company
+     * Returns a paginated list of webhook endpoints configured for a company, ordered
+     * by most recently created.
      *
      * Required permissions:
      *
@@ -109,13 +111,13 @@ export interface 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;
     /**
@@ -123,30 +125,30 @@ export interface Webhook {
      */
     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;
 }
 /**
  * The different event types available
  */
-export type WebhookEvent = 'invoice.created' | 'invoice.paid' | 'invoice.past_due' | 'invoice.voided' | 'membership.activated' | 'membership.deactivated' | 'entry.created' | 'entry.approved' | 'entry.denied' | 'entry.deleted' | 'setup_intent.requires_action' | 'setup_intent.succeeded' | 'setup_intent.canceled' | 'withdrawal.created' | 'withdrawal.updated' | 'course_lesson_interaction.completed' | 'payout_method.created' | 'verification.succeeded' | 'payment.created' | 'payment.succeeded' | 'payment.failed' | 'payment.pending' | 'dispute.created' | 'dispute.updated' | 'refund.created' | 'refund.updated' | 'membership.cancel_at_period_end_changed';
+export type WebhookEvent = 'invoice.created' | 'invoice.paid' | 'invoice.past_due' | 'invoice.voided' | 'membership.activated' | 'membership.deactivated' | 'entry.created' | 'entry.approved' | 'entry.denied' | 'entry.deleted' | 'setup_intent.requires_action' | 'setup_intent.succeeded' | 'setup_intent.canceled' | 'withdrawal.created' | 'withdrawal.updated' | 'course_lesson_interaction.completed' | 'payout_method.created' | 'verification.succeeded' | 'payment.created' | 'payment.succeeded' | 'payment.failed' | 'payment.pending' | 'dispute.created' | 'dispute.updated' | 'refund.created' | 'refund.updated' | 'dispute_alert.created' | 'membership.cancel_at_period_end_changed';
 /**
  * A webhook endpoint that receives event notifications for a company via HTTP
  * POST.
@@ -157,13 +159,13 @@ export interface WebhookCreateResponse {
      */
     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;
     /**
@@ -171,27 +173,28 @@ export interface WebhookCreateResponse {
      */
     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;
 }
@@ -205,13 +208,13 @@ export interface WebhookListResponse {
      */
     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;
     /**
@@ -219,15 +222,15 @@ export interface WebhookListResponse {
      */
     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;
 }
@@ -245,7 +248,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;
     /**
@@ -271,7 +276,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;
     /**
@@ -297,7 +304,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;
     /**
@@ -323,7 +332,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;
     /**
@@ -507,7 +518,8 @@ export interface SetupIntentRequiresActionWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * 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.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -533,7 +545,8 @@ export interface SetupIntentSucceededWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * 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.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -559,7 +572,8 @@ export interface SetupIntentCanceledWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * 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.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -585,8 +599,8 @@ export interface WithdrawalCreatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A withdrawal represents a request to transfer funds from a company's ledger
-     * account to an external payout method.
+     * A withdrawal represents a request to transfer funds from a ledger account to an
+     * external payout method.
      */
     data: WithdrawalsAPI.Withdrawal;
     /**
@@ -612,8 +626,8 @@ export interface WithdrawalUpdatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A withdrawal represents a request to transfer funds from a company's ledger
-     * account to an external payout method.
+     * A withdrawal represents a request to transfer funds from a ledger account to an
+     * external payout method.
      */
     data: WithdrawalsAPI.Withdrawal;
     /**
@@ -639,7 +653,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;
     /**
@@ -665,7 +680,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;
     /**
@@ -683,7 +699,8 @@ export interface PayoutMethodCreatedWebhookEvent {
 }
 export declare 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.
      */
     interface Data {
         /**
@@ -691,12 +708,13 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
          */
         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;
         /**
@@ -704,31 +722,35 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
          */
         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;
     }
     namespace Data {
         /**
-         * The company associated with the payout token
+         * The company associated with this payout destination. Null if not linked to a
+         * specific company.
          */
         interface Company {
             /**
@@ -737,7 +759,8 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
             id: string;
         }
         /**
-         * The payout destination associated with the payout token
+         * The payout destination configuration linked to this token. Null if not yet
+         * configured.
          */
         interface Destination {
             /**
@@ -765,7 +788,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;
     /**
@@ -783,7 +807,8 @@ export interface VerificationSucceededWebhookEvent {
 }
 export declare 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.
      */
     interface Data {
         /**
@@ -795,11 +820,12 @@ export declare 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;
     }
@@ -814,8 +840,8 @@ export interface PaymentCreatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A payment represents a completed or attempted charge for a membership. Payments
-     * track the amount, status, currency, and payment method used.
+     * A payment represents a completed or attempted charge. Payments track the amount,
+     * status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -841,8 +867,8 @@ export interface PaymentSucceededWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A payment represents a completed or attempted charge for a membership. Payments
-     * track the amount, status, currency, and payment method used.
+     * A payment represents a completed or attempted charge. Payments track the amount,
+     * status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -868,8 +894,8 @@ export interface PaymentFailedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A payment represents a completed or attempted charge for a membership. Payments
-     * track the amount, status, currency, and payment method used.
+     * A payment represents a completed or attempted charge. Payments track the amount,
+     * status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -895,8 +921,8 @@ export interface PaymentPendingWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A payment represents a completed or attempted charge for a membership. Payments
-     * track the amount, status, currency, and payment method used.
+     * A payment represents a completed or attempted charge. Payments track the amount,
+     * status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -1004,8 +1030,8 @@ export declare namespace RefundCreatedWebhookEvent {
          */
         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;
         /**
@@ -1013,19 +1039,21 @@ export declare namespace RefundCreatedWebhookEvent {
          */
         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;
         /**
@@ -1037,17 +1065,20 @@ export declare 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;
     }
     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.
          */
         interface Payment {
             /**
@@ -1063,7 +1094,8 @@ export declare 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;
             /**
@@ -1087,7 +1119,8 @@ export declare 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;
             /**
@@ -1147,15 +1180,16 @@ export declare namespace RefundCreatedWebhookEvent {
                  */
                 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;
             }
@@ -1200,8 +1234,8 @@ export declare namespace RefundUpdatedWebhookEvent {
          */
         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;
         /**
@@ -1209,19 +1243,21 @@ export declare namespace RefundUpdatedWebhookEvent {
          */
         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;
         /**
@@ -1233,17 +1269,240 @@ export declare 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;
     }
     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.
+         */
+        interface Payment {
+            /**
+             * The unique identifier for the payment.
+             */
+            id: string;
+            /**
+             * The reason why a specific payment was billed
+             */
+            billing_reason: PaymentsAPI.BillingReasons | null;
+            /**
+             * Possible card brands that a payment token can have
+             */
+            card_brand: PaymentsAPI.CardBrands | null;
+            /**
+             * 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.
+             */
+            created_at: string;
+            /**
+             * The available currencies on the platform
+             */
+            currency: Shared.Currency | null;
+            /**
+             * When an alert came in that this transaction will be disputed
+             */
+            dispute_alerted_at: string | null;
+            /**
+             * The member attached to this payment.
+             */
+            member: Payment.Member | null;
+            /**
+             * The membership attached to this payment.
+             */
+            membership: Payment.Membership | null;
+            /**
+             * 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;
+            /**
+             * The different types of payment methods that can be used.
+             */
+            payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
+            /**
+             * The subtotal to show to the creator (excluding buyer fees).
+             */
+            subtotal: number | null;
+            /**
+             * The total to show to the creator (excluding buyer fees).
+             */
+            total: number | null;
+            /**
+             * The total in USD to show to the creator (excluding buyer fees).
+             */
+            usd_total: number | null;
+            /**
+             * The user that made this payment.
+             */
+            user: Payment.User | null;
+        }
+        namespace Payment {
+            /**
+             * The member attached to this payment.
+             */
+            interface Member {
+                /**
+                 * The unique identifier for the company member.
+                 */
+                id: string;
+                /**
+                 * The phone number for the member, if available.
+                 */
+                phone: string | null;
+            }
+            /**
+             * The membership attached to this payment.
+             */
+            interface Membership {
+                /**
+                 * The unique identifier for the membership.
+                 */
+                id: string;
+                /**
+                 * The state of the membership.
+                 */
+                status: Shared.MembershipStatus;
+            }
+            /**
+             * The user that made this payment.
+             */
+            interface User {
+                /**
+                 * The unique identifier for the user.
+                 */
+                id: string;
+                /**
+                 * The user's email address. Requires the member:email:read permission to access.
+                 * Null if not authorized.
+                 */
+                email: string | null;
+                /**
+                 * The user's display name shown on their public profile.
+                 */
+                name: string | null;
+                /**
+                 * The user's unique username shown on their public profile.
+                 */
+                username: string;
+            }
+        }
+    }
+}
+export interface DisputeAlertCreatedWebhookEvent {
+    /**
+     * A unique ID for every single webhook request
+     */
+    id: string;
+    /**
+     * The API version for this webhook
+     */
+    api_version: 'v1';
+    /**
+     * A dispute alert represents an early warning notification from a payment
+     * processor about a potential dispute or chargeback.
+     */
+    data: DisputeAlertCreatedWebhookEvent.Data;
+    /**
+     * The timestamp in ISO 8601 format that the webhook was sent at on the server
+     */
+    timestamp: string;
+    /**
+     * The webhook event type
+     */
+    type: 'dispute_alert.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
+}
+export declare namespace DisputeAlertCreatedWebhookEvent {
+    /**
+     * A dispute alert represents an early warning notification from a payment
+     * processor about a potential dispute or chargeback.
+     */
+    interface Data {
+        /**
+         * The unique identifier of the dispute alert.
+         */
+        id: string;
+        /**
+         * The type of the dispute alert.
+         */
+        alert_type: DisputeAlertsAPI.DisputeAlertType;
+        /**
+         * The alerted amount in the specified currency.
+         */
+        amount: number;
+        /**
+         * Whether this alert incurs a charge.
+         */
+        charge_for_alert: boolean;
+        /**
+         * The time the dispute alert was created.
+         */
+        created_at: string;
+        /**
+         * The three-letter ISO currency code for the alerted amount.
+         */
+        currency: Shared.Currency;
+        /**
+         * The dispute associated with the dispute alert.
+         */
+        dispute: Data.Dispute | null;
+        /**
+         * The payment associated with the dispute alert.
+         */
+        payment: Data.Payment | null;
+        /**
+         * The date of the original transaction.
+         */
+        transaction_date: string | null;
+    }
+    namespace Data {
+        /**
+         * The dispute associated with the dispute alert.
+         */
+        interface Dispute {
+            /**
+             * The unique identifier for the dispute.
+             */
+            id: string;
+            /**
+             * The disputed amount in the specified currency, formatted as a decimal.
+             */
+            amount: number;
+            /**
+             * The datetime the dispute was created.
+             */
+            created_at: string | null;
+            /**
+             * The three-letter ISO currency code for the disputed amount.
+             */
+            currency: Shared.Currency;
+            /**
+             * A human-readable reason for the dispute.
+             */
+            reason: string | null;
+            /**
+             * The current status of the dispute lifecycle, such as needs_response,
+             * under_review, won, or lost.
+             */
+            status: DisputesAPI.DisputeStatuses;
+        }
+        /**
+         * The payment associated with the dispute alert.
          */
         interface Payment {
             /**
@@ -1259,7 +1518,8 @@ export declare 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;
             /**
@@ -1283,7 +1543,8 @@ export declare 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;
             /**
@@ -1343,15 +1604,16 @@ export declare namespace RefundUpdatedWebhookEvent {
                  */
                 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;
             }
@@ -1385,7 +1647,7 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
      */
     company_id?: string | null;
 }
-export type UnwrapWebhookEvent = InvoiceCreatedWebhookEvent | InvoicePaidWebhookEvent | InvoicePastDueWebhookEvent | InvoiceVoidedWebhookEvent | MembershipActivatedWebhookEvent | MembershipDeactivatedWebhookEvent | EntryCreatedWebhookEvent | EntryApprovedWebhookEvent | EntryDeniedWebhookEvent | EntryDeletedWebhookEvent | SetupIntentRequiresActionWebhookEvent | SetupIntentSucceededWebhookEvent | SetupIntentCanceledWebhookEvent | WithdrawalCreatedWebhookEvent | WithdrawalUpdatedWebhookEvent | CourseLessonInteractionCompletedWebhookEvent | PayoutMethodCreatedWebhookEvent | VerificationSucceededWebhookEvent | PaymentCreatedWebhookEvent | PaymentSucceededWebhookEvent | PaymentFailedWebhookEvent | PaymentPendingWebhookEvent | DisputeCreatedWebhookEvent | DisputeUpdatedWebhookEvent | RefundCreatedWebhookEvent | RefundUpdatedWebhookEvent | MembershipCancelAtPeriodEndChangedWebhookEvent;
+export type UnwrapWebhookEvent = InvoiceCreatedWebhookEvent | InvoicePaidWebhookEvent | InvoicePastDueWebhookEvent | InvoiceVoidedWebhookEvent | MembershipActivatedWebhookEvent | MembershipDeactivatedWebhookEvent | EntryCreatedWebhookEvent | EntryApprovedWebhookEvent | EntryDeniedWebhookEvent | EntryDeletedWebhookEvent | SetupIntentRequiresActionWebhookEvent | SetupIntentSucceededWebhookEvent | SetupIntentCanceledWebhookEvent | WithdrawalCreatedWebhookEvent | WithdrawalUpdatedWebhookEvent | CourseLessonInteractionCompletedWebhookEvent | PayoutMethodCreatedWebhookEvent | VerificationSucceededWebhookEvent | PaymentCreatedWebhookEvent | PaymentSucceededWebhookEvent | PaymentFailedWebhookEvent | PaymentPendingWebhookEvent | DisputeCreatedWebhookEvent | DisputeUpdatedWebhookEvent | RefundCreatedWebhookEvent | RefundUpdatedWebhookEvent | DisputeAlertCreatedWebhookEvent | MembershipCancelAtPeriodEndChangedWebhookEvent;
 export interface WebhookCreateParams {
     /**
      * The URL to send the webhook to.
@@ -1438,7 +1700,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;
     /**
@@ -1455,6 +1717,6 @@ export interface WebhookListParams extends CursorPageParams {
     last?: number | null;
 }
 export declare namespace Webhooks {
-    export { type APIVersion as APIVersion, type Webhook as Webhook, type WebhookEvent as WebhookEvent, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent, type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent, type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent, type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent, type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent, type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent, type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent, type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent, type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent, type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent, type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent, type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent, type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent, type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent, type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent, type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent, type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent, type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent, type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent, type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent, type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent, type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent, type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent, type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent, type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent, type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent, type MembershipCancelAtPeriodEndChangedWebhookEvent as MembershipCancelAtPeriodEndChangedWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, type WebhookListResponsesCursorPage as WebhookListResponsesCursorPage, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, };
+    export { type APIVersion as APIVersion, type Webhook as Webhook, type WebhookEvent as WebhookEvent, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent, type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent, type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent, type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent, type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent, type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent, type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent, type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent, type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent, type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent, type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent, type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent, type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent, type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent, type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent, type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent, type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent, type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent, type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent, type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent, type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent, type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent, type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent, type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent, type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent, type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent, type DisputeAlertCreatedWebhookEvent as DisputeAlertCreatedWebhookEvent, type MembershipCancelAtPeriodEndChangedWebhookEvent as MembershipCancelAtPeriodEndChangedWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, type WebhookListResponsesCursorPage as WebhookListResponsesCursorPage, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, };
 }
 //# sourceMappingURL=webhooks.d.ts.map