@whop/sdk 0.0.15 → 0.0.16

package/src/resources/payment-methods.ts

@@ -53,108 +53,290 @@ export class PaymentMethods extends APIResource {
 export type PaymentMethodListResponsesCursorPage = CursorPage<PaymentMethodListResponse>;
 
 /**
- * A stored payment method used to process payments. This could be a credit/debit
- * card, bank account, PayPal wallet, etc.
+ * A payment method with no additional properties
  */
-export interface PaymentMethodRetrieveResponse {
-  /**
-   * The ID of the payment method
-   */
-  id: string;
+export type PaymentMethodRetrieveResponse =
+  | PaymentMethodRetrieveResponse.BasePaymentMethod
+  | PaymentMethodRetrieveResponse.CardPaymentMethod
+  | PaymentMethodRetrieveResponse.UsBankAccountPaymentMethod;
 
+export namespace PaymentMethodRetrieveResponse {
   /**
-   * The card data associated with the payment method, if its a debit or credit card.
+   * A payment method with no additional properties
    */
-  card: PaymentMethodRetrieveResponse.Card | null;
+  export interface BasePaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
 
-  /**
-   * The date and time the payment method was created
-   */
-  created_at: string;
+    /**
+     * When the payment method was created
+     */
+    created_at: string;
+
+    /**
+     * The type of the payment method
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
+
+    /**
+     * The typename of this object
+     */
+    typename: 'BasePaymentMethod';
+  }
 
   /**
-   * The payment method type of the payment method
+   * The card for the payment method
    */
-  payment_method_type: PaymentsAPI.PaymentMethodTypes;
-}
+  export interface CardPaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
+
+    /**
+     * The card details associated with this payment method
+     */
+    card: CardPaymentMethod.Card;
+
+    /**
+     * When the payment method was created
+     */
+    created_at: string;
+
+    /**
+     * The type of the payment method
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
+
+    /**
+     * The typename of this object
+     */
+    typename: 'CardPaymentMethod';
+  }
+
+  export namespace CardPaymentMethod {
+    /**
+     * The card details associated with this payment method
+     */
+    export interface Card {
+      /**
+       * Possible card brands that a payment token can have
+       */
+      brand: PaymentsAPI.CardBrands | null;
+
+      /**
+       * Card expiration month, like 03 for March.
+       */
+      exp_month: number | null;
+
+      /**
+       * Card expiration year, like 27 for 2027.
+       */
+      exp_year: number | null;
+
+      /**
+       * Last four digits of the card.
+       */
+      last4: string | null;
+    }
+  }
 
-export namespace PaymentMethodRetrieveResponse {
   /**
-   * The card data associated with the payment method, if its a debit or credit card.
+   * The bank account for the payment method
    */
-  export interface Card {
+  export interface UsBankAccountPaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
+
     /**
-     * Possible card brands that a payment token can have
+     * When the payment method was created
      */
-    brand: PaymentsAPI.CardBrands | null;
+    created_at: string;
 
     /**
-     * Card expiration month, like 03 for March.
+     * The type of the payment method
      */
-    exp_month: number | null;
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
 
     /**
-     * Card expiration year, like 27 for 2027.
+     * The typename of this object
      */
-    exp_year: number | null;
+    typename: 'UsBankAccountPaymentMethod';
 
     /**
-     * Last four digits of the card.
+     * The bank details associated with this payment method
      */
-    last4: string | null;
+    us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
+  }
+
+  export namespace UsBankAccountPaymentMethod {
+    /**
+     * The bank details associated with this payment method
+     */
+    export interface UsBankAccount {
+      /**
+       * The type of account
+       */
+      account_type: string;
+
+      /**
+       * The name of the bank
+       */
+      bank_name: string;
+
+      /**
+       * The last 4 digits of the account number
+       */
+      last4: string;
+    }
   }
 }
 
 /**
- * A stored payment method used to process payments. This could be a credit/debit
- * card, bank account, PayPal wallet, etc.
+ * A payment method with no additional properties
  */
-export interface PaymentMethodListResponse {
-  /**
-   * The ID of the payment method
-   */
-  id: string;
+export type PaymentMethodListResponse =
+  | PaymentMethodListResponse.BasePaymentMethod
+  | PaymentMethodListResponse.CardPaymentMethod
+  | PaymentMethodListResponse.UsBankAccountPaymentMethod;
 
+export namespace PaymentMethodListResponse {
   /**
-   * The card data associated with the payment method, if its a debit or credit card.
+   * A payment method with no additional properties
    */
-  card: PaymentMethodListResponse.Card | null;
+  export interface BasePaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
 
-  /**
-   * The date and time the payment method was created
-   */
-  created_at: string;
+    /**
+     * When the payment method was created
+     */
+    created_at: string;
+
+    /**
+     * The type of the payment method
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
+
+    /**
+     * The typename of this object
+     */
+    typename: 'BasePaymentMethod';
+  }
 
   /**
-   * The payment method type of the payment method
+   * The card for the payment method
    */
-  payment_method_type: PaymentsAPI.PaymentMethodTypes;
-}
+  export interface CardPaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
+
+    /**
+     * The card details associated with this payment method
+     */
+    card: CardPaymentMethod.Card;
+
+    /**
+     * When the payment method was created
+     */
+    created_at: string;
+
+    /**
+     * The type of the payment method
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
+
+    /**
+     * The typename of this object
+     */
+    typename: 'CardPaymentMethod';
+  }
+
+  export namespace CardPaymentMethod {
+    /**
+     * The card details associated with this payment method
+     */
+    export interface Card {
+      /**
+       * Possible card brands that a payment token can have
+       */
+      brand: PaymentsAPI.CardBrands | null;
+
+      /**
+       * Card expiration month, like 03 for March.
+       */
+      exp_month: number | null;
+
+      /**
+       * Card expiration year, like 27 for 2027.
+       */
+      exp_year: number | null;
+
+      /**
+       * Last four digits of the card.
+       */
+      last4: string | null;
+    }
+  }
 
-export namespace PaymentMethodListResponse {
   /**
-   * The card data associated with the payment method, if its a debit or credit card.
+   * The bank account for the payment method
    */
-  export interface Card {
+  export interface UsBankAccountPaymentMethod {
+    /**
+     * The ID of the payment method
+     */
+    id: string;
+
     /**
-     * Possible card brands that a payment token can have
+     * When the payment method was created
      */
-    brand: PaymentsAPI.CardBrands | null;
+    created_at: string;
 
     /**
-     * Card expiration month, like 03 for March.
+     * The type of the payment method
      */
-    exp_month: number | null;
+    payment_method_type: PaymentsAPI.PaymentMethodTypes;
 
     /**
-     * Card expiration year, like 27 for 2027.
+     * The typename of this object
      */
-    exp_year: number | null;
+    typename: 'UsBankAccountPaymentMethod';
 
     /**
-     * Last four digits of the card.
+     * The bank details associated with this payment method
      */
-    last4: string | null;
+    us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
+  }
+
+  export namespace UsBankAccountPaymentMethod {
+    /**
+     * The bank details associated with this payment method
+     */
+    export interface UsBankAccount {
+      /**
+       * The type of account
+       */
+      account_type: string;
+
+      /**
+       * The name of the bank
+       */
+      bank_name: string;
+
+      /**
+       * The last 4 digits of the account number
+       */
+      last4: string;
+    }
   }
 }
 

package/src/resources/payments.ts

@@ -97,6 +97,34 @@ export class Payments extends APIResource {
     return this._client.getAPIList('/payments', CursorPage<PaymentListResponse>, { query, ...options });
   }
 
+  /**
+   * Lists fees for a payment
+   *
+   * Required permissions:
+   *
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const paymentListFeesResponse of client.payments.listFees(
+   *   'pay_xxxxxxxxxxxxxx',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  listFees(
+    id: string,
+    query: PaymentListFeesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PaymentListFeesResponsesCursorPage, PaymentListFeesResponse> {
+    return this._client.getAPIList(path`/payments/${id}/fees`, CursorPage<PaymentListFeesResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Refunds a payment
    *
@@ -176,6 +204,8 @@ export class Payments extends APIResource {
 
 export type PaymentListResponsesCursorPage = CursorPage<PaymentListResponse>;
 
+export type PaymentListFeesResponsesCursorPage = CursorPage<PaymentListFeesResponse>;
+
 /**
  * The reason why a specific payment was billed
  */
@@ -709,6 +739,61 @@ export namespace PaymentListResponse {
   }
 }
 
+/**
+ * Represents a fee related to a payment
+ */
+export interface PaymentListFeesResponse {
+  /**
+   * The value or amount to display for the fee.
+   */
+  amount: number;
+
+  /**
+   * The currency of the fee.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The label to display for the fee.
+   */
+  name: string;
+
+  /**
+   * The specific origin of the fee, if applicable.
+   */
+  type:
+    | 'stripe_domestic_processing_fee'
+    | 'stripe_international_processing_fee'
+    | 'stripe_fixed_processing_fee'
+    | 'stripe_billing_fee'
+    | 'stripe_radar_fee'
+    | 'sales_tax_remittance'
+    | 'sales_tax_remittance_reversal'
+    | 'stripe_sales_tax_fee'
+    | 'whop_processing_fee'
+    | 'marketplace_affiliate_fee'
+    | 'affiliate_fee'
+    | 'crypto_fee'
+    | 'stripe_standard_processing_fee'
+    | 'paypal_fee'
+    | 'stripe_payout_fee'
+    | 'dispute_fee'
+    | 'dispute_alert_fee'
+    | 'apple_processing_fee'
+    | 'buyer_fee'
+    | 'sezzle_processing_fee'
+    | 'splitit_processing_fee'
+    | 'platform_balance_processing_fee'
+    | 'payment_processing_percentage_fee'
+    | 'payment_processing_fixed_fee'
+    | 'cross_border_percentage_fee'
+    | 'fx_percentage_fee'
+    | 'orchestration_percentage_fee'
+    | 'three_ds_fixed_fee'
+    | 'billing_percentage_fee'
+    | 'revshare_percentage_fee';
+}
+
 export type PaymentCreateParams =
   | PaymentCreateParams.CreatePaymentInputWithPlan
   | PaymentCreateParams.CreatePaymentInputWithPlanID;
@@ -999,6 +1084,23 @@ export interface PaymentListParams extends CursorPageParams {
   substatuses?: Array<Shared.FriendlyReceiptStatus> | null;
 }
 
+export interface PaymentListFeesParams extends CursorPageParams {
+  /**
+   * 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 interface PaymentRefundParams {
   /**
    * An amount if the refund is supposed to be partial.
@@ -1012,9 +1114,12 @@ export declare namespace Payments {
     type CardBrands as CardBrands,
     type PaymentMethodTypes as PaymentMethodTypes,
     type PaymentListResponse as PaymentListResponse,
+    type PaymentListFeesResponse as PaymentListFeesResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,
+    type PaymentListFeesResponsesCursorPage as PaymentListFeesResponsesCursorPage,
     type PaymentCreateParams as PaymentCreateParams,
     type PaymentListParams as PaymentListParams,
+    type PaymentListFeesParams as PaymentListFeesParams,
     type PaymentRefundParams as PaymentRefundParams,
   };
 }

package/src/resources/payout-methods.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class PayoutMethods extends APIResource {
+  /**
+   * Lists payout destinations for a company
+   *
+   * Required permissions:
+   *
+   * - `payout:destination:read`
+   */
+  list(
+    query: PayoutMethodListParams,
+    options?: RequestOptions,
+  ): PagePromise<PayoutMethodListResponsesCursorPage, PayoutMethodListResponse> {
+    return this._client.getAPIList('/payout_methods', CursorPage<PayoutMethodListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListResponse>;
+
+/**
+ * An object representing an user's setup payout destination.
+ */
+export interface PayoutMethodListResponse {
+  /**
+   * The ID of the payout token
+   */
+  id: string;
+
+  /**
+   * The currency code of the payout destination. This is the currency that payouts
+   * will be made in for this token.
+   */
+  currency: string;
+
+  /**
+   * The payout destination associated with the payout token
+   */
+  destination: PayoutMethodListResponse.Destination | null;
+
+  /**
+   * 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;
+}
+
+export namespace PayoutMethodListResponse {
+  /**
+   * The payout destination associated with the payout token
+   */
+  export interface Destination {
+    /**
+     * The category of the payout destination
+     */
+    category: 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
+
+    /**
+     * The country code of the payout destination
+     */
+    country_code: string;
+
+    /**
+     * The name of the payer associated with the payout destination
+     */
+    name: string;
+  }
+}
+
+export interface PayoutMethodListParams extends CursorPageParams {
+  /**
+   * The company ID to list payout methods 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 PayoutMethods {
+  export {
+    type PayoutMethodListResponse as PayoutMethodListResponse,
+    type PayoutMethodListResponsesCursorPage as PayoutMethodListResponsesCursorPage,
+    type PayoutMethodListParams as PayoutMethodListParams,
+  };
+}

package/src/resources/shared.ts

@@ -796,12 +796,29 @@ export namespace CourseLessonInteraction {
      */
     id: string;
 
+    /**
+     * The chapter this lesson belongs to
+     */
+    chapter: Lesson.Chapter;
+
     /**
      * The title of the lesson
      */
     title: string;
   }
 
+  export namespace Lesson {
+    /**
+     * The chapter this lesson belongs to
+     */
+    export interface Chapter {
+      /**
+       * The ID of the chapter. Looks like chap_XXX
+       */
+      id: string;
+    }
+  }
+
   /**
    * The user who interacted with the lesson
    */
@@ -863,12 +880,29 @@ export namespace CourseLessonInteractionListItem {
      */
     id: string;
 
+    /**
+     * The chapter this lesson belongs to
+     */
+    chapter: Lesson.Chapter;
+
     /**
      * The title of the lesson
      */
     title: string;
   }
 
+  export namespace Lesson {
+    /**
+     * The chapter this lesson belongs to
+     */
+    export interface Chapter {
+      /**
+       * The ID of the chapter. Looks like chap_XXX
+       */
+      id: string;
+    }
+  }
+
   /**
    * The user who interacted with the lesson
    */