@whop/sdk 0.0.7 → 0.0.8

package/src/resources/webhooks.ts

@@ -2,6 +2,8 @@
 
 import { APIResource } from '../core/resource';
 import * as DisputesAPI from './disputes';
+import * as PaymentsAPI from './payments';
+import * as RefundsAPI from './refunds';
 import * as Shared from './shared';
 import { Webhook } from 'standardwebhooks';
 
@@ -454,6 +456,462 @@ export interface DisputeUpdatedWebhookEvent {
   type: 'dispute.updated';
 }
 
+export interface RefundCreatedWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * An object representing a refund made on a payment.
+   */
+  data: RefundCreatedWebhookEvent.Data;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'refund.created';
+}
+
+export namespace RefundCreatedWebhookEvent {
+  /**
+   * An object representing a refund made on a payment.
+   */
+  export interface Data {
+    /**
+     * The ID of the refund.
+     */
+    id: string;
+
+    /**
+     * The amount of the refund.
+     */
+    amount: number;
+
+    /**
+     * The time the refund was created.
+     */
+    created_at: string;
+
+    /**
+     * The currency of the refund.
+     */
+    currency: Shared.Currency;
+
+    /**
+     * The payment associated with the refund.
+     */
+    payment: Data.Payment | null;
+
+    /**
+     * The provider of the refund.
+     */
+    provider: RefundsAPI.PaymentProvider;
+
+    /**
+     * The time the refund was created by the provider.
+     */
+    provider_created_at: string | null;
+
+    /**
+     * The status of the refund reference.
+     */
+    reference_status: RefundsAPI.RefundReferenceStatus | null;
+
+    /**
+     * The type of refund reference that was made available by the payment provider.
+     */
+    reference_type: RefundsAPI.RefundReferenceType | null;
+
+    /**
+     * The value of the reference.
+     */
+    reference_value: string | null;
+
+    /**
+     * The status of the refund.
+     */
+    status: RefundsAPI.RefundStatus;
+  }
+
+  export namespace Data {
+    /**
+     * The payment associated with the refund.
+     */
+    export interface Payment {
+      /**
+       * The payment ID
+       */
+      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 4 digits of the card used to make the payment.
+       */
+      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 datetime the payment was paid
+       */
+      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;
+    }
+
+    export namespace Payment {
+      /**
+       * The member attached to this payment.
+       */
+      export interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+
+        /**
+         * The phone number for the member, if available.
+         */
+        phone: string | null;
+      }
+
+      /**
+       * The membership attached to this payment.
+       */
+      export interface Membership {
+        /**
+         * The internal ID of the membership.
+         */
+        id: string;
+
+        /**
+         * The state of the membership.
+         */
+        status: Shared.MembershipStatus;
+      }
+
+      /**
+       * The user that made this payment.
+       */
+      export interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+
+        /**
+         * The email of the user
+         */
+        email: string | null;
+
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+      }
+    }
+  }
+}
+
+export interface RefundUpdatedWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * An object representing a refund made on a payment.
+   */
+  data: RefundUpdatedWebhookEvent.Data;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'refund.updated';
+}
+
+export namespace RefundUpdatedWebhookEvent {
+  /**
+   * An object representing a refund made on a payment.
+   */
+  export interface Data {
+    /**
+     * The ID of the refund.
+     */
+    id: string;
+
+    /**
+     * The amount of the refund.
+     */
+    amount: number;
+
+    /**
+     * The time the refund was created.
+     */
+    created_at: string;
+
+    /**
+     * The currency of the refund.
+     */
+    currency: Shared.Currency;
+
+    /**
+     * The payment associated with the refund.
+     */
+    payment: Data.Payment | null;
+
+    /**
+     * The provider of the refund.
+     */
+    provider: RefundsAPI.PaymentProvider;
+
+    /**
+     * The time the refund was created by the provider.
+     */
+    provider_created_at: string | null;
+
+    /**
+     * The status of the refund reference.
+     */
+    reference_status: RefundsAPI.RefundReferenceStatus | null;
+
+    /**
+     * The type of refund reference that was made available by the payment provider.
+     */
+    reference_type: RefundsAPI.RefundReferenceType | null;
+
+    /**
+     * The value of the reference.
+     */
+    reference_value: string | null;
+
+    /**
+     * The status of the refund.
+     */
+    status: RefundsAPI.RefundStatus;
+  }
+
+  export namespace Data {
+    /**
+     * The payment associated with the refund.
+     */
+    export interface Payment {
+      /**
+       * The payment ID
+       */
+      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 4 digits of the card used to make the payment.
+       */
+      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 datetime the payment was paid
+       */
+      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;
+    }
+
+    export namespace Payment {
+      /**
+       * The member attached to this payment.
+       */
+      export interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+
+        /**
+         * The phone number for the member, if available.
+         */
+        phone: string | null;
+      }
+
+      /**
+       * The membership attached to this payment.
+       */
+      export interface Membership {
+        /**
+         * The internal ID of the membership.
+         */
+        id: string;
+
+        /**
+         * The state of the membership.
+         */
+        status: Shared.MembershipStatus;
+      }
+
+      /**
+       * The user that made this payment.
+       */
+      export interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+
+        /**
+         * The email of the user
+         */
+        email: string | null;
+
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+      }
+    }
+  }
+}
+
 export type UnwrapWebhookEvent =
   | InvoiceCreatedWebhookEvent
   | InvoicePaidWebhookEvent
@@ -470,7 +928,9 @@ export type UnwrapWebhookEvent =
   | PaymentFailedWebhookEvent
   | PaymentPendingWebhookEvent
   | DisputeCreatedWebhookEvent
-  | DisputeUpdatedWebhookEvent;
+  | DisputeUpdatedWebhookEvent
+  | RefundCreatedWebhookEvent
+  | RefundUpdatedWebhookEvent;
 
 export declare namespace Webhooks {
   export {
@@ -490,6 +950,8 @@ export declare namespace Webhooks {
     type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent,
     type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent,
     type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent,
+    type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent,
+    type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
 }