@whop/sdk 0.0.20 → 0.0.22

package/src/resources/payment-methods.ts

@@ -14,7 +14,7 @@ export class PaymentMethods extends APIResource {
    * such as a card, bank account, or digital wallet. It holds the necessary billing
    * details and can be attached to a member for future one-time or recurring
    * charges. This lets you reuse the same payment credentials across multiple
-   * payments.
+   * payments. You must provide exactly one of company_id or member_id.
    *
    * Required permissions:
    *
@@ -22,7 +22,7 @@ export class PaymentMethods extends APIResource {
    */
   retrieve(
     id: string,
-    query: PaymentMethodRetrieveParams,
+    query: PaymentMethodRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PaymentMethodRetrieveResponse> {
     return this._client.get(path`/payment_methods/${id}`, { query, ...options });
@@ -40,7 +40,7 @@ export class PaymentMethods extends APIResource {
    * - `member:payment_methods:read`
    */
   list(
-    query: PaymentMethodListParams,
+    query: PaymentMethodListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<PaymentMethodListResponsesCursorPage, PaymentMethodListResponse> {
     return this._client.getAPIList('/payment_methods', CursorPage<PaymentMethodListResponse>, {
@@ -650,22 +650,27 @@ export namespace PaymentMethodListResponse {
 
 export interface PaymentMethodRetrieveParams {
   /**
-   * The ID of the Member associated with the PaymentMethod
+   * The ID of the Company. Provide either this or member_id (not both).
    */
-  member_id: string;
-}
+  company_id?: string | null;
 
-export interface PaymentMethodListParams extends CursorPageParams {
   /**
-   * The ID of the Member to list payment methods for
+   * The ID of the Member. Provide either this or company_id (not both).
    */
-  member_id: string;
+  member_id?: string | null;
+}
 
+export interface PaymentMethodListParams extends CursorPageParams {
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
   before?: string | null;
 
+  /**
+   * The ID of the Company. Provide either this or member_id (not both).
+   */
+  company_id?: string | null;
+
   /**
    * The minimum creation date to filter by
    */
@@ -690,6 +695,11 @@ export interface PaymentMethodListParams extends CursorPageParams {
    * Returns the last _n_ elements from the list.
    */
   last?: number | null;
+
+  /**
+   * The ID of the Member to list payment methods for
+   */
+  member_id?: string | null;
 }
 
 export declare namespace PaymentMethods {

package/src/resources/payments.ts

@@ -410,8 +410,8 @@ export interface PaymentListResponse {
   membership: PaymentListResponse.Membership | null;
 
   /**
-   * The custom metadata stored on this payment. This will be copied the checkout
-   * configuration for which this payment was made
+   * The custom metadata stored on this payment. This will be copied over to the
+   * checkout configuration for which this payment was made
    */
   metadata: { [key: string]: unknown } | null;
 
@@ -791,7 +791,8 @@ export interface PaymentListFeesResponse {
     | 'orchestration_percentage_fee'
     | 'three_ds_fixed_fee'
     | 'billing_percentage_fee'
-    | 'revshare_percentage_fee';
+    | 'revshare_percentage_fee'
+    | 'application_fee';
 }
 
 export type PaymentCreateParams =
@@ -820,6 +821,11 @@ export declare namespace PaymentCreateParams {
      * Pass this object to create a new plan for this payment
      */
     plan: CreatePaymentInputWithPlan.Plan;
+
+    /**
+     * Custom metadata to attach to the payment.
+     */
+    metadata?: { [key: string]: unknown } | null;
   }
 
   export namespace CreatePaymentInputWithPlan {
@@ -1004,6 +1010,11 @@ export declare namespace PaymentCreateParams {
      * An ID of an existing plan to use for the payment.
      */
     plan_id: string;
+
+    /**
+     * Custom metadata to attach to the payment.
+     */
+    metadata?: { [key: string]: unknown } | null;
   }
 }
 

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.
  */
@@ -34,6 +116,11 @@ export interface PayoutMethodListResponse {
    */
   id: string;
 
+  /**
+   * The company associated with the payout token
+   */
+  company: PayoutMethodListResponse.Company | null;
+
   /**
    * The currency code of the payout destination. This is the currency that payouts
    * will be made in for this token.
@@ -45,6 +132,11 @@ export interface PayoutMethodListResponse {
    */
   destination: PayoutMethodListResponse.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.
@@ -53,6 +145,16 @@ export interface PayoutMethodListResponse {
 }
 
 export namespace PayoutMethodListResponse {
+  /**
+   * 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
    */
@@ -98,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/shared.ts

@@ -1951,7 +1951,8 @@ export type MembershipStatus =
   | 'canceled'
   | 'expired'
   | 'unresolved'
-  | 'drafted';
+  | 'drafted'
+  | 'canceling';
 
 /**
  * Represents a message in a DM channel
@@ -2207,8 +2208,8 @@ export interface Payment {
   membership: Payment.Membership | null;
 
   /**
-   * The custom metadata stored on this payment. This will be copied the checkout
-   * configuration for which this payment was made
+   * The custom metadata stored on this payment. This will be copied over to the
+   * checkout configuration for which this payment was made
    */
   metadata: { [key: string]: unknown } | null;
 

package/src/resources/support-channels.ts

@@ -139,7 +139,7 @@ export interface SupportChannelCreateParams {
   company_id: string;
 
   /**
-   * The ID of the user to create the support chat for
+   * The ID (user_xxx) or username of the user to create the support chat for
    */
   user_id: string;
 }

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