@whop/sdk 0.0.25 → 0.0.27

package/src/resources/invoices.ts

@@ -150,7 +150,7 @@ export declare namespace InvoiceCreateParams {
      */
     export interface Plan {
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans).
        */
       billing_period?: number | null;
 
@@ -165,14 +165,15 @@ export declare namespace InvoiceCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires and revokes access (expiration
+       * plans). For example, 365 for a one-year access period.
        */
       expiration_days?: number | null;
 
       /**
        * An additional amount charged upon first purchase. Use only if a one time payment
        * OR you want to charge an additional amount on top of the renewal price. Provided
-       * as a number in dollars. Eg: 10.43 for $10.43
+       * as a number in the specified currency. Eg: 10.43 for $10.43
        */
       initial_price?: number | null;
 
@@ -193,7 +194,7 @@ export declare namespace InvoiceCreateParams {
 
       /**
        * The amount the customer is charged every billing period. Use only if a recurring
-       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
        */
       renewal_price?: number | null;
 
@@ -208,7 +209,8 @@ export declare namespace InvoiceCreateParams {
       trial_period_days?: number | null;
 
       /**
-       * Limits/doesn't limit the number of units available for purchase.
+       * When true, the plan has unlimited stock (stock field is ignored). When false,
+       * purchases are limited by the stock field.
        */
       unlimited_stock?: boolean | null;
 
@@ -334,7 +336,7 @@ export declare namespace InvoiceCreateParams {
      */
     export interface Plan {
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans).
        */
       billing_period?: number | null;
 
@@ -349,14 +351,15 @@ export declare namespace InvoiceCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires and revokes access (expiration
+       * plans). For example, 365 for a one-year access period.
        */
       expiration_days?: number | null;
 
       /**
        * An additional amount charged upon first purchase. Use only if a one time payment
        * OR you want to charge an additional amount on top of the renewal price. Provided
-       * as a number in dollars. Eg: 10.43 for $10.43
+       * as a number in the specified currency. Eg: 10.43 for $10.43
        */
       initial_price?: number | null;
 
@@ -377,7 +380,7 @@ export declare namespace InvoiceCreateParams {
 
       /**
        * The amount the customer is charged every billing period. Use only if a recurring
-       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
        */
       renewal_price?: number | null;
 
@@ -392,7 +395,8 @@ export declare namespace InvoiceCreateParams {
       trial_period_days?: number | null;
 
       /**
-       * Limits/doesn't limit the number of units available for purchase.
+       * When true, the plan has unlimited stock (stock field is ignored). When false,
+       * purchases are limited by the stock field.
        */
       unlimited_stock?: boolean | null;
 
@@ -519,7 +523,7 @@ export declare namespace InvoiceCreateParams {
      */
     export interface Plan {
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans).
        */
       billing_period?: number | null;
 
@@ -534,14 +538,15 @@ export declare namespace InvoiceCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires and revokes access (expiration
+       * plans). For example, 365 for a one-year access period.
        */
       expiration_days?: number | null;
 
       /**
        * An additional amount charged upon first purchase. Use only if a one time payment
        * OR you want to charge an additional amount on top of the renewal price. Provided
-       * as a number in dollars. Eg: 10.43 for $10.43
+       * as a number in the specified currency. Eg: 10.43 for $10.43
        */
       initial_price?: number | null;
 
@@ -562,7 +567,7 @@ export declare namespace InvoiceCreateParams {
 
       /**
        * The amount the customer is charged every billing period. Use only if a recurring
-       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
        */
       renewal_price?: number | null;
 
@@ -577,7 +582,8 @@ export declare namespace InvoiceCreateParams {
       trial_period_days?: number | null;
 
       /**
-       * Limits/doesn't limit the number of units available for purchase.
+       * When true, the plan has unlimited stock (stock field is ignored). When false,
+       * purchases are limited by the stock field.
        */
       unlimited_stock?: boolean | null;
 
@@ -687,7 +693,7 @@ export declare namespace InvoiceCreateParams {
      */
     export interface Plan {
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans).
        */
       billing_period?: number | null;
 
@@ -702,14 +708,15 @@ export declare namespace InvoiceCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires and revokes access (expiration
+       * plans). For example, 365 for a one-year access period.
        */
       expiration_days?: number | null;
 
       /**
        * An additional amount charged upon first purchase. Use only if a one time payment
        * OR you want to charge an additional amount on top of the renewal price. Provided
-       * as a number in dollars. Eg: 10.43 for $10.43
+       * as a number in the specified currency. Eg: 10.43 for $10.43
        */
       initial_price?: number | null;
 
@@ -730,7 +737,7 @@ export declare namespace InvoiceCreateParams {
 
       /**
        * The amount the customer is charged every billing period. Use only if a recurring
-       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
        */
       renewal_price?: number | null;
 
@@ -745,7 +752,8 @@ export declare namespace InvoiceCreateParams {
       trial_period_days?: number | null;
 
       /**
-       * Limits/doesn't limit the number of units available for purchase.
+       * When true, the plan has unlimited stock (stock field is ignored). When false,
+       * purchases are limited by the stock field.
        */
       unlimited_stock?: boolean | null;
 

package/src/resources/leads.ts

@@ -24,7 +24,7 @@ export class Leads extends APIResource {
    * });
    * ```
    */
-  create(body: LeadCreateParams, options?: RequestOptions): APIPromise<LeadCreateResponse> {
+  create(body: LeadCreateParams, options?: RequestOptions): APIPromise<Lead> {
     return this._client.post('/leads', { body, ...options });
   }
 
@@ -45,7 +45,7 @@ export class Leads extends APIResource {
    * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<LeadRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Lead> {
     return this._client.get(path`/leads/${id}`, options);
   }
 
@@ -70,7 +70,7 @@ export class Leads extends APIResource {
     id: string,
     body: LeadUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LeadUpdateResponse> {
+  ): APIPromise<Lead> {
     return this._client.patch(path`/leads/${id}`, { body, ...options });
   }
 
@@ -107,21 +107,21 @@ export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
 /**
  * An object representing a lead (someone who is interested in a whop).
  */
-export interface LeadCreateResponse {
+export interface Lead {
   /**
-   * The ID of the lead.
+   * The unique identifier for the lead.
    */
   id: string;
 
   /**
-   * The timestamp of when the lead was created.
+   * The datetime the lead was created.
    */
   created_at: string;
 
   /**
    * The converted member, if any.
    */
-  member: LeadCreateResponse.Member | null;
+  member: Lead.Member | null;
 
   /**
    * Custom metadata for the lead.
@@ -131,7 +131,7 @@ export interface LeadCreateResponse {
   /**
    * The access pass the lead is interested in, if available.
    */
-  product: LeadCreateResponse.Product | null;
+  product: Lead.Product | null;
 
   /**
    * The referrer URL that brought this lead.
@@ -139,23 +139,23 @@ export interface LeadCreateResponse {
   referrer: string | null;
 
   /**
-   * The timestamp of when the lead was last updated.
+   * The datetime the lead was last updated.
    */
   updated_at: string;
 
   /**
    * The user who is the lead.
    */
-  user: LeadCreateResponse.User;
+  user: Lead.User;
 }
 
-export namespace LeadCreateResponse {
+export namespace Lead {
   /**
    * The converted member, if any.
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -165,7 +165,7 @@ export namespace LeadCreateResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -180,201 +180,7 @@ export namespace LeadCreateResponse {
    */
   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;
-  }
-}
-
-/**
- * An object representing a lead (someone who is interested in a whop).
- */
-export interface LeadRetrieveResponse {
-  /**
-   * The ID of the lead.
-   */
-  id: string;
-
-  /**
-   * The timestamp of when the lead was created.
-   */
-  created_at: string;
-
-  /**
-   * The converted member, if any.
-   */
-  member: LeadRetrieveResponse.Member | null;
-
-  /**
-   * Custom metadata for the lead.
-   */
-  metadata: { [key: string]: unknown } | null;
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  product: LeadRetrieveResponse.Product | null;
-
-  /**
-   * The referrer URL that brought this lead.
-   */
-  referrer: string | null;
-
-  /**
-   * The timestamp of when the lead was last updated.
-   */
-  updated_at: string;
-
-  /**
-   * The user who is the lead.
-   */
-  user: LeadRetrieveResponse.User;
-}
-
-export namespace LeadRetrieveResponse {
-  /**
-   * The converted member, if any.
-   */
-  export interface Member {
-    /**
-     * The ID of the member
-     */
-    id: string;
-  }
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  export interface Product {
-    /**
-     * The internal ID of the public product.
-     */
-    id: string;
-
-    /**
-     * The title of the product. Use for Whop 4.0.
-     */
-    title: string;
-  }
-
-  /**
-   * The user who is the lead.
-   */
-  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;
-  }
-}
-
-/**
- * An object representing a lead (someone who is interested in a whop).
- */
-export interface LeadUpdateResponse {
-  /**
-   * The ID of the lead.
-   */
-  id: string;
-
-  /**
-   * The timestamp of when the lead was created.
-   */
-  created_at: string;
-
-  /**
-   * The converted member, if any.
-   */
-  member: LeadUpdateResponse.Member | null;
-
-  /**
-   * Custom metadata for the lead.
-   */
-  metadata: { [key: string]: unknown } | null;
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  product: LeadUpdateResponse.Product | null;
-
-  /**
-   * The referrer URL that brought this lead.
-   */
-  referrer: string | null;
-
-  /**
-   * The timestamp of when the lead was last updated.
-   */
-  updated_at: string;
-
-  /**
-   * The user who is the lead.
-   */
-  user: LeadUpdateResponse.User;
-}
-
-export namespace LeadUpdateResponse {
-  /**
-   * The converted member, if any.
-   */
-  export interface Member {
-    /**
-     * The ID of the member
-     */
-    id: string;
-  }
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  export interface Product {
-    /**
-     * The internal ID of the public product.
-     */
-    id: string;
-
-    /**
-     * The title of the product. Use for Whop 4.0.
-     */
-    title: string;
-  }
-
-  /**
-   * The user who is the lead.
-   */
-  export interface User {
-    /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -400,12 +206,12 @@ export namespace LeadUpdateResponse {
  */
 export interface LeadListResponse {
   /**
-   * The ID of the lead.
+   * The unique identifier for the lead.
    */
   id: string;
 
   /**
-   * The timestamp of when the lead was created.
+   * The datetime the lead was created.
    */
   created_at: string;
 
@@ -430,7 +236,7 @@ export interface LeadListResponse {
   referrer: string | null;
 
   /**
-   * The timestamp of when the lead was last updated.
+   * The datetime the lead was last updated.
    */
   updated_at: string;
 
@@ -446,7 +252,7 @@ export namespace LeadListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -456,7 +262,7 @@ export namespace LeadListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -471,7 +277,7 @@ export namespace LeadListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -571,9 +377,7 @@ export interface LeadListParams extends CursorPageParams {
 
 export declare namespace Leads {
   export {
-    type LeadCreateResponse as LeadCreateResponse,
-    type LeadRetrieveResponse as LeadRetrieveResponse,
-    type LeadUpdateResponse as LeadUpdateResponse,
+    type Lead as Lead,
     type LeadListResponse as LeadListResponse,
     type LeadListResponsesCursorPage as LeadListResponsesCursorPage,
     type LeadCreateParams as LeadCreateParams,

package/src/resources/ledger-accounts.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import * as Shared from './shared';
+import * as VerificationsAPI from './verifications';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -25,7 +26,7 @@ export class LedgerAccounts extends APIResource {
  */
 export interface LedgerAccountRetrieveResponse {
   /**
-   * The ID of the LedgerAccount.
+   * The unique identifier for the ledger account.
    */
   id: string;
 
@@ -87,11 +88,12 @@ export namespace LedgerAccountRetrieveResponse {
   }
 
   /**
-   * An object representing a (sanitized) user of the site.
+   * A user account on Whop. Contains profile information, identity details, and
+   * social connections.
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -112,11 +114,12 @@ export namespace LedgerAccountRetrieveResponse {
   }
 
   /**
-   * An object representing a (sanitized) company.
+   * A company is a seller on Whop. Companies own products, manage members, and
+   * receive payouts.
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -141,7 +144,7 @@ export namespace LedgerAccountRetrieveResponse {
    */
   export interface PayoutAccountDetails {
     /**
-     * Unique identifier for the object
+     * The unique identifier for the payout account.
      */
     id: string;
 
@@ -243,34 +246,14 @@ export namespace LedgerAccountRetrieveResponse {
      */
     export interface LatestVerification {
       /**
-       * A unique identifier for the verification.
+       * The 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;
+      last_error_code: VerificationsAPI.VerificationErrorCode | null;
 
       /**
        * The last error reason that occurred during the verification.
@@ -280,20 +263,7 @@ export namespace LedgerAccountRetrieveResponse {
       /**
        * The status of the verification.
        */
-      status:
-        | 'requires_input'
-        | 'processing'
-        | 'verified'
-        | 'canceled'
-        | 'created'
-        | 'started'
-        | 'submitted'
-        | 'approved'
-        | 'declined'
-        | 'resubmission_requested'
-        | 'expired'
-        | 'abandoned'
-        | 'review';
+      status: VerificationsAPI.VerificationStatus;
     }
   }
 }