@whop/sdk 0.0.25 → 0.0.27

package/resources/webhooks.d.mts

@@ -1,9 +1,11 @@
 import { APIResource } from "../core/resource.mjs";
 import * as DisputesAPI from "./disputes.mjs";
 import * as PaymentsAPI from "./payments.mjs";
+import * as PayoutMethodsAPI from "./payout-methods.mjs";
 import * as RefundsAPI from "./refunds.mjs";
 import * as SetupIntentsAPI from "./setup-intents.mjs";
 import * as Shared from "./shared.mjs";
+import * as VerificationsAPI from "./verifications.mjs";
 import * as WithdrawalsAPI from "./withdrawals.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
@@ -38,7 +40,7 @@ export declare class Webhooks extends APIResource {
      * );
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<Webhook>;
     /**
      * Updates a webhook
      *
@@ -53,7 +55,7 @@ export declare class Webhooks extends APIResource {
      * );
      * ```
      */
-    update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
     /**
      * Lists webhooks for a company
      *
@@ -94,64 +96,22 @@ export declare class Webhooks extends APIResource {
 }
 export type WebhookListResponsesCursorPage = CursorPage<WebhookListResponse>;
 /**
- * A webhook object, which can be configured to be sent updates about a company
+ * The different API versions
  */
-export interface WebhookCreateResponse {
-    /**
-     * The ID of the webhook
-     */
-    id: string;
-    /**
-     * The API version for this webhook
-     */
-    api_version: 'v1' | 'v2' | 'v5';
-    /**
-     * 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).
-     */
-    child_resource_events: boolean;
-    /**
-     * The timestamp of when the webhook was created
-     */
-    created_at: string;
-    /**
-     * Whether or not this webhook is turned on or not
-     */
-    enabled: boolean;
-    /**
-     * The number of events this webhooks is configured to receive
-     */
-    events: Array<'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'>;
-    /**
-     * The resource ID
-     */
-    resource_id: string;
-    /**
-     * The list of events that can be tested with this webhook
-     */
-    testable_events: Array<'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'>;
-    /**
-     * The URL the webhook events will be sent to
-     */
-    url: string;
-    /**
-     * A unique secret key that will be sent with each webhook event
-     */
-    webhook_secret: string;
-}
+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 WebhookRetrieveResponse {
+export interface Webhook {
     /**
-     * The ID of the webhook
+     * The unique identifier for the webhook.
      */
     id: string;
     /**
      * The API version for this webhook
      */
-    api_version: 'v1' | 'v2' | 'v5';
+    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
@@ -159,7 +119,7 @@ export interface WebhookRetrieveResponse {
      */
     child_resource_events: boolean;
     /**
-     * The timestamp of when the webhook was created
+     * The datetime the webhook was created.
      */
     created_at: string;
     /**
@@ -169,7 +129,7 @@ export interface WebhookRetrieveResponse {
     /**
      * The number of events this webhooks is configured to receive
      */
-    events: Array<'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'>;
+    events: Array<WebhookEvent>;
     /**
      * The resource ID
      */
@@ -177,24 +137,29 @@ export interface WebhookRetrieveResponse {
     /**
      * The list of events that can be tested with this webhook
      */
-    testable_events: Array<'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'>;
+    testable_events: Array<WebhookEvent>;
     /**
      * The URL the webhook events will be sent to
      */
     url: string;
 }
 /**
- * A webhook object, which can be configured to be sent updates about a company
+ * The different event types available
  */
-export interface WebhookUpdateResponse {
+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';
+/**
+ * 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
      */
-    api_version: 'v1' | 'v2' | 'v5';
+    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
@@ -202,7 +167,7 @@ export interface WebhookUpdateResponse {
      */
     child_resource_events: boolean;
     /**
-     * The timestamp of when the webhook was created
+     * The datetime the webhook was created.
      */
     created_at: string;
     /**
@@ -212,7 +177,7 @@ export interface WebhookUpdateResponse {
     /**
      * The number of events this webhooks is configured to receive
      */
-    events: Array<'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'>;
+    events: Array<WebhookEvent>;
     /**
      * The resource ID
      */
@@ -220,24 +185,29 @@ export interface WebhookUpdateResponse {
     /**
      * The list of events that can be tested with this webhook
      */
-    testable_events: Array<'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'>;
+    testable_events: Array<WebhookEvent>;
     /**
      * The URL the webhook events will be sent to
      */
     url: string;
+    /**
+     * A unique secret key that will be sent with each webhook event
+     */
+    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
      */
-    api_version: 'v1' | 'v2' | 'v5';
+    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
@@ -245,7 +215,7 @@ export interface WebhookListResponse {
      */
     child_resource_events: boolean;
     /**
-     * The timestamp of when the webhook was created
+     * The datetime the webhook was created.
      */
     created_at: string;
     /**
@@ -255,7 +225,7 @@ export interface WebhookListResponse {
     /**
      * The number of events this webhooks is configured to receive
      */
-    events: Array<'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'>;
+    events: Array<WebhookEvent>;
     /**
      * The URL the webhook events will be sent to
      */
@@ -379,8 +349,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;
     /**
@@ -406,8 +376,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;
     /**
@@ -433,7 +403,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;
     /**
@@ -459,7 +429,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;
     /**
@@ -485,7 +455,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;
     /**
@@ -511,7 +481,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;
     /**
@@ -537,8 +507,7 @@ 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 without making a purchase.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -564,8 +533,7 @@ 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 without making a purchase.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -591,8 +559,7 @@ 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 without making a purchase.
      */
     data: SetupIntentsAPI.SetupIntent;
     /**
@@ -618,9 +585,10 @@ export interface WithdrawalCreatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A withdrawal request.
+     * A withdrawal represents a request to transfer funds from a company's ledger
+     * account to an external payout method.
      */
-    data: WithdrawalCreatedWebhookEvent.Data;
+    data: WithdrawalsAPI.Withdrawal;
     /**
      * The timestamp in ISO 8601 format that the webhook was sent at on the server
      */
@@ -634,119 +602,6 @@ export interface WithdrawalCreatedWebhookEvent {
      */
     company_id?: string | null;
 }
-export declare namespace WithdrawalCreatedWebhookEvent {
-    /**
-     * A withdrawal request.
-     */
-    interface Data {
-        /**
-         * Internal ID of the withdrawal request.
-         */
-        id: string;
-        /**
-         * How much money was attempted to be withdrawn, in a float type.
-         */
-        amount: number;
-        /**
-         * When the withdrawal request was created.
-         */
-        created_at: string;
-        /**
-         * The currency of the withdrawal request.
-         */
-        currency: Shared.Currency;
-        /**
-         * The different error codes a payout can be in.
-         */
-        error_code: 'account_closed' | 'account_does_not_exist' | 'account_information_invalid' | 'account_number_invalid_region' | 'account_frozen' | 'account_lookup_failed' | 'account_not_found' | 'amount_out_of_bounds' | 'attributes_not_validated' | 'b2b_payments_prohibited' | 'bank_statement_required' | 'compliance_review' | 'currency_not_supported' | 'deposit_canceled' | 'deposit_failed' | 'deposit_rejected' | 'destination_unavailable' | 'exceeded_account_limit' | 'expired_quote' | 'generic_payout_error' | 'technical_problem' | 'identification_number_invalid' | 'invalid_account_number' | 'invalid_bank_code' | 'invalid_beneficiary' | 'invalid_mailing_address' | 'invalid_branch_number' | 'invalid_branch_code' | 'invalid_phone_number' | 'invalid_routing_number' | 'invalid_swift_code' | 'invalid_company_details' | 'manual_cancelation' | 'misc_error' | 'missing_city_and_country' | 'missing_phone_number' | 'missing_remittance_info' | 'payee_name_invalid' | 'receiving_account_locked' | 'rejected_by_compliance' | 'rtp_not_supported' | 'non_transaction_account' | 'source_token_insufficient_funds' | 'ssn_invalid' | 'wallet_screenshot_required' | 'unsupported_region' | null;
-        /**
-         * The error message for the withdrawal, if any.
-         */
-        error_message: string | null;
-        /**
-         * The estimated availability date for the withdrawal, if any.
-         */
-        estimated_availability: string | null;
-        /**
-         * The fee amount that was charged for the withdrawal. This is in the same currency
-         * as the withdrawal amount.
-         */
-        fee_amount: number;
-        /**
-         * The different fee types for a withdrawal.
-         */
-        fee_type: WithdrawalsAPI.WithdrawalFeeTypes | null;
-        /**
-         * The ledger account associated with the withdrawal.
-         */
-        ledger_account: Data.LedgerAccount;
-        /**
-         * The markup fee that was charged for the withdrawal. This is in the same currency
-         * as the withdrawal amount. This only applies to platform accounts using Whop
-         * Rails.
-         */
-        markup_fee: number;
-        /**
-         * The payout token used for the withdrawal, if applicable.
-         */
-        payout_token: Data.PayoutToken | null;
-        /**
-         * The speed of the withdrawal.
-         */
-        speed: WithdrawalsAPI.WithdrawalSpeeds;
-        /**
-         * Status of the withdrawal.
-         */
-        status: WithdrawalsAPI.WithdrawalStatus;
-        /**
-         * The trace code for the payout, if applicable. Provided on ACH transactions when
-         * available.
-         */
-        trace_code: string | null;
-    }
-    namespace Data {
-        /**
-         * The ledger account associated with the withdrawal.
-         */
-        interface LedgerAccount {
-            /**
-             * The ID of the LedgerAccount.
-             */
-            id: string;
-            /**
-             * The ID of the company associated with this ledger account.
-             */
-            company_id: string | null;
-        }
-        /**
-         * The payout token used for the withdrawal, if applicable.
-         */
-        interface PayoutToken {
-            /**
-             * The ID of the payout token
-             */
-            id: string;
-            /**
-             * The date and time 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.
-             */
-            destination_currency_code: string;
-            /**
-             * 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.
-             */
-            nickname: string | null;
-            /**
-             * The name of the payer associated with the payout token.
-             */
-            payer_name: string | null;
-        }
-    }
-}
 export interface WithdrawalUpdatedWebhookEvent {
     /**
      * A unique ID for every single webhook request
@@ -757,9 +612,10 @@ export interface WithdrawalUpdatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * A withdrawal request.
+     * A withdrawal represents a request to transfer funds from a company's ledger
+     * account to an external payout method.
      */
-    data: WithdrawalUpdatedWebhookEvent.Data;
+    data: WithdrawalsAPI.Withdrawal;
     /**
      * The timestamp in ISO 8601 format that the webhook was sent at on the server
      */
@@ -773,119 +629,6 @@ export interface WithdrawalUpdatedWebhookEvent {
      */
     company_id?: string | null;
 }
-export declare namespace WithdrawalUpdatedWebhookEvent {
-    /**
-     * A withdrawal request.
-     */
-    interface Data {
-        /**
-         * Internal ID of the withdrawal request.
-         */
-        id: string;
-        /**
-         * How much money was attempted to be withdrawn, in a float type.
-         */
-        amount: number;
-        /**
-         * When the withdrawal request was created.
-         */
-        created_at: string;
-        /**
-         * The currency of the withdrawal request.
-         */
-        currency: Shared.Currency;
-        /**
-         * The different error codes a payout can be in.
-         */
-        error_code: 'account_closed' | 'account_does_not_exist' | 'account_information_invalid' | 'account_number_invalid_region' | 'account_frozen' | 'account_lookup_failed' | 'account_not_found' | 'amount_out_of_bounds' | 'attributes_not_validated' | 'b2b_payments_prohibited' | 'bank_statement_required' | 'compliance_review' | 'currency_not_supported' | 'deposit_canceled' | 'deposit_failed' | 'deposit_rejected' | 'destination_unavailable' | 'exceeded_account_limit' | 'expired_quote' | 'generic_payout_error' | 'technical_problem' | 'identification_number_invalid' | 'invalid_account_number' | 'invalid_bank_code' | 'invalid_beneficiary' | 'invalid_mailing_address' | 'invalid_branch_number' | 'invalid_branch_code' | 'invalid_phone_number' | 'invalid_routing_number' | 'invalid_swift_code' | 'invalid_company_details' | 'manual_cancelation' | 'misc_error' | 'missing_city_and_country' | 'missing_phone_number' | 'missing_remittance_info' | 'payee_name_invalid' | 'receiving_account_locked' | 'rejected_by_compliance' | 'rtp_not_supported' | 'non_transaction_account' | 'source_token_insufficient_funds' | 'ssn_invalid' | 'wallet_screenshot_required' | 'unsupported_region' | null;
-        /**
-         * The error message for the withdrawal, if any.
-         */
-        error_message: string | null;
-        /**
-         * The estimated availability date for the withdrawal, if any.
-         */
-        estimated_availability: string | null;
-        /**
-         * The fee amount that was charged for the withdrawal. This is in the same currency
-         * as the withdrawal amount.
-         */
-        fee_amount: number;
-        /**
-         * The different fee types for a withdrawal.
-         */
-        fee_type: WithdrawalsAPI.WithdrawalFeeTypes | null;
-        /**
-         * The ledger account associated with the withdrawal.
-         */
-        ledger_account: Data.LedgerAccount;
-        /**
-         * The markup fee that was charged for the withdrawal. This is in the same currency
-         * as the withdrawal amount. This only applies to platform accounts using Whop
-         * Rails.
-         */
-        markup_fee: number;
-        /**
-         * The payout token used for the withdrawal, if applicable.
-         */
-        payout_token: Data.PayoutToken | null;
-        /**
-         * The speed of the withdrawal.
-         */
-        speed: WithdrawalsAPI.WithdrawalSpeeds;
-        /**
-         * Status of the withdrawal.
-         */
-        status: WithdrawalsAPI.WithdrawalStatus;
-        /**
-         * The trace code for the payout, if applicable. Provided on ACH transactions when
-         * available.
-         */
-        trace_code: string | null;
-    }
-    namespace Data {
-        /**
-         * The ledger account associated with the withdrawal.
-         */
-        interface LedgerAccount {
-            /**
-             * The ID of the LedgerAccount.
-             */
-            id: string;
-            /**
-             * The ID of the company associated with this ledger account.
-             */
-            company_id: string | null;
-        }
-        /**
-         * The payout token used for the withdrawal, if applicable.
-         */
-        interface PayoutToken {
-            /**
-             * The ID of the payout token
-             */
-            id: string;
-            /**
-             * The date and time 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.
-             */
-            destination_currency_code: string;
-            /**
-             * 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.
-             */
-            nickname: string | null;
-            /**
-             * The name of the payer associated with the payout token.
-             */
-            payer_name: string | null;
-        }
-    }
-}
 export interface CourseLessonInteractionCompletedWebhookEvent {
     /**
      * A unique ID for every single webhook request
@@ -944,7 +687,7 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
      */
     interface Data {
         /**
-         * The ID of the payout token
+         * The unique identifier for the payout token.
          */
         id: string;
         /**
@@ -957,7 +700,7 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
          */
         company: Data.Company | null;
         /**
-         * The date and time the payout token was created
+         * The datetime the payout token was created.
          */
         created_at: string;
         /**
@@ -989,7 +732,7 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
          */
         interface Company {
             /**
-             * The ID (tag) of the company.
+             * The unique identifier for the company.
              */
             id: string;
         }
@@ -1000,7 +743,7 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
             /**
              * The category of the payout destination
              */
-            category: 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
+            category: PayoutMethodsAPI.PayoutDestinationCategory;
             /**
              * The country code of the payout destination
              */
@@ -1044,13 +787,13 @@ export declare namespace VerificationSucceededWebhookEvent {
      */
     interface Data {
         /**
-         * A unique identifier for the verification.
+         * The unique identifier for the verification.
          */
         id: string;
         /**
          * An error code for a verification attempt.
          */
-        last_error_code: 'abandoned' | 'consent_declined' | 'country_not_supported' | 'device_not_supported' | 'document_expired' | 'document_type_not_supported' | 'document_unverified_other' | 'email_unverified_other' | 'email_verification_declined' | 'id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other' | 'phone_unverified_other' | 'phone_verification_declined' | 'selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other' | 'under_supported_age' | null;
+        last_error_code: VerificationsAPI.VerificationErrorCode | null;
         /**
          * The last error reason that occurred during the verification.
          */
@@ -1058,7 +801,7 @@ export declare namespace VerificationSucceededWebhookEvent {
         /**
          * The status of the verification.
          */
-        status: 'requires_input' | 'processing' | 'verified' | 'canceled' | 'created' | 'started' | 'submitted' | 'approved' | 'declined' | 'resubmission_requested' | 'expired' | 'abandoned' | 'review';
+        status: VerificationsAPI.VerificationStatus;
     }
 }
 export interface PaymentCreatedWebhookEvent {
@@ -1071,7 +814,8 @@ export interface PaymentCreatedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * An object representing a receipt for a membership.
+     * A payment represents a completed or attempted charge for a membership. Payments
+     * track the amount, status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -1097,7 +841,8 @@ export interface PaymentSucceededWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * An object representing a receipt for a membership.
+     * A payment represents a completed or attempted charge for a membership. Payments
+     * track the amount, status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -1123,7 +868,8 @@ export interface PaymentFailedWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * An object representing a receipt for a membership.
+     * A payment represents a completed or attempted charge for a membership. Payments
+     * track the amount, status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -1149,7 +895,8 @@ export interface PaymentPendingWebhookEvent {
      */
     api_version: 'v1';
     /**
-     * An object representing a receipt for a membership.
+     * A payment represents a completed or attempted charge for a membership. Payments
+     * track the amount, status, currency, and payment method used.
      */
     data: Shared.Payment;
     /**
@@ -1175,7 +922,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;
     /**
@@ -1201,7 +949,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;
     /**
@@ -1227,7 +976,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;
     /**
@@ -1245,19 +995,21 @@ export interface RefundCreatedWebhookEvent {
 }
 export declare 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.
      */
     interface Data {
         /**
-         * 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;
         /**
@@ -1299,7 +1051,7 @@ export declare namespace RefundCreatedWebhookEvent {
          */
         interface Payment {
             /**
-             * The payment ID
+             * The unique identifier for the payment.
              */
             id: string;
             /**
@@ -1315,7 +1067,7 @@ export declare namespace RefundCreatedWebhookEvent {
              */
             card_last4: string | null;
             /**
-             * The datetime the payment was created
+             * The datetime the payment was created.
              */
             created_at: string;
             /**
@@ -1365,7 +1117,7 @@ export declare namespace RefundCreatedWebhookEvent {
              */
             interface Member {
                 /**
-                 * The ID of the member
+                 * The unique identifier for the company member.
                  */
                 id: string;
                 /**
@@ -1378,7 +1130,7 @@ export declare namespace RefundCreatedWebhookEvent {
              */
             interface Membership {
                 /**
-                 * The internal ID of the membership.
+                 * The unique identifier for the membership.
                  */
                 id: string;
                 /**
@@ -1391,7 +1143,7 @@ export declare namespace RefundCreatedWebhookEvent {
              */
             interface User {
                 /**
-                 * The internal ID of the user.
+                 * The unique identifier for the user.
                  */
                 id: string;
                 /**
@@ -1420,7 +1172,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;
     /**
@@ -1438,19 +1191,21 @@ export interface RefundUpdatedWebhookEvent {
 }
 export declare 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.
      */
     interface Data {
         /**
-         * 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;
         /**
@@ -1492,7 +1247,7 @@ export declare namespace RefundUpdatedWebhookEvent {
          */
         interface Payment {
             /**
-             * The payment ID
+             * The unique identifier for the payment.
              */
             id: string;
             /**
@@ -1508,7 +1263,7 @@ export declare namespace RefundUpdatedWebhookEvent {
              */
             card_last4: string | null;
             /**
-             * The datetime the payment was created
+             * The datetime the payment was created.
              */
             created_at: string;
             /**
@@ -1558,7 +1313,7 @@ export declare namespace RefundUpdatedWebhookEvent {
              */
             interface Member {
                 /**
-                 * The ID of the member
+                 * The unique identifier for the company member.
                  */
                 id: string;
                 /**
@@ -1571,7 +1326,7 @@ export declare namespace RefundUpdatedWebhookEvent {
              */
             interface Membership {
                 /**
-                 * The internal ID of the membership.
+                 * The unique identifier for the membership.
                  */
                 id: string;
                 /**
@@ -1584,7 +1339,7 @@ export declare namespace RefundUpdatedWebhookEvent {
              */
             interface User {
                 /**
-                 * The internal ID of the user.
+                 * The unique identifier for the user.
                  */
                 id: string;
                 /**
@@ -1613,8 +1368,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;
     /**
@@ -1639,7 +1394,7 @@ export interface WebhookCreateParams {
     /**
      * The different API versions
      */
-    api_version?: 'v1' | 'v2' | 'v5' | null;
+    api_version?: APIVersion | null;
     /**
      * 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
@@ -1653,7 +1408,7 @@ export interface WebhookCreateParams {
     /**
      * The events to send the webhook for.
      */
-    events?: Array<'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'> | null;
+    events?: Array<WebhookEvent> | null;
     /**
      * The resource to create the webhook for. By default this will use current company
      */
@@ -1663,7 +1418,7 @@ export interface WebhookUpdateParams {
     /**
      * The different API versions
      */
-    api_version?: 'v1' | 'v2' | 'v5' | null;
+    api_version?: APIVersion | null;
     /**
      * Whether or not to send events for child resources.
      */
@@ -1675,7 +1430,7 @@ export interface WebhookUpdateParams {
     /**
      * The events to send the webhook for.
      */
-    events?: Array<'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'> | null;
+    events?: Array<WebhookEvent> | null;
     /**
      * The URL to send the webhook to.
      */
@@ -1700,6 +1455,6 @@ export interface WebhookListParams extends CursorPageParams {
     last?: number | null;
 }
 export declare namespace Webhooks {
-    export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookRetrieveResponse as WebhookRetrieveResponse, type WebhookUpdateResponse as WebhookUpdateResponse, 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 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.mts.map