@whop/sdk 0.0.27 → 0.0.29

package/src/resources/experiences.ts

@@ -26,7 +26,7 @@ export class Experiences extends APIResource {
   }
 
   /**
-   * Retrieves an experience by ID
+   * Retrieves the details of an existing experience.
    *
    * @example
    * ```ts
@@ -60,11 +60,8 @@ export class Experiences extends APIResource {
   }
 
   /**
-   * Lists experiences for a company
-   *
-   * Required permissions:
-   *
-   * - `experience:hidden_experience:read`
+   * Returns a paginated list of experiences belonging to a company, with optional
+   * filtering by product and app.
    *
    * @example
    * ```ts
@@ -100,7 +97,7 @@ export class Experiences extends APIResource {
   }
 
   /**
-   * Adds an experience to an product, making it accessible to the product's
+   * Attach an experience to a product, making it accessible to the product's
    * customers.
    *
    * Required permissions:
@@ -120,8 +117,8 @@ export class Experiences extends APIResource {
   }
 
   /**
-   * Removes an experience from an product, making it inaccessible to the product's
-   * customers.
+   * Detach an experience from a product, removing customer access to it through that
+   * product.
    *
    * Required permissions:
    *
@@ -171,7 +168,7 @@ export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListRespons
 
 /**
  * An experience is a feature or content module within a product, such as a chat,
- * course, or app.
+ * course, or custom app.
  */
 export interface ExperienceListResponse {
   /**
@@ -180,7 +177,7 @@ export interface ExperienceListResponse {
   id: string;
 
   /**
-   * The experience interface for this experience.
+   * The app that powers this experience, defining its interface and behavior.
    */
   app: ExperienceListResponse.App;
 
@@ -195,29 +192,33 @@ export interface ExperienceListResponse {
   created_at: string;
 
   /**
-   * The logo for the experience.
+   * The custom logo image for this experience. Null if no custom logo has been
+   * uploaded.
    */
   image: ExperienceListResponse.Image | null;
 
   /**
-   * Whether the experience is visible to the public
+   * Whether this experience is publicly visible to all users, including those
+   * without a membership.
    */
   is_public: boolean;
 
   /**
-   * The written name of the description.
+   * The display name of this experience shown to users in the product navigation.
+   * Maximum 255 characters.
    */
   name: string;
 
   /**
-   * The order of the experience in the section
+   * The sort position of this experience within its section. Lower values appear
+   * first. Null if no position has been set.
    */
   order: string | null;
 }
 
 export namespace ExperienceListResponse {
   /**
-   * The experience interface for this experience.
+   * The app that powers this experience, defining its interface and behavior.
    */
   export interface App {
     /**
@@ -226,26 +227,27 @@ export namespace ExperienceListResponse {
     id: string;
 
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     icon: App.Icon | null;
 
     /**
-     * The name of the app
+     * The display name of this app shown on the app store and in experience
+     * navigation. Maximum 30 characters.
      */
     name: string;
   }
 
   export namespace App {
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     export interface Icon {
       /**
-       * This is the URL you use to render optimized attachments on the client. This
-       * should be used for apps.
+       * A pre-optimized URL for rendering this attachment on the client. This should be
+       * used for displaying attachments in apps.
        */
       url: string | null;
     }
@@ -261,23 +263,24 @@ export namespace ExperienceListResponse {
     id: string;
 
     /**
-     * The slug/route of the company on the Whop site.
+     * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
      */
     route: string;
 
     /**
-     * The title of the company.
+     * The display name of the company shown to customers.
      */
     title: string;
   }
 
   /**
-   * The logo for the experience.
+   * The custom logo image for this experience. Null if no custom logo has been
+   * uploaded.
    */
   export interface Image {
     /**
-     * This is the URL you use to render optimized attachments on the client. This
-     * should be used for apps.
+     * A pre-optimized URL for rendering this attachment on the client. This should be
+     * used for displaying attachments in apps.
      */
     url: string | null;
   }
@@ -290,39 +293,39 @@ export type ExperienceDeleteResponse = boolean;
 
 export interface ExperienceCreateParams {
   /**
-   * The ID of the app to create the experience for
+   * The unique identifier of the app that powers this experience.
    */
   app_id: string;
 
   /**
-   * The ID of the company to create the experience for
+   * The unique identifier of the company to create this experience for.
    */
   company_id: string;
 
   /**
-   * Whether the experience is publicly accessible
+   * Whether the experience is publicly accessible without a membership.
    */
   is_public?: boolean | null;
 
   /**
-   * The logo for the experience
+   * A logo image displayed alongside the experience name.
    */
   logo?: ExperienceCreateParams.Logo | null;
 
   /**
-   * The name of the experience
+   * The display name of the experience. Defaults to the app's name if not provided.
    */
   name?: string | null;
 
   /**
-   * The ID of the section to create the experience in
+   * The unique identifier of the section to place the experience in.
    */
   section_id?: string | null;
 }
 
 export namespace ExperienceCreateParams {
   /**
-   * The logo for the experience
+   * A logo image displayed alongside the experience name.
    */
   export interface Logo {
     /**
@@ -339,34 +342,34 @@ export interface ExperienceUpdateParams {
   access_level?: 'public' | 'private' | null;
 
   /**
-   * Whether the experience is publicly accessible.
+   * Whether the experience is publicly accessible without a membership.
    */
   is_public?: boolean | null;
 
   /**
-   * The logo for the experience
+   * A logo image displayed alongside the experience name.
    */
   logo?: ExperienceUpdateParams.Logo | null;
 
   /**
-   * The name of the experience.
+   * The display name of the experience.
    */
   name?: string | null;
 
   /**
-   * The order of the experience in the section.
+   * The position of the experience within its section for display ordering.
    */
   order?: string | null;
 
   /**
-   * The ID of the section to update.
+   * The unique identifier of the section to move the experience into.
    */
   section_id?: string | null;
 }
 
 export namespace ExperienceUpdateParams {
   /**
-   * The logo for the experience
+   * A logo image displayed alongside the experience name.
    */
   export interface Logo {
     /**
@@ -378,12 +381,12 @@ export namespace ExperienceUpdateParams {
 
 export interface ExperienceListParams extends CursorPageParams {
   /**
-   * The ID of the company to filter experiences by
+   * The unique identifier of the company to list experiences for.
    */
   company_id: string;
 
   /**
-   * The ID of the app to filter experiences by
+   * Filter to only experiences powered by this app identifier.
    */
   app_id?: string | null;
 
@@ -393,12 +396,12 @@ export interface ExperienceListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return experiences created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return experiences created before this timestamp.
    */
   created_before?: string | null;
 
@@ -413,28 +416,29 @@ export interface ExperienceListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The ID of the product to filter experiences by
+   * Filter to only experiences attached to this product identifier.
    */
   product_id?: string | null;
 }
 
 export interface ExperienceAttachParams {
   /**
-   * The ID of the Access Pass to add the Experience to.
+   * The unique identifier of the product to attach the experience to.
    */
   product_id: string;
 }
 
 export interface ExperienceDetachParams {
   /**
-   * The ID of the Access Pass to add the Experience to.
+   * The unique identifier of the product to detach the experience from.
    */
   product_id: string;
 }
 
 export interface ExperienceDuplicateParams {
   /**
-   * The name of the new experience
+   * The display name for the duplicated experience. Defaults to the original
+   * experience's name.
    */
   name?: string | null;
 }

package/src/resources/fee-markups.ts

@@ -8,7 +8,8 @@ import { path } from '../internal/utils/path';
 
 export class FeeMarkups extends APIResource {
   /**
-   * Creates or updates a fee markup for a company.
+   * Create or update a fee markup for a company. If a markup for the specified fee
+   * type already exists, it will be updated with the new values.
    *
    * Required permissions:
    *
@@ -27,7 +28,8 @@ export class FeeMarkups extends APIResource {
   }
 
   /**
-   * Lists fee markups for a company.
+   * Returns a paginated list of fee markups configured for a company. If the company
+   * is a platform account, returns the platform default markups.
    *
    * Required permissions:
    *
@@ -51,7 +53,8 @@ export class FeeMarkups extends APIResource {
   }
 
   /**
-   * Deletes a fee markup for a company.
+   * Delete a fee markup configuration for a company. This removes the custom fee
+   * override and reverts to the parent company's default fees.
    *
    * Required permissions:
    *
@@ -80,7 +83,8 @@ export type FeeMarkupType =
   | 'digital_wallet_withdrawal_markup';
 
 /**
- * Represents a fee markup configuration for a company
+ * A fee markup configuration that defines additional charges applied to
+ * transactions for a platform's connected accounts.
  */
 export interface FeeMarkupCreateResponse {
   /**
@@ -94,22 +98,25 @@ export interface FeeMarkupCreateResponse {
   created_at: string;
 
   /**
-   * The type of fee this markup applies to.
+   * The category of fee this markup applies to.
    */
   fee_type: FeeMarkupType;
 
   /**
-   * The fixed fee in USD to charge (0-50).
+   * A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
+   * fixed fee is configured.
    */
   fixed_fee_usd: number | null;
 
   /**
-   * Internal notes about this fee markup.
+   * Internal notes about this fee markup, visible only to administrators. Null if no
+   * notes have been added.
    */
   notes: string | null;
 
   /**
-   * The percentage fee to charge (0-25).
+   * A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
+   * percentage fee is configured.
    */
   percentage_fee: number | null;
 
@@ -120,7 +127,8 @@ export interface FeeMarkupCreateResponse {
 }
 
 /**
- * Represents a fee markup configuration for a company
+ * A fee markup configuration that defines additional charges applied to
+ * transactions for a platform's connected accounts.
  */
 export interface FeeMarkupListResponse {
   /**
@@ -134,22 +142,25 @@ export interface FeeMarkupListResponse {
   created_at: string;
 
   /**
-   * The type of fee this markup applies to.
+   * The category of fee this markup applies to.
    */
   fee_type: FeeMarkupType;
 
   /**
-   * The fixed fee in USD to charge (0-50).
+   * A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
+   * fixed fee is configured.
    */
   fixed_fee_usd: number | null;
 
   /**
-   * Internal notes about this fee markup.
+   * Internal notes about this fee markup, visible only to administrators. Null if no
+   * notes have been added.
    */
   notes: string | null;
 
   /**
-   * The percentage fee to charge (0-25).
+   * A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
+   * percentage fee is configured.
    */
   percentage_fee: number | null;
 
@@ -166,40 +177,40 @@ export type FeeMarkupDeleteResponse = boolean;
 
 export interface FeeMarkupCreateParams {
   /**
-   * The ID (tag) of the company you want to update the fee markup for.
+   * The unique identifier of the company to create or update the fee markup for.
    */
   company_id: string;
 
   /**
-   * The type of fee this markup applies to.
+   * The type of fee this markup applies to, such as processing or platform fees.
    */
   fee_type: FeeMarkupType;
 
   /**
-   * The fixed fee in USD to charge (0-50).
+   * The fixed fee amount in USD to charge per transaction. Must be between 0 and 50.
    */
   fixed_fee_usd?: number | null;
 
   /**
-   * Custom metadata to attach to this fee markup.
+   * Custom key-value metadata to attach to this fee markup.
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Internal notes about this fee markup.
+   * Internal notes about this fee markup for record-keeping purposes.
    */
   notes?: string | null;
 
   /**
-   * The percentage fee to charge (0-25).
+   * The percentage fee to charge per transaction. Must be between 0 and 25.
    */
   percentage_fee?: number | null;
 }
 
 export interface FeeMarkupListParams extends CursorPageParams {
   /**
-   * The ID (tag) of the company you want to list the fee markups for. If you pass
-   * your platform account, you will get the platform default markups.
+   * The unique identifier of the company to list fee markups for. Pass a platform
+   * account identifier to retrieve platform default markups.
    */
   company_id: string;
 

package/src/resources/files.ts

@@ -9,14 +9,15 @@ import { uploadFile } from '../lib/upload-file';
 
 export class Files extends APIResource {
   /**
-   * Creates a file and returns a presigned URL for upload
+   * Create a new file record and receive a presigned URL for uploading content to
+   * S3.
    */
   create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
     return this._client.post('/files', { body, ...options });
   }
 
   /**
-   * Retrieves a file by its ID
+   * Retrieves the details of an existing file.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<FileRetrieveResponse> {
     return this._client.get(path`/files/${id}`, options);
@@ -42,7 +43,7 @@ export class Files extends APIResource {
 export type UploadStatus = 'pending' | 'processing' | 'ready' | 'failed';
 
 /**
- * A file that has been uploaded or is pending upload
+ * A file that has been uploaded or is pending upload.
  */
 export interface FileCreateResponse {
   /**
@@ -51,43 +52,45 @@ export interface FileCreateResponse {
   id: string;
 
   /**
-   * The MIME type of the file (e.g., image/jpeg, video/mp4)
+   * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
    */
   content_type: string | null;
 
   /**
-   * The name of the file
+   * The original filename of the uploaded file, including its file extension.
    */
   filename: string | null;
 
   /**
-   * The size of the file in bytes
+   * The file size in bytes. Null if the file has not finished uploading.
    */
   size: string | null;
 
   /**
-   * Headers to include in the upload request (only on create)
+   * Headers to include in the upload request. Only present in the response from the
+   * create mutation.
    */
   upload_headers: { [key: string]: unknown } | null;
 
   /**
-   * The upload status of the file
+   * The current upload status of the file (e.g., pending, ready).
    */
   upload_status: UploadStatus;
 
   /**
-   * The presigned URL to upload the file to (only on create)
+   * The presigned URL to upload the file contents to. Only present in the response
+   * from the create mutation.
    */
   upload_url: string | null;
 
   /**
-   * The URL to access the file
+   * The CDN URL for accessing the file. Null if the file has not finished uploading.
    */
   url: string | null;
 }
 
 /**
- * A file that has been uploaded or is pending upload
+ * A file that has been uploaded or is pending upload.
  */
 export interface FileRetrieveResponse {
   /**
@@ -96,34 +99,35 @@ export interface FileRetrieveResponse {
   id: string;
 
   /**
-   * The MIME type of the file (e.g., image/jpeg, video/mp4)
+   * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
    */
   content_type: string | null;
 
   /**
-   * The name of the file
+   * The original filename of the uploaded file, including its file extension.
    */
   filename: string | null;
 
   /**
-   * The size of the file in bytes
+   * The file size in bytes. Null if the file has not finished uploading.
    */
   size: string | null;
 
   /**
-   * The upload status of the file
+   * The current upload status of the file (e.g., pending, ready).
    */
   upload_status: UploadStatus;
 
   /**
-   * The URL to access the file
+   * The CDN URL for accessing the file. Null if the file has not finished uploading.
    */
   url: string | null;
 }
 
 export interface FileCreateParams {
   /**
-   * The filename of the file
+   * The name of the file including its extension (e.g., "photo.png" or
+   * "document.pdf").
    */
   filename: string;
 }