@whop/sdk 0.0.22 → 0.0.24

package/resources/webhooks.d.mts

@@ -5,12 +5,266 @@ import * as RefundsAPI from "./refunds.mjs";
 import * as SetupIntentsAPI from "./setup-intents.mjs";
 import * as Shared from "./shared.mjs";
 import * as WithdrawalsAPI from "./withdrawals.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Webhooks extends APIResource {
+    /**
+     * Creates a new webhook
+     *
+     * Required permissions:
+     *
+     * - `developer:manage_webhook`
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   url: 'https://example.com/path',
+     * });
+     * ```
+     */
+    create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
+    /**
+     * Retrieves a webhook by ID
+     *
+     * Required permissions:
+     *
+     * - `developer:manage_webhook`
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve(
+     *   'hook_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    /**
+     * Updates a webhook
+     *
+     * Required permissions:
+     *
+     * - `developer:manage_webhook`
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update(
+     *   'hook_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    /**
+     * Lists webhooks for a company
+     *
+     * Required permissions:
+     *
+     * - `developer:manage_webhook`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const webhookListResponse of client.webhooks.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: WebhookListParams, options?: RequestOptions): PagePromise<WebhookListResponsesCursorPage, WebhookListResponse>;
+    /**
+     * Deletes a webhook
+     *
+     * Required permissions:
+     *
+     * - `developer:manage_webhook`
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.delete(
+     *   'hook_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
     unwrap(body: string, { headers, key }: {
         headers: Record<string, string>;
         key?: string;
     }): UnwrapWebhookEvent;
 }
+export type WebhookListResponsesCursorPage = CursorPage<WebhookListResponse>;
+/**
+ * A webhook object, which can be configured to be sent updates about a company
+ */
+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;
+}
+/**
+ * A webhook object, which can be configured to be sent updates about a company
+ */
+export interface WebhookRetrieveResponse {
+    /**
+     * 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 webhook object, which can be configured to be sent updates about a company
+ */
+export interface WebhookUpdateResponse {
+    /**
+     * 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 webhook object, which can be configured to be sent updates about a company
+ */
+export interface WebhookListResponse {
+    /**
+     * 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 URL the webhook events will be sent to
+     */
+    url: string;
+}
+/**
+ * Represents `true` or `false` values.
+ */
+export type WebhookDeleteResponse = boolean;
 export interface InvoiceCreatedWebhookEvent {
     /**
      * A unique ID for every single webhook request
@@ -32,6 +286,10 @@ export interface InvoiceCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'invoice.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface InvoicePaidWebhookEvent {
     /**
@@ -54,6 +312,10 @@ export interface InvoicePaidWebhookEvent {
      * The webhook event type
      */
     type: 'invoice.paid';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface InvoicePastDueWebhookEvent {
     /**
@@ -76,6 +338,10 @@ export interface InvoicePastDueWebhookEvent {
      * The webhook event type
      */
     type: 'invoice.past_due';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface InvoiceVoidedWebhookEvent {
     /**
@@ -98,6 +364,10 @@ export interface InvoiceVoidedWebhookEvent {
      * The webhook event type
      */
     type: 'invoice.voided';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface MembershipActivatedWebhookEvent {
     /**
@@ -121,6 +391,10 @@ export interface MembershipActivatedWebhookEvent {
      * The webhook event type
      */
     type: 'membership.activated';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface MembershipDeactivatedWebhookEvent {
     /**
@@ -144,6 +418,10 @@ export interface MembershipDeactivatedWebhookEvent {
      * The webhook event type
      */
     type: 'membership.deactivated';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface EntryCreatedWebhookEvent {
     /**
@@ -166,6 +444,10 @@ export interface EntryCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'entry.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface EntryApprovedWebhookEvent {
     /**
@@ -188,6 +470,10 @@ export interface EntryApprovedWebhookEvent {
      * The webhook event type
      */
     type: 'entry.approved';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface EntryDeniedWebhookEvent {
     /**
@@ -210,6 +496,10 @@ export interface EntryDeniedWebhookEvent {
      * The webhook event type
      */
     type: 'entry.denied';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface EntryDeletedWebhookEvent {
     /**
@@ -232,6 +522,10 @@ export interface EntryDeletedWebhookEvent {
      * The webhook event type
      */
     type: 'entry.deleted';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface SetupIntentRequiresActionWebhookEvent {
     /**
@@ -255,6 +549,10 @@ export interface SetupIntentRequiresActionWebhookEvent {
      * The webhook event type
      */
     type: 'setup_intent.requires_action';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface SetupIntentSucceededWebhookEvent {
     /**
@@ -278,6 +576,10 @@ export interface SetupIntentSucceededWebhookEvent {
      * The webhook event type
      */
     type: 'setup_intent.succeeded';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface SetupIntentCanceledWebhookEvent {
     /**
@@ -301,6 +603,10 @@ export interface SetupIntentCanceledWebhookEvent {
      * The webhook event type
      */
     type: 'setup_intent.canceled';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface WithdrawalCreatedWebhookEvent {
     /**
@@ -323,6 +629,10 @@ export interface WithdrawalCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'withdrawal.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace WithdrawalCreatedWebhookEvent {
     /**
@@ -348,7 +658,7 @@ export declare namespace WithdrawalCreatedWebhookEvent {
         /**
          * 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_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;
+        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.
          */
@@ -393,10 +703,6 @@ export declare namespace WithdrawalCreatedWebhookEvent {
          * available.
          */
         trace_code: string | null;
-        /**
-         * The type of withdrawal.
-         */
-        withdrawal_type: WithdrawalsAPI.WithdrawalTypes;
     }
     namespace Data {
         /**
@@ -462,6 +768,10 @@ export interface WithdrawalUpdatedWebhookEvent {
      * The webhook event type
      */
     type: 'withdrawal.updated';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace WithdrawalUpdatedWebhookEvent {
     /**
@@ -487,7 +797,7 @@ export declare namespace WithdrawalUpdatedWebhookEvent {
         /**
          * 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_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;
+        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.
          */
@@ -532,10 +842,6 @@ export declare namespace WithdrawalUpdatedWebhookEvent {
          * available.
          */
         trace_code: string | null;
-        /**
-         * The type of withdrawal.
-         */
-        withdrawal_type: WithdrawalsAPI.WithdrawalTypes;
     }
     namespace Data {
         /**
@@ -601,6 +907,10 @@ export interface CourseLessonInteractionCompletedWebhookEvent {
      * The webhook event type
      */
     type: 'course_lesson_interaction.completed';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface PayoutMethodCreatedWebhookEvent {
     /**
@@ -623,6 +933,10 @@ export interface PayoutMethodCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'payout_method.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace PayoutMethodCreatedWebhookEvent {
     /**
@@ -637,6 +951,10 @@ export declare namespace PayoutMethodCreatedWebhookEvent {
          * The company associated with the payout token
          */
         company: Data.Company | null;
+        /**
+         * 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.
@@ -706,6 +1024,10 @@ export interface VerificationSucceededWebhookEvent {
      * The webhook event type
      */
     type: 'verification.succeeded';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace VerificationSucceededWebhookEvent {
     /**
@@ -751,6 +1073,10 @@ export interface PaymentCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'payment.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface PaymentSucceededWebhookEvent {
     /**
@@ -773,6 +1099,10 @@ export interface PaymentSucceededWebhookEvent {
      * The webhook event type
      */
     type: 'payment.succeeded';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface PaymentFailedWebhookEvent {
     /**
@@ -795,6 +1125,10 @@ export interface PaymentFailedWebhookEvent {
      * The webhook event type
      */
     type: 'payment.failed';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface PaymentPendingWebhookEvent {
     /**
@@ -817,6 +1151,10 @@ export interface PaymentPendingWebhookEvent {
      * The webhook event type
      */
     type: 'payment.pending';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface DisputeCreatedWebhookEvent {
     /**
@@ -839,6 +1177,10 @@ export interface DisputeCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'dispute.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface DisputeUpdatedWebhookEvent {
     /**
@@ -861,6 +1203,10 @@ export interface DisputeUpdatedWebhookEvent {
      * The webhook event type
      */
     type: 'dispute.updated';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export interface RefundCreatedWebhookEvent {
     /**
@@ -883,6 +1229,10 @@ export interface RefundCreatedWebhookEvent {
      * The webhook event type
      */
     type: 'refund.created';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace RefundCreatedWebhookEvent {
     /**
@@ -1072,6 +1422,10 @@ export interface RefundUpdatedWebhookEvent {
      * The webhook event type
      */
     type: 'refund.updated';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    company_id?: string | null;
 }
 export declare namespace RefundUpdatedWebhookEvent {
     /**
@@ -1262,9 +1616,81 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
      * The webhook event type
      */
     type: 'membership.cancel_at_period_end_changed';
+    /**
+     * The company ID that this webhook event is associated with
+     */
+    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 interface WebhookCreateParams {
+    /**
+     * The URL to send the webhook to.
+     */
+    url: string;
+    /**
+     * The different API versions
+     */
+    api_version?: 'v1' | 'v2' | 'v5' | 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
+     * sub-merchants (child companies).
+     */
+    child_resource_events?: boolean | null;
+    /**
+     * Whether or not the webhook is enabled.
+     */
+    enabled?: boolean | null;
+    /**
+     * 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;
+    /**
+     * The resource to create the webhook for. By default this will use current company
+     */
+    resource_id?: string | null;
+}
+export interface WebhookUpdateParams {
+    /**
+     * The different API versions
+     */
+    api_version?: 'v1' | 'v2' | 'v5' | null;
+    /**
+     * Whether or not to send events for child resources.
+     */
+    child_resource_events?: boolean | null;
+    /**
+     * Whether or not the webhook is enabled.
+     */
+    enabled?: boolean | null;
+    /**
+     * 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;
+    /**
+     * The URL to send the webhook to.
+     */
+    url?: string | null;
+}
+export interface WebhookListParams extends CursorPageParams {
+    /**
+     * The ID of the company to list webhooks for
+     */
+    company_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+}
 export declare namespace Webhooks {
-    export { 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, };
+    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, };
 }
 //# sourceMappingURL=webhooks.d.mts.map