@whop/sdk 0.0.21 → 0.0.23

package/src/resources/payments.ts

@@ -243,35 +243,34 @@ export type CardBrands =
  * The different types of payment methods that can be used.
  */
 export type PaymentMethodTypes =
-  | 'acss_debit'
-  | 'affirm'
   | 'afterpay_clearpay'
   | 'alipay'
-  | 'alma'
   | 'amazon_pay'
   | 'apple_pay'
-  | 'au_becs_debit'
-  | 'bacs_debit'
   | 'bancontact'
-  | 'billie'
-  | 'blik'
-  | 'boleto'
   | 'card'
   | 'cashapp'
   | 'crypto'
-  | 'eps'
-  | 'fpx'
-  | 'giropay'
   | 'google_pay'
-  | 'grabpay'
   | 'ideal'
-  | 'kakao_pay'
   | 'klarna'
-  | 'konbini'
-  | 'kr_card'
-  | 'link'
   | 'mobilepay'
+  | 'sepa_debit'
+  | 'swish'
+  | 'twint'
+  | 'us_bank_account'
+  | 'zip'
+  | 'vipps'
+  | 'paypal'
+  | 'sezzle'
+  | 'coinbase'
+  | 'splitit'
+  | 'platform_balance'
+  | 'apple'
+  | 'venmo'
+  | 'affirm'
   | 'multibanco'
+  | 'wechat_pay'
   | 'naver_pay'
   | 'nz_bank_account'
   | 'oxxo'
@@ -284,13 +283,22 @@ export type PaymentMethodTypes =
   | 'revolut_pay'
   | 'samsung_pay'
   | 'satispay'
-  | 'sepa_debit'
   | 'sofort'
-  | 'swish'
-  | 'twint'
-  | 'us_bank_account'
-  | 'wechat_pay'
-  | 'zip'
+  | 'konbini'
+  | 'kr_card'
+  | 'link'
+  | 'grabpay'
+  | 'kakao_pay'
+  | 'billie'
+  | 'blik'
+  | 'boleto'
+  | 'eps'
+  | 'fpx'
+  | 'giropay'
+  | 'acss_debit'
+  | 'alma'
+  | 'au_becs_debit'
+  | 'bacs_debit'
   | 'bizum'
   | 'capchase_pay'
   | 'kriya'
@@ -299,7 +307,6 @@ export type PaymentMethodTypes =
   | 'paypay'
   | 'sequra'
   | 'scalapay'
-  | 'vipps'
   | 'custom'
   | 'customer_balance'
   | 'gopay'
@@ -309,7 +316,6 @@ export type PaymentMethodTypes =
   | 'ng_card'
   | 'ng_market'
   | 'ng_ussd'
-  | 'paypal'
   | 'payto'
   | 'qris'
   | 'rechnung'
@@ -322,12 +328,6 @@ export type PaymentMethodTypes =
   | 'id_bank_transfer'
   | 'demo_pay'
   | 'shop_pay'
-  | 'sezzle'
-  | 'coinbase'
-  | 'splitit'
-  | 'platform_balance'
-  | 'apple'
-  | 'venmo'
   | 'unknown';
 
 /**

package/src/resources/payout-methods.ts

@@ -1,10 +1,23 @@
 // 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 PayoutMethods extends APIResource {
+  /**
+   * Retrieves a payout method by ID
+   *
+   * Required permissions:
+   *
+   * - `payout:destination:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse> {
+    return this._client.get(path`/payout_methods/${id}`, options);
+  }
+
   /**
    * Lists payout destinations for a company
    *
@@ -25,6 +38,75 @@ export class PayoutMethods extends APIResource {
 
 export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListResponse>;
 
+/**
+ * An object representing an user's setup payout destination.
+ */
+export interface PayoutMethodRetrieveResponse {
+  /**
+   * The ID of the payout token
+   */
+  id: string;
+
+  /**
+   * The company associated with the payout token
+   */
+  company: PayoutMethodRetrieveResponse.Company | null;
+
+  /**
+   * 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: PayoutMethodRetrieveResponse.Destination | null;
+
+  /**
+   * Whether this payout token is the default for the payout account
+   */
+  is_default: boolean;
+
+  /**
+   * 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 PayoutMethodRetrieveResponse {
+  /**
+   * The company associated with the payout token
+   */
+  export interface Company {
+    /**
+     * The ID (tag) of the company.
+     */
+    id: string;
+  }
+
+  /**
+   * 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;
+  }
+}
+
 /**
  * An object representing an user's setup payout destination.
  */
@@ -118,6 +200,7 @@ export interface PayoutMethodListParams extends CursorPageParams {
 
 export declare namespace PayoutMethods {
   export {
+    type PayoutMethodRetrieveResponse as PayoutMethodRetrieveResponse,
     type PayoutMethodListResponse as PayoutMethodListResponse,
     type PayoutMethodListResponsesCursorPage as PayoutMethodListResponsesCursorPage,
     type PayoutMethodListParams as PayoutMethodListParams,

package/src/resources/plans.ts

@@ -370,6 +370,11 @@ export interface PlanCreateParams {
    */
   internal_notes?: string | null;
 
+  /**
+   * Whether this plan uses legacy payment method controls
+   */
+  legacy_payment_method_controls?: boolean | null;
+
   /**
    * Whether or not the tax is included in a plan's price (or if it hasn't been set
    * up)
@@ -555,6 +560,11 @@ export interface PlanUpdateParams {
    */
   internal_notes?: string | null;
 
+  /**
+   * Whether this plan uses legacy payment method controls
+   */
+  legacy_payment_method_controls?: boolean | null;
+
   /**
    * Whether or not to offer a discount to cancel a subscription.
    */

package/src/resources/topups.ts

@@ -0,0 +1,95 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Topups extends APIResource {
+  /**
+   * Add funds to your platform balance by charging a stored payment method.
+   *
+   * Required permissions:
+   *
+   * - `payment:charge`
+   *
+   * @example
+   * ```ts
+   * const topup = await client.topups.create({
+   *   amount: 6.9,
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   currency: 'usd',
+   *   payment_method_id: 'pmt_xxxxxxxxxxxxxx',
+   * });
+   * ```
+   */
+  create(body: TopupCreateParams, options?: RequestOptions): APIPromise<TopupCreateResponse> {
+    return this._client.post('/topups', { body, ...options });
+  }
+}
+
+/**
+ * An object representing a receipt for a membership.
+ */
+export interface TopupCreateResponse {
+  /**
+   * The payment ID
+   */
+  id: string;
+
+  /**
+   * The datetime the payment was created
+   */
+  created_at: string;
+
+  /**
+   * The available currencies on the platform
+   */
+  currency: Shared.Currency | null;
+
+  /**
+   * If the payment failed, the reason for the failure.
+   */
+  failure_message: string | null;
+
+  /**
+   * The datetime the payment was paid
+   */
+  paid_at: string | null;
+
+  /**
+   * The status of a receipt
+   */
+  status: Shared.ReceiptStatus | null;
+
+  /**
+   * The total to show to the creator (excluding buyer fees).
+   */
+  total: number | null;
+}
+
+export interface TopupCreateParams {
+  /**
+   * The amount to add to the balance.
+   */
+  amount: number;
+
+  /**
+   * The ID of the company to add funds to.
+   */
+  company_id: string;
+
+  /**
+   * The currency of the top-up.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The ID of the payment method to charge for the top-up.
+   */
+  payment_method_id: string;
+}
+
+export declare namespace Topups {
+  export { type TopupCreateResponse as TopupCreateResponse, type TopupCreateParams as TopupCreateParams };
+}

package/src/resources/verifications.ts

@@ -0,0 +1,81 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Verifications extends APIResource {
+  /**
+   * Retrieves a verification by ID
+   *
+   * Required permissions:
+   *
+   * - `payout:account:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<VerificationRetrieveResponse> {
+    return this._client.get(path`/verifications/${id}`, options);
+  }
+}
+
+/**
+ * An object representing an identity verification session
+ */
+export interface VerificationRetrieveResponse {
+  /**
+   * A 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;
+
+  /**
+   * The last error reason that occurred during the verification.
+   */
+  last_error_reason: string | null;
+
+  /**
+   * The status of the verification.
+   */
+  status:
+    | 'requires_input'
+    | 'processing'
+    | 'verified'
+    | 'canceled'
+    | 'created'
+    | 'started'
+    | 'submitted'
+    | 'approved'
+    | 'declined'
+    | 'resubmission_requested'
+    | 'expired'
+    | 'abandoned'
+    | 'review';
+}
+
+export declare namespace Verifications {
+  export { type VerificationRetrieveResponse as VerificationRetrieveResponse };
+}