@whop/sdk 0.0.30 → 0.0.31

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.

package/src/resources/checkout-configurations.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Checkout configurations
+ */
 export class CheckoutConfigurations extends APIResource {
   /**
    * Creates a new checkout configuration

package/src/resources/companies.ts

@@ -1,12 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as CompaniesAPI from './companies';
 import * as Shared from './shared';
 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';
 
+/**
+ * Companies
+ */
 export class Companies extends APIResource {
   /**
    * Create a new company. Pass parent_company_id to create a connected account under
@@ -67,6 +71,20 @@ export class Companies extends APIResource {
 
 export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
 
+/**
+ * The different websites you can have social links for
+ */
+export type SocialLinkWebsites =
+  | 'x'
+  | 'instagram'
+  | 'facebook'
+  | 'tiktok'
+  | 'youtube'
+  | 'linkedin'
+  | 'twitch'
+  | 'website'
+  | 'custom';
+
 /**
  * A company is a seller on Whop. Companies own products, manage members, and
  * receive payouts.
@@ -260,6 +278,12 @@ export interface CompanyUpdateParams {
    */
   send_customer_emails?: boolean | null;
 
+  /**
+   * The social media links to display on the company's store page. Pass the full
+   * list of desired social links — any existing links not included will be removed.
+   */
+  social_links?: Array<CompanyUpdateParams.SocialLink> | null;
+
   /**
    * The target audience for this company (e.g., 'beginner day traders aged 18-25
    * looking to learn options').
@@ -292,6 +316,53 @@ export namespace CompanyUpdateParams {
      */
     id: string;
   }
+
+  /**
+   * Input for creating a social link for a company
+   */
+  export interface SocialLink {
+    /**
+     * The URL of the social link
+     */
+    url: string;
+
+    /**
+     * The website this link is for
+     */
+    website: CompaniesAPI.SocialLinkWebsites;
+
+    /**
+     * The custom image for the social link
+     */
+    image?: SocialLink.Image | null;
+
+    /**
+     * The order of the social link
+     */
+    order?: string | null;
+
+    /**
+     * The title of the social link
+     */
+    title?: string | null;
+
+    /**
+     * The order of the website social link
+     */
+    website_order?: string | null;
+  }
+
+  export namespace SocialLink {
+    /**
+     * The custom image for the social link
+     */
+    export interface Image {
+      /**
+       * The ID of an existing file object.
+       */
+      id: string;
+    }
+  }
 }
 
 export interface CompanyListParams extends CursorPageParams {
@@ -335,6 +406,7 @@ export interface CompanyListParams extends CursorPageParams {
 
 export declare namespace Companies {
   export {
+    type SocialLinkWebsites as SocialLinkWebsites,
     type CompanyListResponse as CompanyListResponse,
     type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage,
     type CompanyCreateParams as CompanyCreateParams,

package/src/resources/company-token-transactions.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';
 
+/**
+ * Company token transactions
+ */
 export class CompanyTokenTransactions extends APIResource {
   /**
    * Create a token transaction to add, subtract, or transfer tokens for a member

package/src/resources/course-chapters.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';
 
+/**
+ * Course chapters
+ */
 export class CourseChapters extends APIResource {
   /**
    * Create a new chapter within a course to organize lessons into sections.

package/src/resources/course-lesson-interactions.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Course lesson interactions
+ */
 export class CourseLessonInteractions extends APIResource {
   /**
    * Retrieves the details of an existing course lesson interaction.

package/src/resources/course-lessons.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';
 
+/**
+ * Course lessons
+ */
 export class CourseLessons extends APIResource {
   /**
    * Create a new lesson within a course chapter. Lessons can contain video, text, or

package/src/resources/course-students.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';
 
+/**
+ * Course students
+ */
 export class CourseStudents extends APIResource {
   /**
    * Retrieves the details of an existing course student.

package/src/resources/courses.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';
 
+/**
+ * Courses
+ */
 export class Courses extends APIResource {
   /**
    * Create a new course within an experience, with optional chapters, lessons, and a

package/src/resources/dispute-alerts.ts

@@ -9,6 +9,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Dispute alerts
+ */
 export class DisputeAlerts extends APIResource {
   /**
    * Retrieves the details of an existing dispute alert.

package/src/resources/disputes.ts

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

package/src/resources/dm-channels.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';
 
+/**
+ * Dm channels
+ */
 export class DmChannels extends APIResource {
   /**
    * Create a new DM channel between two or more users, optionally scoped to a

package/src/resources/dm-members.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';
 
+/**
+ * Dm members
+ */
 export class DmMembers extends APIResource {
   /**
    * Add a new user to an existing DM channel. Only an admin of the channel can add

package/src/resources/entries.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';
 
+/**
+ * Entries
+ */
 export class Entries extends APIResource {
   /**
    * Retrieves the details of an existing waitlist entry.

package/src/resources/experiences.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';
 
+/**
+ * Experiences
+ */
 export class Experiences extends APIResource {
   /**
    * Required permissions:

package/src/resources/fee-markups.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';
 
+/**
+ * Fee markups
+ */
 export class FeeMarkups extends APIResource {
   /**
    * Create or update a fee markup for a company. If a markup for the specified fee

package/src/resources/files.ts

@@ -7,6 +7,9 @@ import { path } from '../internal/utils/path';
 import type { ToFileInput, Uploadable } from '../core/uploads';
 import { uploadFile } from '../lib/upload-file';
 
+/**
+ * Files
+ */
 export class Files extends APIResource {
   /**
    * Create a new file record and receive a presigned URL for uploading content to

package/src/resources/forum-posts.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';
 
+/**
+ * Forum posts
+ */
 export class ForumPosts extends APIResource {
   /**
    * Create a new forum post or comment within an experience. Supports text content,
@@ -108,6 +111,11 @@ export interface ForumPostListResponse {
    */
   id: string;
 
+  /**
+   * All file attachments on this post, such as images, documents, and videos.
+   */
+  attachments: Array<ForumPostListResponse.Attachment>;
+
   /**
    * The total number of direct comments on this post.
    */
@@ -171,6 +179,36 @@ export interface ForumPostListResponse {
 }
 
 export namespace ForumPostListResponse {
+  /**
+   * Represents an image attachment
+   */
+  export interface Attachment {
+    /**
+     * 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;
+
+    /**
+     * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
+     */
+    content_type: string | null;
+
+    /**
+     * The original filename of the uploaded attachment, including its file extension.
+     */
+    filename: string | null;
+
+    /**
+     * A pre-optimized URL for rendering this attachment on the client. This should be
+     * used for displaying attachments in apps.
+     */
+    url: string | null;
+  }
+
   /**
    * The user who authored this forum post.
    */
@@ -251,6 +289,12 @@ export interface ForumPostCreateParams {
    */
   poll?: ForumPostCreateParams.Poll | null;
 
+  /**
+   * The rich content of the post in Tiptap JSON format. When provided, takes
+   * priority over the markdown content field for rendering.
+   */
+  rich_content?: string | null;
+
   /**
    * The title of the post, displayed prominently at the top. Required for paywalled
    * posts as it remains visible to non-purchasers.

package/src/resources/forums.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';
 
+/**
+ * Forums
+ */
 export class Forums extends APIResource {
   /**
    * Retrieves the details of an existing forum.
@@ -106,6 +109,12 @@ export namespace ForumListResponse {
 }
 
 export interface ForumUpdateParams {
+  /**
+   * The banner image displayed at the top of the forum page. Pass null to remove the
+   * existing banner.
+   */
+  banner_image?: ForumUpdateParams.BannerImage | null;
+
   /**
    * Email notification preference option for a forum feed
    */
@@ -122,6 +131,19 @@ export interface ForumUpdateParams {
   who_can_post?: Shared.WhoCanPostTypes | null;
 }
 
+export namespace ForumUpdateParams {
+  /**
+   * The banner image displayed at the top of the forum page. Pass null to remove the
+   * existing banner.
+   */
+  export interface BannerImage {
+    /**
+     * The ID of an existing file object.
+     */
+    id: string;
+  }
+}
+
 export interface ForumListParams extends CursorPageParams {
   /**
    * The unique identifier of the company to list forums for.

package/src/resources/index.ts

@@ -31,9 +31,13 @@ export {
 } from './apps';
 export {
   AuthorizedUsers,
+  type AuthorizedUserCreateResponse,
   type AuthorizedUserRetrieveResponse,
   type AuthorizedUserListResponse,
+  type AuthorizedUserDeleteResponse,
+  type AuthorizedUserCreateParams,
   type AuthorizedUserListParams,
+  type AuthorizedUserDeleteParams,
   type AuthorizedUserListResponsesCursorPage,
 } from './authorized-users';
 export {
@@ -53,6 +57,7 @@ export {
 } from './checkout-configurations';
 export {
   Companies,
+  type SocialLinkWebsites,
   type CompanyListResponse,
   type CompanyCreateParams,
   type CompanyUpdateParams,
@@ -239,6 +244,7 @@ export {
   type MembershipListResponse,
   type MembershipUpdateParams,
   type MembershipListParams,
+  type MembershipAddFreeDaysParams,
   type MembershipCancelParams,
   type MembershipPauseParams,
   type MembershipListResponsesCursorPage,
@@ -270,6 +276,7 @@ export {
   type BillingReasons,
   type CardBrands,
   type PaymentMethodTypes,
+  type ReceiptTaxBehavior,
   type PaymentListResponse,
   type PaymentListFeesResponse,
   type PaymentCreateParams,