@whop/sdk 0.0.29 → 0.0.31

package/src/client.ts

@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -48,6 +48,10 @@ import {
   Apps,
 } from './resources/apps';
 import {
+  AuthorizedUserCreateParams,
+  AuthorizedUserCreateResponse,
+  AuthorizedUserDeleteParams,
+  AuthorizedUserDeleteResponse,
   AuthorizedUserListParams,
   AuthorizedUserListResponse,
   AuthorizedUserListResponsesCursorPage,
@@ -76,6 +80,7 @@ import {
   CompanyListResponse,
   CompanyListResponsesCursorPage,
   CompanyUpdateParams,
+  SocialLinkWebsites,
 } from './resources/companies';
 import {
   CompanyTokenTransaction,
@@ -248,6 +253,7 @@ import {
 } from './resources/members';
 import {
   CancelOptions,
+  MembershipAddFreeDaysParams,
   MembershipCancelParams,
   MembershipListParams,
   MembershipListResponse,
@@ -291,6 +297,7 @@ import {
   PaymentMethodTypes,
   PaymentRefundParams,
   Payments,
+  ReceiptTaxBehavior,
 } from './resources/payments';
 import {
   PayoutDestinationCategory,
@@ -310,7 +317,6 @@ import {
   Plans,
 } from './resources/plans';
 import {
-  IndustryGroups,
   ProductCreateParams,
   ProductDeleteResponse,
   ProductListParams,
@@ -667,8 +673,8 @@ export class Whop {
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'brackets' });
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -700,12 +706,13 @@ export class Whop {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -1034,9 +1041,9 @@ export class Whop {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -1169,7 +1176,7 @@ export class Whop {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });
@@ -1197,55 +1204,205 @@ export class Whop {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Apps
+   */
   apps: API.Apps = new API.Apps(this);
+  /**
+   * Invoices
+   */
   invoices: API.Invoices = new API.Invoices(this);
+  /**
+   * Course lesson interactions
+   */
   courseLessonInteractions: API.CourseLessonInteractions = new API.CourseLessonInteractions(this);
+  /**
+   * Products
+   */
   products: API.Products = new API.Products(this);
+  /**
+   * Companies
+   */
   companies: API.Companies = new API.Companies(this);
+  /**
+   * Webhooks
+   */
   webhooks: API.Webhooks = new API.Webhooks(this);
+  /**
+   * Plans
+   */
   plans: API.Plans = new API.Plans(this);
+  /**
+   * Entries
+   */
   entries: API.Entries = new API.Entries(this);
+  /**
+   * Forum posts
+   */
   forumPosts: API.ForumPosts = new API.ForumPosts(this);
+  /**
+   * Transfers
+   */
   transfers: API.Transfers = new API.Transfers(this);
+  /**
+   * Ledger accounts
+   */
   ledgerAccounts: API.LedgerAccounts = new API.LedgerAccounts(this);
+  /**
+   * Memberships
+   */
   memberships: API.Memberships = new API.Memberships(this);
+  /**
+   * Authorized users
+   */
   authorizedUsers: API.AuthorizedUsers = new API.AuthorizedUsers(this);
+  /**
+   * App builds
+   */
   appBuilds: API.AppBuilds = new API.AppBuilds(this);
+  /**
+   * Shipments
+   */
   shipments: API.Shipments = new API.Shipments(this);
+  /**
+   * Checkout configurations
+   */
   checkoutConfigurations: API.CheckoutConfigurations = new API.CheckoutConfigurations(this);
+  /**
+   * Messages
+   */
   messages: API.Messages = new API.Messages(this);
+  /**
+   * Chat channels
+   */
   chatChannels: API.ChatChannels = new API.ChatChannels(this);
+  /**
+   * Users
+   */
   users: API.Users = new API.Users(this);
+  /**
+   * Payments
+   */
   payments: API.Payments = new API.Payments(this);
+  /**
+   * Support channels
+   */
   supportChannels: API.SupportChannels = new API.SupportChannels(this);
+  /**
+   * Experiences
+   */
   experiences: API.Experiences = new API.Experiences(this);
+  /**
+   * Reactions
+   */
   reactions: API.Reactions = new API.Reactions(this);
+  /**
+   * Members
+   */
   members: API.Members = new API.Members(this);
+  /**
+   * Forums
+   */
   forums: API.Forums = new API.Forums(this);
+  /**
+   * Promo codes
+   */
   promoCodes: API.PromoCodes = new API.PromoCodes(this);
+  /**
+   * Courses
+   */
   courses: API.Courses = new API.Courses(this);
+  /**
+   * Course chapters
+   */
   courseChapters: API.CourseChapters = new API.CourseChapters(this);
+  /**
+   * Course lessons
+   */
   courseLessons: API.CourseLessons = new API.CourseLessons(this);
+  /**
+   * Reviews
+   */
   reviews: API.Reviews = new API.Reviews(this);
+  /**
+   * Course students
+   */
   courseStudents: API.CourseStudents = new API.CourseStudents(this);
+  /**
+   * Access tokens
+   */
   accessTokens: API.AccessTokens = new API.AccessTokens(this);
+  /**
+   * Notifications
+   */
   notifications: API.Notifications = new API.Notifications(this);
+  /**
+   * Disputes
+   */
   disputes: API.Disputes = new API.Disputes(this);
+  /**
+   * Refunds
+   */
   refunds: API.Refunds = new API.Refunds(this);
+  /**
+   * Withdrawals
+   */
   withdrawals: API.Withdrawals = new API.Withdrawals(this);
+  /**
+   * Account links
+   */
   accountLinks: API.AccountLinks = new API.AccountLinks(this);
+  /**
+   * Setup intents
+   */
   setupIntents: API.SetupIntents = new API.SetupIntents(this);
+  /**
+   * Payment methods
+   */
   paymentMethods: API.PaymentMethods = new API.PaymentMethods(this);
+  /**
+   * Fee markups
+   */
   feeMarkups: API.FeeMarkups = new API.FeeMarkups(this);
+  /**
+   * Payout methods
+   */
   payoutMethods: API.PayoutMethods = new API.PayoutMethods(this);
+  /**
+   * Verifications
+   */
   verifications: API.Verifications = new API.Verifications(this);
+  /**
+   * Leads
+   */
   leads: API.Leads = new API.Leads(this);
+  /**
+   * Topups
+   */
   topups: API.Topups = new API.Topups(this);
+  /**
+   * Files
+   */
   files: API.Files = new API.Files(this);
+  /**
+   * Company token transactions
+   */
   companyTokenTransactions: API.CompanyTokenTransactions = new API.CompanyTokenTransactions(this);
+  /**
+   * Dm members
+   */
   dmMembers: API.DmMembers = new API.DmMembers(this);
+  /**
+   * Ai chats
+   */
   aiChats: API.AIChats = new API.AIChats(this);
+  /**
+   * Dm channels
+   */
   dmChannels: API.DmChannels = new API.DmChannels(this);
+  /**
+   * Dispute alerts
+   */
   disputeAlerts: API.DisputeAlerts = new API.DisputeAlerts(this);
 }
 
@@ -1330,7 +1487,6 @@ export declare namespace Whop {
 
   export {
     Products as Products,
-    type IndustryGroups as IndustryGroups,
     type ProductDeleteResponse as ProductDeleteResponse,
     type ProductCreateParams as ProductCreateParams,
     type ProductUpdateParams as ProductUpdateParams,
@@ -1339,6 +1495,7 @@ export declare namespace Whop {
 
   export {
     Companies as Companies,
+    type SocialLinkWebsites as SocialLinkWebsites,
     type CompanyListResponse as CompanyListResponse,
     type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage,
     type CompanyCreateParams as CompanyCreateParams,
@@ -1437,16 +1594,21 @@ export declare namespace Whop {
     type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage,
     type MembershipUpdateParams as MembershipUpdateParams,
     type MembershipListParams as MembershipListParams,
+    type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams,
     type MembershipCancelParams as MembershipCancelParams,
     type MembershipPauseParams as MembershipPauseParams,
   };
 
   export {
     AuthorizedUsers as AuthorizedUsers,
+    type AuthorizedUserCreateResponse as AuthorizedUserCreateResponse,
     type AuthorizedUserRetrieveResponse as AuthorizedUserRetrieveResponse,
     type AuthorizedUserListResponse as AuthorizedUserListResponse,
+    type AuthorizedUserDeleteResponse as AuthorizedUserDeleteResponse,
     type AuthorizedUserListResponsesCursorPage as AuthorizedUserListResponsesCursorPage,
+    type AuthorizedUserCreateParams as AuthorizedUserCreateParams,
     type AuthorizedUserListParams as AuthorizedUserListParams,
+    type AuthorizedUserDeleteParams as AuthorizedUserDeleteParams,
   };
 
   export {
@@ -1505,6 +1667,7 @@ export declare namespace Whop {
     type BillingReasons as BillingReasons,
     type CardBrands as CardBrands,
     type PaymentMethodTypes as PaymentMethodTypes,
+    type ReceiptTaxBehavior as ReceiptTaxBehavior,
     type PaymentListResponse as PaymentListResponse,
     type PaymentListFeesResponse as PaymentListFeesResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,
@@ -1818,7 +1981,6 @@ export declare namespace Whop {
   export type AppStatuses = API.AppStatuses;
   export type AppViewType = API.AppViewType;
   export type AuthorizedUserRoles = API.AuthorizedUserRoles;
-  export type BusinessTypes = API.BusinessTypes;
   export type ChatChannel = API.ChatChannel;
   export type CheckoutConfiguration = API.CheckoutConfiguration;
   export type CollectionMethod = API.CollectionMethod;
@@ -1837,7 +1999,6 @@ export declare namespace Whop {
   export type ForumPost = API.ForumPost;
   export type FriendlyReceiptStatus = API.FriendlyReceiptStatus;
   export type GlobalAffiliateStatus = API.GlobalAffiliateStatus;
-  export type IndustryTypes = API.IndustryTypes;
   export type Invoice = API.Invoice;
   export type InvoiceListItem = API.InvoiceListItem;
   export type InvoiceStatus = API.InvoiceStatus;

package/src/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'brackets' });
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/access-tokens.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Access tokens
+ */
 export class AccessTokens extends APIResource {
   /**
    * Create a short-lived access token for authenticating API requests. When using

package/src/resources/account-links.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Account links
+ */
 export class AccountLinks extends APIResource {
   /**
    * Generate a URL that directs a sub-merchant to their account portal, such as the

package/src/resources/ai-chats.ts

@@ -6,6 +6,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Ai chats
+ */
 export class AIChats extends APIResource {
   /**
    * Create a new AI chat thread and send the first message to the AI agent.
@@ -212,6 +215,12 @@ export interface AIChatCreateParams {
    */
   message_source?: 'manual' | 'suggestion' | 'link' | null;
 
+  /**
+   * The type of suggestion prompt that was clicked, when message_source is
+   * 'suggestion'.
+   */
+  suggestion_type?: string | null;
+
   /**
    * An optional display title for the AI chat thread (e.g., "Help with billing").
    */

package/src/resources/app-builds.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * App builds
+ */
 export class AppBuilds extends APIResource {
   /**
    * Upload a new build artifact for an app. The build must include a compiled code

package/src/resources/apps.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Apps
+ */
 export class Apps extends APIResource {
   /**
    * Register a new app on the Whop developer platform. Apps provide custom

package/src/resources/authorized-users.ts

@@ -7,7 +7,34 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Authorized users
+ */
 export class AuthorizedUsers extends APIResource {
+  /**
+   * Add a new authorized user to a company.
+   *
+   * Required permissions:
+   *
+   * - `authorized_user:create`
+   * - `member:email:read`
+   *
+   * @example
+   * ```ts
+   * const authorizedUser = await client.authorizedUsers.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   role: 'owner',
+   *   user_id: 'user_xxxxxxxxxxxxx',
+   * });
+   * ```
+   */
+  create(
+    body: AuthorizedUserCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AuthorizedUserCreateResponse> {
+    return this._client.post('/authorized_users', { body, ...options });
+  }
+
   /**
    * Retrieves the details of an existing authorized user.
    *
@@ -15,6 +42,14 @@ export class AuthorizedUsers extends APIResource {
    *
    * - `company:authorized_user:read`
    * - `member:email:read`
+   *
+   * @example
+   * ```ts
+   * const authorizedUser =
+   *   await client.authorizedUsers.retrieve(
+   *     'ausr_xxxxxxxxxxxxx',
+   *   );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<AuthorizedUserRetrieveResponse> {
     return this._client.get(path`/authorized_users/${id}`, options);
@@ -28,6 +63,14 @@ export class AuthorizedUsers extends APIResource {
    *
    * - `company:authorized_user:read`
    * - `member:email:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const authorizedUserListResponse of client.authorizedUsers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: AuthorizedUserListParams | null | undefined = {},
@@ -38,10 +81,102 @@ export class AuthorizedUsers extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Remove an authorized user from a company.
+   *
+   * Required permissions:
+   *
+   * - `authorized_user:delete`
+   *
+   * @example
+   * ```ts
+   * const authorizedUser = await client.authorizedUsers.delete(
+   *   'ausr_xxxxxxxxxxxxx',
+   * );
+   * ```
+   */
+  delete(
+    id: string,
+    params: AuthorizedUserDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AuthorizedUserDeleteResponse> {
+    const { company_id } = params ?? {};
+    return this._client.delete(path`/authorized_users/${id}`, { query: { company_id }, ...options });
+  }
 }
 
 export type AuthorizedUserListResponsesCursorPage = CursorPage<AuthorizedUserListResponse>;
 
+/**
+ * A user who has been granted administrative access to manage a company's
+ * dashboard and settings.
+ */
+export interface AuthorizedUserCreateResponse {
+  /**
+   * The unique identifier for the authorized user.
+   */
+  id: string;
+
+  /**
+   * The company this authorized user has access to.
+   */
+  company: AuthorizedUserCreateResponse.Company;
+
+  /**
+   * The permission role assigned to this authorized user within the company.
+   */
+  role: Shared.AuthorizedUserRoles;
+
+  /**
+   * The user account linked to this authorized user record.
+   */
+  user: AuthorizedUserCreateResponse.User;
+}
+
+export namespace AuthorizedUserCreateResponse {
+  /**
+   * The company this authorized user has access to.
+   */
+  export interface Company {
+    /**
+     * The unique identifier for the company.
+     */
+    id: string;
+
+    /**
+     * The display name of the company shown to customers.
+     */
+    title: string;
+  }
+
+  /**
+   * The user account linked to this authorized user record.
+   */
+  export interface User {
+    /**
+     * The unique identifier for the user.
+     */
+    id: string;
+
+    /**
+     * The user's email address. Requires the member:email:read permission to access.
+     * Null if not authorized.
+     */
+    email: string | null;
+
+    /**
+     * The user's display name shown on their public profile.
+     */
+    name: string | null;
+
+    /**
+     * The user's unique username shown on their public profile.
+     */
+    username: string;
+  }
+}
+
 /**
  * A user who has been granted administrative access to manage a company's
  * dashboard and settings.
@@ -180,6 +315,34 @@ export namespace AuthorizedUserListResponse {
   }
 }
 
+/**
+ * Represents `true` or `false` values.
+ */
+export type AuthorizedUserDeleteResponse = boolean;
+
+export interface AuthorizedUserCreateParams {
+  /**
+   * The ID of the company to add the authorized user to.
+   */
+  company_id: string;
+
+  /**
+   * The role to assign to the authorized user within the company. Supported roles:
+   * 'moderator', 'sales_manager'.
+   */
+  role: Shared.AuthorizedUserRoles;
+
+  /**
+   * The ID of the user to add as an authorized user.
+   */
+  user_id: string;
+
+  /**
+   * Whether to send notification emails to the user on creation.
+   */
+  send_emails?: boolean | null;
+}
+
 export interface AuthorizedUserListParams extends CursorPageParams {
   /**
    * Returns the elements in the list that come before the specified cursor.
@@ -223,11 +386,23 @@ export interface AuthorizedUserListParams extends CursorPageParams {
   user_id?: string | null;
 }
 
+export interface AuthorizedUserDeleteParams {
+  /**
+   * The ID of the company the authorized user belongs to. Optional if the authorized
+   * user ID is provided.
+   */
+  company_id?: string | null;
+}
+
 export declare namespace AuthorizedUsers {
   export {
+    type AuthorizedUserCreateResponse as AuthorizedUserCreateResponse,
     type AuthorizedUserRetrieveResponse as AuthorizedUserRetrieveResponse,
     type AuthorizedUserListResponse as AuthorizedUserListResponse,
+    type AuthorizedUserDeleteResponse as AuthorizedUserDeleteResponse,
     type AuthorizedUserListResponsesCursorPage as AuthorizedUserListResponsesCursorPage,
+    type AuthorizedUserCreateParams as AuthorizedUserCreateParams,
     type AuthorizedUserListParams as AuthorizedUserListParams,
+    type AuthorizedUserDeleteParams as AuthorizedUserDeleteParams,
   };
 }

package/src/resources/chat-channels.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Chat channels
+ */
 export class ChatChannels extends APIResource {
   /**
    * Retrieves the details of an existing chat channel.