@whop/sdk 0.0.39 → 0.0.40

package/src/resources/invoices.ts

@@ -14,6 +14,29 @@ import { path } from '../internal/utils/path';
  * Invoices
  */
 export class Invoices extends APIResource {
+  /**
+   * Returns a paginated list of invoices for a company, with optional filtering by
+   * product, status, collection method, and creation date.
+   *
+   * Required permissions:
+   *
+   * - `invoice:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const invoiceListItem of client.invoices.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: InvoiceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem> {
+    return this._client.getAPIList('/invoices', CursorPage<Shared.InvoiceListItem>, { query, ...options });
+  }
+
   /**
    * Create an invoice for a customer. The invoice can be charged automatically using
    * a stored payment method, or sent to the customer for manual payment.
@@ -55,7 +78,8 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * Update a draft invoice's details.
+   * Void an open invoice so it can no longer be paid. Voiding is permanent and
+   * cannot be undone.
    *
    * Required permissions:
    *
@@ -63,44 +87,17 @@ export class Invoices extends APIResource {
    *
    * @example
    * ```ts
-   * const invoice = await client.invoices.update(
+   * const response = await client.invoices.void(
    *   'inv_xxxxxxxxxxxxxx',
    * );
    * ```
    */
-  update(
-    id: string,
-    body: InvoiceUpdateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Shared.Invoice> {
-    return this._client.patch(path`/invoices/${id}`, { body, ...options });
-  }
-
-  /**
-   * Returns a paginated list of invoices for a company, with optional filtering by
-   * product, status, collection method, and creation date.
-   *
-   * Required permissions:
-   *
-   * - `invoice:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const invoiceListItem of client.invoices.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: InvoiceListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem> {
-    return this._client.getAPIList('/invoices', CursorPage<Shared.InvoiceListItem>, { query, ...options });
+  void(id: string, options?: RequestOptions): APIPromise<InvoiceVoidResponse> {
+    return this._client.post(path`/invoices/${id}/void`, options);
   }
 
   /**
-   * Delete a draft invoice.
+   * Mark an open invoice as paid when payment was collected outside of Whop.
    *
    * Required permissions:
    *
@@ -108,17 +105,17 @@ export class Invoices extends APIResource {
    *
    * @example
    * ```ts
-   * const invoice = await client.invoices.delete(
+   * const response = await client.invoices.markPaid(
    *   'inv_xxxxxxxxxxxxxx',
    * );
    * ```
    */
-  delete(id: string, options?: RequestOptions): APIPromise<InvoiceDeleteResponse> {
-    return this._client.delete(path`/invoices/${id}`, options);
+  markPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkPaidResponse> {
+    return this._client.post(path`/invoices/${id}/mark_paid`, options);
   }
 
   /**
-   * Mark an open invoice as paid when payment was collected outside of Whop.
+   * Mark an open invoice as uncollectible when payment is not expected.
    *
    * Required permissions:
    *
@@ -126,17 +123,17 @@ export class Invoices extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.invoices.markPaid(
+   * const response = await client.invoices.markUncollectible(
    *   'inv_xxxxxxxxxxxxxx',
    * );
    * ```
    */
-  markPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkPaidResponse> {
-    return this._client.post(path`/invoices/${id}/mark_paid`, options);
+  markUncollectible(id: string, options?: RequestOptions): APIPromise<InvoiceMarkUncollectibleResponse> {
+    return this._client.post(path`/invoices/${id}/mark_uncollectible`, options);
   }
 
   /**
-   * Mark an open invoice as uncollectible when payment is not expected.
+   * Update a draft invoice's details.
    *
    * Required permissions:
    *
@@ -144,18 +141,21 @@ export class Invoices extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.invoices.markUncollectible(
+   * const invoice = await client.invoices.update(
    *   'inv_xxxxxxxxxxxxxx',
    * );
    * ```
    */
-  markUncollectible(id: string, options?: RequestOptions): APIPromise<InvoiceMarkUncollectibleResponse> {
-    return this._client.post(path`/invoices/${id}/mark_uncollectible`, options);
+  update(
+    id: string,
+    body: InvoiceUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.Invoice> {
+    return this._client.patch(path`/invoices/${id}`, { body, ...options });
   }
 
   /**
-   * Void an open invoice so it can no longer be paid. Voiding is permanent and
-   * cannot be undone.
+   * Delete a draft invoice.
    *
    * Required permissions:
    *
@@ -163,13 +163,13 @@ export class Invoices extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.invoices.void(
+   * const invoice = await client.invoices.delete(
    *   'inv_xxxxxxxxxxxxxx',
    * );
    * ```
    */
-  void(id: string, options?: RequestOptions): APIPromise<InvoiceVoidResponse> {
-    return this._client.post(path`/invoices/${id}/void`, options);
+  delete(id: string, options?: RequestOptions): APIPromise<InvoiceDeleteResponse> {
+    return this._client.delete(path`/invoices/${id}`, options);
   }
 }
 
@@ -309,6 +309,64 @@ export type InvoiceMarkUncollectibleResponse = boolean;
  */
 export type InvoiceVoidResponse = boolean;
 
+export interface InvoiceListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter invoices by their collection method.
+   */
+  collection_methods?: Array<Shared.CollectionMethod> | null;
+
+  /**
+   * The unique identifier of the company to list invoices for.
+   */
+  company_id?: string | null;
+
+  /**
+   * Only return invoices created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return invoices created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * Which columns can be used to sort.
+   */
+  order?: 'id' | 'created_at' | 'due_date' | null;
+
+  /**
+   * Filter invoices to only those associated with these specific product
+   * identifiers.
+   */
+  product_ids?: Array<string> | null;
+
+  /**
+   * Filter invoices by their current status.
+   */
+  statuses?: Array<Shared.InvoiceStatus> | null;
+}
+
 export type InvoiceCreateParams =
   | InvoiceCreateParams.CreateInvoiceInputWithProduct
   | InvoiceCreateParams.CreateInvoiceInputWithProductID;
@@ -1055,6 +1113,12 @@ export interface InvoiceUpdateParams {
    */
   plan?: InvoiceUpdateParams.Plan | null;
 
+  /**
+   * The unique identifier of an existing product to attach to this invoice. Only
+   * allowed while the invoice is still a draft.
+   */
+  product_id?: string | null;
+
   /**
    * The date that defines when the subscription billing cycle should start.
    */
@@ -1287,64 +1351,6 @@ export namespace InvoiceUpdateParams {
   }
 }
 
-export interface InvoiceListParams extends CursorPageParams {
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Filter invoices by their collection method.
-   */
-  collection_methods?: Array<Shared.CollectionMethod> | null;
-
-  /**
-   * The unique identifier of the company to list invoices for.
-   */
-  company_id?: string | null;
-
-  /**
-   * Only return invoices created after this timestamp.
-   */
-  created_after?: string | null;
-
-  /**
-   * Only return invoices created before this timestamp.
-   */
-  created_before?: string | null;
-
-  /**
-   * The direction of the sort.
-   */
-  direction?: Shared.Direction | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * Which columns can be used to sort.
-   */
-  order?: 'id' | 'created_at' | 'due_date' | null;
-
-  /**
-   * Filter invoices to only those associated with these specific product
-   * identifiers.
-   */
-  product_ids?: Array<string> | null;
-
-  /**
-   * Filter invoices by their current status.
-   */
-  statuses?: Array<Shared.InvoiceStatus> | null;
-}
-
 export declare namespace Invoices {
   export {
     type TaxIdentifierType as TaxIdentifierType,
@@ -1352,9 +1358,9 @@ export declare namespace Invoices {
     type InvoiceMarkPaidResponse as InvoiceMarkPaidResponse,
     type InvoiceMarkUncollectibleResponse as InvoiceMarkUncollectibleResponse,
     type InvoiceVoidResponse as InvoiceVoidResponse,
+    type InvoiceListParams as InvoiceListParams,
     type InvoiceCreateParams as InvoiceCreateParams,
     type InvoiceUpdateParams as InvoiceUpdateParams,
-    type InvoiceListParams as InvoiceListParams,
   };
 }
 

package/src/resources/leads.ts

@@ -10,6 +10,34 @@ import { path } from '../internal/utils/path';
  * Leads
  */
 export class Leads extends APIResource {
+  /**
+   * Returns a paginated list of leads for a company, with optional filtering by
+   * product and creation date.
+   *
+   * Required permissions:
+   *
+   * - `lead:basic:read`
+   * - `member:email:read`
+   * - `access_pass:basic:read`
+   * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const leadListResponse of client.leads.list({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   * })) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: LeadListParams,
+    options?: RequestOptions,
+  ): PagePromise<LeadListResponsesCursorPage, LeadListResponse> {
+    return this._client.getAPIList('/leads', CursorPage<LeadListResponse>, { query, ...options });
+  }
+
   /**
    * Record a new lead for a company, capturing a potential customer's interest in a
    * specific product.
@@ -77,34 +105,6 @@ export class Leads extends APIResource {
   ): APIPromise<Lead> {
     return this._client.patch(path`/leads/${id}`, { body, ...options });
   }
-
-  /**
-   * Returns a paginated list of leads for a company, with optional filtering by
-   * product and creation date.
-   *
-   * Required permissions:
-   *
-   * - `lead:basic:read`
-   * - `member:email:read`
-   * - `access_pass:basic:read`
-   * - `member:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const leadListResponse of client.leads.list({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   * })) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: LeadListParams,
-    options?: RequestOptions,
-  ): PagePromise<LeadListResponsesCursorPage, LeadListResponse> {
-    return this._client.getAPIList('/leads', CursorPage<LeadListResponse>, { query, ...options });
-  }
 }
 
 export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
@@ -319,85 +319,85 @@ export namespace LeadListResponse {
   }
 }
 
-export interface LeadCreateParams {
+export interface LeadListParams extends CursorPageParams {
   /**
-   * The unique identifier of the company to create the lead for, starting with
-   * 'biz\_'.
+   * The unique identifier of the company to list leads for.
    */
   company_id: string;
 
   /**
-   * A JSON object of custom metadata to attach to the lead for tracking purposes.
+   * Returns the elements in the list that come before the specified cursor.
    */
-  metadata?: { [key: string]: unknown } | null;
+  before?: string | null;
 
   /**
-   * The unique identifier of the product the lead is interested in, starting with
-   * 'prod\_'.
+   * Only return leads created after this timestamp.
    */
-  product_id?: string | null;
+  created_after?: string | null;
 
   /**
-   * The referral URL that brought the lead to the company, such as
-   * 'https://example.com/landing'.
+   * Only return leads created before this timestamp.
    */
-  referrer?: string | null;
+  created_before?: string | null;
 
   /**
-   * The unique identifier of the user to record as the lead. If authenticated as a
-   * user, that user is used automatically.
+   * Returns the first _n_ elements from the list.
    */
-  user_id?: string | null;
-}
+  first?: number | null;
 
-export interface LeadUpdateParams {
   /**
-   * A JSON object of custom metadata to set on the lead, replacing any existing
-   * metadata.
+   * Returns the last _n_ elements from the list.
    */
-  metadata?: { [key: string]: unknown } | null;
+  last?: number | null;
 
   /**
-   * The updated referral URL for the lead, such as 'https://example.com/landing'.
+   * Filter leads to only those associated with these specific product identifiers.
    */
-  referrer?: string | null;
+  product_ids?: Array<string> | null;
 }
 
-export interface LeadListParams extends CursorPageParams {
+export interface LeadCreateParams {
   /**
-   * The unique identifier of the company to list leads for.
+   * The unique identifier of the company to create the lead for, starting with
+   * 'biz\_'.
    */
   company_id: string;
 
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * A JSON object of custom metadata to attach to the lead for tracking purposes.
    */
-  before?: string | null;
+  metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Only return leads created after this timestamp.
+   * The unique identifier of the product the lead is interested in, starting with
+   * 'prod\_'.
    */
-  created_after?: string | null;
+  product_id?: string | null;
 
   /**
-   * Only return leads created before this timestamp.
+   * The referral URL that brought the lead to the company, such as
+   * 'https://example.com/landing'.
    */
-  created_before?: string | null;
+  referrer?: string | null;
 
   /**
-   * Returns the first _n_ elements from the list.
+   * The unique identifier of the user to record as the lead. If authenticated as a
+   * user, that user is used automatically.
    */
-  first?: number | null;
+  user_id?: string | null;
+}
 
+export interface LeadUpdateParams {
   /**
-   * Returns the last _n_ elements from the list.
+   * A JSON object of custom metadata to set on the lead, replacing any existing
+   * metadata.
    */
-  last?: number | null;
+  metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Filter leads to only those associated with these specific product identifiers.
+   * The updated referral URL for the lead, such as 'https://example.com/landing'.
    */
-  product_ids?: Array<string> | null;
+  referrer?: string | null;
 }
 
 export declare namespace Leads {
@@ -405,8 +405,8 @@ export declare namespace Leads {
     type Lead as Lead,
     type LeadListResponse as LeadListResponse,
     type LeadListResponsesCursorPage as LeadListResponsesCursorPage,
+    type LeadListParams as LeadListParams,
     type LeadCreateParams as LeadCreateParams,
     type LeadUpdateParams as LeadUpdateParams,
-    type LeadListParams as LeadListParams,
   };
 }

package/src/resources/ledger-accounts.ts

@@ -64,6 +64,11 @@ export interface LedgerAccountRetrieveResponse {
    * The fee for transfers, if applicable.
    */
   transfer_fee: number | null;
+
+  /**
+   * The balance cache associated with the account by currency.
+   */
+  treasury_balance: LedgerAccountRetrieveResponse.TreasuryBalance | null;
 }
 
 export namespace LedgerAccountRetrieveResponse {
@@ -257,7 +262,7 @@ export namespace LedgerAccountRetrieveResponse {
      */
     export interface LatestVerification {
       /**
-       * The unique identifier for the verification.
+       * The numeric id of the verification record.
        */
       id: string;
 
@@ -278,6 +283,41 @@ export namespace LedgerAccountRetrieveResponse {
       status: VerificationsAPI.VerificationStatus;
     }
   }
+
+  /**
+   * The balance cache associated with the account by currency.
+   */
+  export interface TreasuryBalance {
+    /**
+     * The amount of the balance.
+     */
+    balance: number;
+
+    /**
+     * The balance converted to USD.
+     */
+    balance_usd: number;
+
+    /**
+     * The currency of the balance.
+     */
+    currency: Shared.Currency;
+
+    /**
+     * The amount of the balance that is pending.
+     */
+    pending_balance: number;
+
+    /**
+     * The amount of the balance that is reserved.
+     */
+    reserve_balance: number;
+
+    /**
+     * The amount of the balance that is withdrawable.
+     */
+    total_withdrawable_balance: number;
+  }
 }
 
 export declare namespace LedgerAccounts {

package/src/resources/members.ts

@@ -12,7 +12,8 @@ import { path } from '../internal/utils/path';
  */
 export class Members extends APIResource {
   /**
-   * Retrieves the details of an existing member.
+   * Returns a paginated list of members for a company, with extensive filtering by
+   * product, plan, status, access level, and more.
    *
    * Required permissions:
    *
@@ -20,13 +21,15 @@ export class Members extends APIResource {
    * - `member:email:read`
    * - `member:phone:read`
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<MemberRetrieveResponse> {
-    return this._client.get(path`/members/${id}`, options);
+  list(
+    query: MemberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MemberListResponsesCursorPage, MemberListResponse> {
+    return this._client.getAPIList('/members', CursorPage<MemberListResponse>, { query, ...options });
   }
 
   /**
-   * Returns a paginated list of members for a company, with extensive filtering by
-   * product, plan, status, access level, and more.
+   * Retrieves the details of an existing member.
    *
    * Required permissions:
    *
@@ -34,11 +37,8 @@ export class Members extends APIResource {
    * - `member:email:read`
    * - `member:phone:read`
    */
-  list(
-    query: MemberListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<MemberListResponsesCursorPage, MemberListResponse> {
-    return this._client.getAPIList('/members', CursorPage<MemberListResponse>, { query, ...options });
+  retrieve(id: string, options?: RequestOptions): APIPromise<MemberRetrieveResponse> {
+    return this._client.get(path`/members/${id}`, options);
   }
 }
 
@@ -68,7 +68,8 @@ export interface MemberRetrieveResponse {
   company: MemberRetrieveResponse.Company;
 
   /**
-   * The member's token balance for this company
+   * The member's token balance for this company. Computed live from the ledger, not
+   * from a cache.
    */
   company_token_balance: number;
 
@@ -184,7 +185,8 @@ export interface MemberListResponse {
   access_level: Shared.AccessLevel;
 
   /**
-   * The member's token balance for this company
+   * The member's token balance for this company. Computed live from the ledger, not
+   * from a cache.
    */
   company_token_balance: number;