@whop/sdk 0.0.26 → 0.0.27

package/src/resources/entries.ts

@@ -63,16 +63,16 @@ export class Entries extends APIResource {
 export type EntryListResponsesCursorPage = CursorPage<EntryListResponse>;
 
 /**
- * An object representing an entry in a waitlist.
+ * An entry represents a user's signup for a waitlisted plan.
  */
 export interface EntryListResponse {
   /**
-   * The internal ID of the entry.
+   * The unique identifier for the entry.
    */
   id: string;
 
   /**
-   * When the entry was created.
+   * The datetime the entry was created.
    */
   created_at: string | null;
 
@@ -103,7 +103,7 @@ export namespace EntryListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -113,7 +113,7 @@ export namespace EntryListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -128,7 +128,7 @@ export namespace EntryListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/experiences.ts

@@ -170,11 +170,12 @@ export class Experiences extends APIResource {
 export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListResponse>;
 
 /**
- * An object representing an experience belonging to a company.
+ * An experience is a feature or content module within a product, such as a chat,
+ * course, or app.
  */
 export interface ExperienceListResponse {
   /**
-   * The unique ID representing this experience
+   * The unique identifier for the experience.
    */
   id: string;
 
@@ -189,7 +190,7 @@ export interface ExperienceListResponse {
   company: ExperienceListResponse.Company;
 
   /**
-   * The timestamp of when this experience was created.
+   * The datetime the experience was created.
    */
   created_at: string;
 
@@ -220,7 +221,7 @@ export namespace ExperienceListResponse {
    */
   export interface App {
     /**
-     * The ID of the app
+     * The unique identifier for the app.
      */
     id: string;
 
@@ -255,7 +256,7 @@ export namespace ExperienceListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 

package/src/resources/fee-markups.ts

@@ -84,12 +84,12 @@ export type FeeMarkupType =
  */
 export interface FeeMarkupCreateResponse {
   /**
-   * The unique identifier of the fee markup.
+   * The unique identifier for the fee markup.
    */
   id: string;
 
   /**
-   * When this fee markup was created.
+   * The datetime the fee markup was created.
    */
   created_at: string;
 
@@ -114,7 +114,7 @@ export interface FeeMarkupCreateResponse {
   percentage_fee: number | null;
 
   /**
-   * When this fee markup was last updated.
+   * The datetime the fee markup was last updated.
    */
   updated_at: string;
 }
@@ -124,12 +124,12 @@ export interface FeeMarkupCreateResponse {
  */
 export interface FeeMarkupListResponse {
   /**
-   * The unique identifier of the fee markup.
+   * The unique identifier for the fee markup.
    */
   id: string;
 
   /**
-   * When this fee markup was created.
+   * The datetime the fee markup was created.
    */
   created_at: string;
 
@@ -154,7 +154,7 @@ export interface FeeMarkupListResponse {
   percentage_fee: number | null;
 
   /**
-   * When this fee markup was last updated.
+   * The datetime the fee markup was last updated.
    */
   updated_at: string;
 }

package/src/resources/files.ts

@@ -46,7 +46,7 @@ export type UploadStatus = 'pending' | 'processing' | 'ready' | 'failed';
  */
 export interface FileCreateResponse {
   /**
-   * The ID of the file
+   * The unique identifier for the file.
    */
   id: string;
 
@@ -91,7 +91,7 @@ export interface FileCreateResponse {
  */
 export interface FileRetrieveResponse {
   /**
-   * The ID of the file
+   * The unique identifier for the file.
    */
   id: string;
 

package/src/resources/forum-posts.ts

@@ -95,7 +95,11 @@ export type ForumPostVisibilityType = 'members_only' | 'globally_visible';
  */
 export interface ForumPostListResponse {
   /**
-   * The unique identifier of the resource.
+   * Represents a unique identifier that is Base64 obfuscated. It is often used to
+   * refetch an object or as key for a cache. The ID type appears in a JSON response
+   * as a String; however, it is not intended to be human-readable. When expected as
+   * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+   * input value will be accepted as an ID.
    */
   id: string;
 
@@ -166,7 +170,7 @@ export namespace ForumPostListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -213,8 +217,8 @@ export interface ForumPostCreateParams {
   parent_id?: string | null;
 
   /**
-   * The amount to paywall this post by. A paywalled post requires the user to
-   * purchase it in order to view its content.
+   * The price in paywall_currency to unlock this post (e.g., 5.00 for $5.00). If
+   * set, users must purchase access to view the post content.
    */
   paywall_amount?: number | null;
 

package/src/resources/forums.ts

@@ -87,7 +87,7 @@ export namespace ForumListResponse {
    */
   export interface Experience {
     /**
-     * The unique ID representing this experience
+     * The unique identifier for the experience.
      */
     id: string;
 

package/src/resources/index.ts

@@ -366,9 +366,10 @@ export {
 } from './transfers';
 export {
   Users,
-  type UserRetrieveResponse,
+  type User,
   type UserCheckAccessResponse,
   type UserCheckAccessParams,
+  type UserUpdateProfileParams,
 } from './users';
 export {
   Verifications,

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

@@ -109,12 +109,12 @@ export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
  */
 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;
 
@@ -139,7 +139,7 @@ export interface Lead {
   referrer: string | null;
 
   /**
-   * The timestamp of when the lead was last updated.
+   * The datetime the lead was last updated.
    */
   updated_at: string;
 
@@ -155,7 +155,7 @@ export namespace Lead {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -165,7 +165,7 @@ export namespace Lead {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -180,7 +180,7 @@ export namespace Lead {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -206,12 +206,12 @@ export namespace Lead {
  */
 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;
 
@@ -236,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;
 
@@ -252,7 +252,7 @@ export namespace LeadListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -262,7 +262,7 @@ export namespace LeadListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -277,7 +277,7 @@ export namespace LeadListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/ledger-accounts.ts

@@ -26,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;
 
@@ -88,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;
 
@@ -113,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;
 
@@ -142,7 +144,7 @@ export namespace LedgerAccountRetrieveResponse {
    */
   export interface PayoutAccountDetails {
     /**
-     * Unique identifier for the object
+     * The unique identifier for the payout account.
      */
     id: string;
 
@@ -244,7 +246,7 @@ export namespace LedgerAccountRetrieveResponse {
      */
     export interface LatestVerification {
       /**
-       * A unique identifier for the verification.
+       * The unique identifier for the verification.
        */
       id: string;
 

package/src/resources/members.ts

@@ -47,7 +47,7 @@ export type MemberListResponsesCursorPage = CursorPage<MemberListResponse>;
  */
 export interface MemberRetrieveResponse {
   /**
-   * The ID of the member
+   * The unique identifier for the company member.
    */
   id: string;
 
@@ -70,7 +70,7 @@ export interface MemberRetrieveResponse {
   company_token_balance: number;
 
   /**
-   * When the member was created
+   * The datetime the company member was created.
    */
   created_at: string;
 
@@ -100,7 +100,7 @@ export interface MemberRetrieveResponse {
   status: Shared.MemberStatuses;
 
   /**
-   * The timestamp of when this member was last updated
+   * The datetime the company member was last updated.
    */
   updated_at: string;
 
@@ -121,7 +121,7 @@ export namespace MemberRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -141,7 +141,7 @@ export namespace MemberRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user account.
+     * The unique identifier for the company member user.
      */
     id: string;
 
@@ -169,7 +169,7 @@ export namespace MemberRetrieveResponse {
  */
 export interface MemberListResponse {
   /**
-   * The ID of the member
+   * The unique identifier for the company member.
    */
   id: string;
 
@@ -187,7 +187,7 @@ export interface MemberListResponse {
   company_token_balance: number;
 
   /**
-   * When the member was created
+   * The datetime the company member was created.
    */
   created_at: string;
 
@@ -217,7 +217,7 @@ export interface MemberListResponse {
   status: Shared.MemberStatuses;
 
   /**
-   * The timestamp of when this member was last updated
+   * The datetime the company member was last updated.
    */
   updated_at: string;
 
@@ -238,7 +238,7 @@ export namespace MemberListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user account.
+     * The unique identifier for the company member user.
      */
     id: string;