@whop/sdk 0.0.14 → 0.0.16

package/src/resources/fee-markups.ts

@@ -0,0 +1,232 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class FeeMarkups extends APIResource {
+  /**
+   * Creates or updates a fee markup for a company.
+   *
+   * Required permissions:
+   *
+   * - `company:update_child_fees`
+   *
+   * @example
+   * ```ts
+   * const feeMarkup = await client.feeMarkups.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   fee_type: 'crypto_withdrawal_markup',
+   * });
+   * ```
+   */
+  create(body: FeeMarkupCreateParams, options?: RequestOptions): APIPromise<FeeMarkupCreateResponse> {
+    return this._client.post('/fee_markups', { body, ...options });
+  }
+
+  /**
+   * Lists fee markups for a company.
+   *
+   * Required permissions:
+   *
+   * - `company:update_child_fees`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const feeMarkupListResponse of client.feeMarkups.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: FeeMarkupListParams,
+    options?: RequestOptions,
+  ): PagePromise<FeeMarkupListResponsesCursorPage, FeeMarkupListResponse> {
+    return this._client.getAPIList('/fee_markups', CursorPage<FeeMarkupListResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a fee markup for a company.
+   *
+   * Required permissions:
+   *
+   * - `company:update_child_fees`
+   *
+   * @example
+   * ```ts
+   * const feeMarkup = await client.feeMarkups.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<FeeMarkupDeleteResponse> {
+    return this._client.delete(path`/fee_markups/${id}`, options);
+  }
+}
+
+export type FeeMarkupListResponsesCursorPage = CursorPage<FeeMarkupListResponse>;
+
+/**
+ * The types of fee markups that can be configured
+ */
+export type FeeMarkupType =
+  | 'crypto_withdrawal_markup'
+  | 'rtp_withdrawal_markup'
+  | 'next_day_bank_withdrawal_markup'
+  | 'bank_wire_withdrawal_markup'
+  | 'digital_wallet_withdrawal_markup';
+
+/**
+ * Represents a fee markup configuration for a company
+ */
+export interface FeeMarkupCreateResponse {
+  /**
+   * The unique identifier of the fee markup.
+   */
+  id: string;
+
+  /**
+   * When this fee markup was created.
+   */
+  created_at: string;
+
+  /**
+   * The type of fee this markup applies to.
+   */
+  fee_type: FeeMarkupType;
+
+  /**
+   * The fixed fee in USD to charge (0-50).
+   */
+  fixed_fee_usd: number | null;
+
+  /**
+   * Internal notes about this fee markup.
+   */
+  notes: string | null;
+
+  /**
+   * The percentage fee to charge (0-25).
+   */
+  percentage_fee: number | null;
+
+  /**
+   * When this fee markup was last updated.
+   */
+  updated_at: string;
+}
+
+/**
+ * Represents a fee markup configuration for a company
+ */
+export interface FeeMarkupListResponse {
+  /**
+   * The unique identifier of the fee markup.
+   */
+  id: string;
+
+  /**
+   * When this fee markup was created.
+   */
+  created_at: string;
+
+  /**
+   * The type of fee this markup applies to.
+   */
+  fee_type: FeeMarkupType;
+
+  /**
+   * The fixed fee in USD to charge (0-50).
+   */
+  fixed_fee_usd: number | null;
+
+  /**
+   * Internal notes about this fee markup.
+   */
+  notes: string | null;
+
+  /**
+   * The percentage fee to charge (0-25).
+   */
+  percentage_fee: number | null;
+
+  /**
+   * When this fee markup was last updated.
+   */
+  updated_at: string;
+}
+
+/**
+ * Represents `true` or `false` values.
+ */
+export type FeeMarkupDeleteResponse = boolean;
+
+export interface FeeMarkupCreateParams {
+  /**
+   * The ID (tag) of the company you want to update the fee markup for.
+   */
+  company_id: string;
+
+  /**
+   * The type of fee this markup applies to.
+   */
+  fee_type: FeeMarkupType;
+
+  /**
+   * The fixed fee in USD to charge (0-50).
+   */
+  fixed_fee_usd?: number | null;
+
+  /**
+   * Custom metadata to attach to this fee markup.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * Internal notes about this fee markup.
+   */
+  notes?: string | null;
+
+  /**
+   * The percentage fee to charge (0-25).
+   */
+  percentage_fee?: number | null;
+}
+
+export interface FeeMarkupListParams extends CursorPageParams {
+  /**
+   * The ID (tag) of the company you want to list the fee markups for. If you pass
+   * your platform account, you will get the platform default markups.
+   */
+  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 FeeMarkups {
+  export {
+    type FeeMarkupType as FeeMarkupType,
+    type FeeMarkupCreateResponse as FeeMarkupCreateResponse,
+    type FeeMarkupListResponse as FeeMarkupListResponse,
+    type FeeMarkupDeleteResponse as FeeMarkupDeleteResponse,
+    type FeeMarkupListResponsesCursorPage as FeeMarkupListResponsesCursorPage,
+    type FeeMarkupCreateParams as FeeMarkupCreateParams,
+    type FeeMarkupListParams as FeeMarkupListParams,
+  };
+}

package/src/resources/index.ts

@@ -128,6 +128,16 @@ export {
   type ExperienceDuplicateParams,
   type ExperienceListResponsesCursorPage,
 } from './experiences';
+export {
+  FeeMarkups,
+  type FeeMarkupType,
+  type FeeMarkupCreateResponse,
+  type FeeMarkupListResponse,
+  type FeeMarkupDeleteResponse,
+  type FeeMarkupCreateParams,
+  type FeeMarkupListParams,
+  type FeeMarkupListResponsesCursorPage,
+} from './fee-markups';
 export {
   ForumPosts,
   type ForumPostVisibilityType,
@@ -194,11 +204,20 @@ export {
   type CardBrands,
   type PaymentMethodTypes,
   type PaymentListResponse,
+  type PaymentListFeesResponse,
   type PaymentCreateParams,
   type PaymentListParams,
+  type PaymentListFeesParams,
   type PaymentRefundParams,
   type PaymentListResponsesCursorPage,
+  type PaymentListFeesResponsesCursorPage,
 } from './payments';
+export {
+  PayoutMethods,
+  type PayoutMethodListResponse,
+  type PayoutMethodListParams,
+  type PayoutMethodListResponsesCursorPage,
+} from './payout-methods';
 export {
   Plans,
   type PlanListResponse,
@@ -320,8 +339,10 @@ export {
   type WithdrawalSpeeds,
   type WithdrawalStatus,
   type WithdrawalTypes,
+  type WithdrawalCreateResponse,
   type WithdrawalRetrieveResponse,
   type WithdrawalListResponse,
+  type WithdrawalCreateParams,
   type WithdrawalListParams,
   type WithdrawalListResponsesCursorPage,
 } from './withdrawals';

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;
+    }
   }
 }