@whop/sdk 0.0.22 → 0.0.24

package/src/lib/upload-file.ts

@@ -0,0 +1,115 @@
+import type { Fetch } from '../internal/builtin-types';
+import type { RequestOptions } from '../internal/request-options';
+import { getDefaultFetch } from '../internal/shims';
+import { sleep } from '../internal/utils/sleep';
+import { toFile, type ToFileInput, type Uploadable } from '../core/uploads';
+import type { Whop } from '../client';
+import type { FileCreateResponse, FileRetrieveResponse } from '../resources/files';
+
+export interface UploadFileOptions {
+  /**
+   * Override the filename used when creating the file.
+   * If omitted, we'll use the name inferred by `toFile()`.
+   */
+  filename?: string | null | undefined;
+
+  /**
+   * How often to poll `files.retrieve()` for status updates.
+   *
+   * @default 1000
+   * @unit milliseconds
+   */
+  pollIntervalMs?: number | null | undefined;
+
+  /**
+   * Maximum time to wait for the file to reach `ready` after uploading.
+   *
+   * @default 120000
+   * @unit milliseconds
+   */
+  pollTimeoutMs?: number | null | undefined;
+
+  /**
+   * Request options used for the `files.create()` and `files.retrieve()` API calls.
+   */
+  requestOptions?: RequestOptions | null | undefined;
+}
+
+function normalizeUploadHeaders(
+  headers: FileCreateResponse['upload_headers'],
+): Record<string, string> | undefined {
+  if (!headers) return undefined;
+  const out: Record<string, string> = {};
+  for (const [key, value] of Object.entries(headers)) {
+    if (value === null || value === undefined) continue;
+    out[key] = String(value);
+  }
+  return out;
+}
+
+/**
+ * Upload a file using the `files.create()` and `files.retrieve()` APIs.
+ *
+ * Flow:
+ * - create a file record (returns presigned upload URL + headers)
+ * - upload bytes to the presigned URL
+ * - poll retrieve until `ready` (or `failed` / timeout)
+ */
+export async function uploadFile(
+  client: Whop,
+  file: Uploadable | ToFileInput | PromiseLike<Uploadable | ToFileInput>,
+  options?: UploadFileOptions,
+): Promise<FileRetrieveResponse> {
+  const pollIntervalMs = options?.pollIntervalMs ?? 1000;
+  const pollTimeoutMs = options?.pollTimeoutMs ?? 120_000;
+  const requestOptions = options?.requestOptions ?? undefined;
+
+  const normalized = await toFile(file as any, options?.filename ?? undefined);
+  const filename = (options?.filename ?? normalized.name)?.trim();
+  if (!filename) {
+    throw new Error('uploadFile: could not determine a filename; pass { filename } or provide a named File.');
+  }
+
+  const created = await client.files.create({ filename }, requestOptions);
+
+  if (created.upload_status === 'failed') {
+    throw new Error(`uploadFile: file creation failed (id: ${created.id}).`);
+  }
+
+  // Some backends may immediately mark the record ready (e.g. for remote/import flows).
+  if (created.upload_status !== 'ready') {
+    if (!created.upload_url) {
+      throw new Error('uploadFile: missing upload_url from files.create response.');
+    }
+
+    const fetchImpl: Fetch = ((client as any).fetch as Fetch | undefined) ?? getDefaultFetch();
+
+    const uploadResponse = await fetchImpl(created.upload_url, {
+      method: 'PUT',
+      headers: normalizeUploadHeaders(created.upload_headers) ?? {},
+      body: normalized,
+    });
+
+    if (!uploadResponse.ok) {
+      throw new Error(
+        `uploadFile: upload failed (status ${uploadResponse.status} ${uploadResponse.statusText}).`,
+      );
+    }
+  }
+
+  const deadline = Date.now() + pollTimeoutMs;
+  while (true) {
+    const current = await client.files.retrieve(created.id, requestOptions);
+
+    if (current.upload_status === 'ready') return current;
+    if (current.upload_status === 'failed') {
+      throw new Error(`uploadFile: processing failed (id: ${current.id}).`);
+    }
+
+    if (Date.now() >= deadline) {
+      throw new Error(`uploadFile: timed out waiting for file to become ready (id: ${current.id}).`);
+    }
+
+    await sleep(pollIntervalMs);
+  }
+}

package/src/resources/app-builds.ts

@@ -18,7 +18,7 @@ export class AppBuilds extends APIResource {
    * @example
    * ```ts
    * const appBuild = await client.appBuilds.create({
-   *   attachment: { direct_upload_id: 'direct_upload_id' },
+   *   attachment: { id: 'id' },
    *   checksum: 'checksum',
    *   platform: 'ios',
    * });
@@ -150,9 +150,7 @@ export interface AppBuildCreateParams {
    * format. The zip should contain at least one main_js_bundle.hbc file and
    * optionally an assets folder next to it.
    */
-  attachment:
-    | AppBuildCreateParams.AttachmentInputWithDirectUploadID
-    | AppBuildCreateParams.AttachmentInputWithID;
+  attachment: AppBuildCreateParams.Attachment;
 
   /**
    * Checksum of the app build file. This is generated by the client and used to
@@ -186,25 +184,13 @@ export interface AppBuildCreateParams {
 
 export namespace AppBuildCreateParams {
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * Attachment input for the app build file. This should be an upload in .zip
+   * format. The zip should contain at least one main_js_bundle.hbc file and
+   * optionally an assets folder next to it.
    */
-  export interface AttachmentInputWithID {
+  export interface Attachment {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }

package/src/resources/apps.ts

@@ -243,6 +243,23 @@ export interface AppCreateParams {
    * The base URL of the app to be created
    */
   base_url?: string | null;
+
+  /**
+   * The icon for the app in png, jpeg, or gif format
+   */
+  icon?: AppCreateParams.Icon | null;
+}
+
+export namespace AppCreateParams {
+  /**
+   * The icon for the app in png, jpeg, or gif format
+   */
+  export interface Icon {
+    /**
+     * The ID of an existing file object.
+     */
+    id: string;
+  }
 }
 
 export interface AppUpdateParams {
@@ -284,7 +301,7 @@ export interface AppUpdateParams {
   /**
    * The icon for the app
    */
-  icon?: AppUpdateParams.AttachmentInputWithDirectUploadID | AppUpdateParams.AttachmentInputWithID | null;
+  icon?: AppUpdateParams.Icon | null;
 
   /**
    * The name of the app
@@ -304,25 +321,11 @@ export interface AppUpdateParams {
 
 export namespace AppUpdateParams {
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The icon for the app
    */
-  export interface AttachmentInputWithID {
+  export interface Icon {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }

package/src/resources/checkout-configurations.ts

@@ -311,7 +311,7 @@ export declare namespace CheckoutConfigurationCreateParams {
       /**
        * An image for the plan. This will be visible on the product page to customers.
        */
-      image?: Plan.AttachmentInputWithDirectUploadID | Plan.AttachmentInputWithID | null;
+      image?: Plan.Image | null;
 
       /**
        * An additional amount charged upon first purchase.
@@ -366,6 +366,11 @@ export declare namespace CheckoutConfigurationCreateParams {
        */
       split_pay_required_payments?: number | null;
 
+      /**
+       * The number of units available for purchase. If not provided, stock is unlimited.
+       */
+      stock?: number | null;
+
       /**
        * The title of the plan. This will be visible on the product page to customers.
        */
@@ -416,25 +421,11 @@ export declare namespace CheckoutConfigurationCreateParams {
       }
 
       /**
-       * Input for an attachment
-       */
-      export interface AttachmentInputWithDirectUploadID {
-        /**
-         * This ID should be used the first time you upload an attachment. It is the ID of
-         * the direct upload that was created when uploading the file to S3 via the
-         * mediaDirectUpload mutation.
-         */
-        direct_upload_id: string;
-      }
-
-      /**
-       * Input for an attachment
+       * An image for the plan. This will be visible on the product page to customers.
        */
-      export interface AttachmentInputWithID {
+      export interface Image {
         /**
-         * The ID of an existing attachment object. Use this when updating a resource and
-         * keeping a subset of the attachments. Don't use this unless you know what you're
-         * doing.
+         * The ID of an existing file object.
          */
         id: string;
       }

package/src/resources/companies.ts

@@ -205,6 +205,11 @@ export interface CompanyCreateParams {
    */
   industry_type?: Shared.IndustryTypes | null;
 
+  /**
+   * The logo for the company in png, jpeg, or gif format
+   */
+  logo?: CompanyCreateParams.Logo | null;
+
   /**
    * Additional metadata for the account
    */
@@ -219,14 +224,23 @@ export interface CompanyCreateParams {
   send_customer_emails?: boolean | null;
 }
 
+export namespace CompanyCreateParams {
+  /**
+   * The logo for the company in png, jpeg, or gif format
+   */
+  export interface Logo {
+    /**
+     * The ID of an existing file object.
+     */
+    id: string;
+  }
+}
+
 export interface CompanyUpdateParams {
   /**
    * The banner image for the company in png or jpeg format
    */
-  banner_image?:
-    | CompanyUpdateParams.AttachmentInputWithDirectUploadID
-    | CompanyUpdateParams.AttachmentInputWithID
-    | null;
+  banner_image?: CompanyUpdateParams.BannerImage | null;
 
   /**
    * The different business types a company can be.
@@ -241,10 +255,7 @@ export interface CompanyUpdateParams {
   /**
    * The logo for the company in png, jpeg, or gif format
    */
-  logo?:
-    | CompanyUpdateParams.AttachmentInputWithDirectUploadID
-    | CompanyUpdateParams.AttachmentInputWithID
-    | null;
+  logo?: CompanyUpdateParams.Logo | null;
 
   /**
    * Whether Whop sends transactional emails to customers on behalf of this company.
@@ -262,49 +273,21 @@ export interface CompanyUpdateParams {
 
 export namespace CompanyUpdateParams {
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The banner image for the company in png or jpeg format
    */
-  export interface AttachmentInputWithID {
+  export interface BannerImage {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }
 
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The logo for the company in png, jpeg, or gif format
    */
-  export interface AttachmentInputWithID {
+  export interface Logo {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }

package/src/resources/course-lessons.ts

@@ -720,10 +720,7 @@ export interface CourseLessonCreateParams {
   /**
    * The thumbnail for the lesson in png, jpeg, or gif format
    */
-  thumbnail?:
-    | CourseLessonCreateParams.AttachmentInputWithDirectUploadID
-    | CourseLessonCreateParams.AttachmentInputWithID
-    | null;
+  thumbnail?: CourseLessonCreateParams.Thumbnail | null;
 
   /**
    * The title of the lesson
@@ -733,25 +730,11 @@ export interface CourseLessonCreateParams {
 
 export namespace CourseLessonCreateParams {
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The thumbnail for the lesson in png, jpeg, or gif format
    */
-  export interface AttachmentInputWithID {
+  export interface Thumbnail {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }
@@ -773,10 +756,7 @@ export interface CourseLessonUpdateParams {
    * General attachments for the lesson (PDFs, files, etc). Replaces all existing
    * attachments.
    */
-  attachments?: Array<
-    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
-    | CourseLessonUpdateParams.AttachmentInputWithID
-  > | null;
+  attachments?: Array<CourseLessonUpdateParams.Attachment> | null;
 
   /**
    * The content of the lesson
@@ -806,10 +786,7 @@ export interface CourseLessonUpdateParams {
   /**
    * The main PDF file for this lesson
    */
-  main_pdf?:
-    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
-    | CourseLessonUpdateParams.AttachmentInputWithID
-    | null;
+  main_pdf?: CourseLessonUpdateParams.MainPdf | null;
 
   /**
    * Maximum number of attempts allowed for assessments
@@ -824,10 +801,7 @@ export interface CourseLessonUpdateParams {
   /**
    * The thumbnail for the lesson in png, jpeg, or gif format
    */
-  thumbnail?:
-    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
-    | CourseLessonUpdateParams.AttachmentInputWithID
-    | null;
+  thumbnail?: CourseLessonUpdateParams.Thumbnail | null;
 
   /**
    * The title of the lesson
@@ -887,10 +861,7 @@ export namespace CourseLessonUpdateParams {
     /**
      * Optional image attachment for the question
      */
-    image?:
-      | AssessmentQuestion.AttachmentInputWithDirectUploadID
-      | AssessmentQuestion.AttachmentInputWithID
-      | null;
+    image?: AssessmentQuestion.Image | null;
 
     /**
      * The answer options for multiple choice/select questions
@@ -900,25 +871,11 @@ export namespace CourseLessonUpdateParams {
 
   export namespace AssessmentQuestion {
     /**
-     * Input for an attachment
-     */
-    export interface AttachmentInputWithDirectUploadID {
-      /**
-       * This ID should be used the first time you upload an attachment. It is the ID of
-       * the direct upload that was created when uploading the file to S3 via the
-       * mediaDirectUpload mutation.
-       */
-      direct_upload_id: string;
-    }
-
-    /**
-     * Input for an attachment
+     * Optional image attachment for the question
      */
-    export interface AttachmentInputWithID {
+    export interface Image {
       /**
-       * The ID of an existing attachment object. Use this when updating a resource and
-       * keeping a subset of the attachments. Don't use this unless you know what you're
-       * doing.
+       * The ID of an existing file object.
        */
       id: string;
     }
@@ -948,71 +905,29 @@ export namespace CourseLessonUpdateParams {
   /**
    * Input for an attachment
    */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithID {
+  export interface Attachment {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }
 
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The main PDF file for this lesson
    */
-  export interface AttachmentInputWithID {
+  export interface MainPdf {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }
 
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The thumbnail for the lesson in png, jpeg, or gif format
    */
-  export interface AttachmentInputWithID {
+  export interface Thumbnail {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }

package/src/resources/courses.ts

@@ -481,11 +481,6 @@ export interface CourseCreateParams {
    */
   certificate_after_completion_enabled?: boolean | null;
 
-  /**
-   * The cover image URL of the course
-   */
-  cover_image?: string | null;
-
   /**
    * The decimal order position of the course within its experience. If not provided,
    * it will be set to the next sequential order. Use fractional values (e.g., 1.5)
@@ -507,10 +502,7 @@ export interface CourseCreateParams {
   /**
    * The thumbnail for the course in png, jpeg, or gif format
    */
-  thumbnail?:
-    | CourseCreateParams.AttachmentInputWithDirectUploadID
-    | CourseCreateParams.AttachmentInputWithID
-    | null;
+  thumbnail?: CourseCreateParams.Thumbnail | null;
 
   /**
    * The available visibilities for a course. Determines how / whether a course is
@@ -521,25 +513,11 @@ export interface CourseCreateParams {
 
 export namespace CourseCreateParams {
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The thumbnail for the course in png, jpeg, or gif format
    */
-  export interface AttachmentInputWithID {
+  export interface Thumbnail {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }
@@ -557,11 +535,6 @@ export interface CourseUpdateParams {
    */
   chapters?: Array<CourseUpdateParams.Chapter> | null;
 
-  /**
-   * The cover image URL of the course
-   */
-  cover_image?: string | null;
-
   /**
    * A short description of the course
    */
@@ -592,10 +565,7 @@ export interface CourseUpdateParams {
   /**
    * The thumbnail for the course in png, jpeg, or gif format
    */
-  thumbnail?:
-    | CourseUpdateParams.AttachmentInputWithDirectUploadID
-    | CourseUpdateParams.AttachmentInputWithID
-    | null;
+  thumbnail?: CourseUpdateParams.Thumbnail | null;
 
   /**
    * The title of the course
@@ -663,25 +633,11 @@ export namespace CourseUpdateParams {
   }
 
   /**
-   * Input for an attachment
-   */
-  export interface AttachmentInputWithDirectUploadID {
-    /**
-     * This ID should be used the first time you upload an attachment. It is the ID of
-     * the direct upload that was created when uploading the file to S3 via the
-     * mediaDirectUpload mutation.
-     */
-    direct_upload_id: string;
-  }
-
-  /**
-   * Input for an attachment
+   * The thumbnail for the course in png, jpeg, or gif format
    */
-  export interface AttachmentInputWithID {
+  export interface Thumbnail {
     /**
-     * The ID of an existing attachment object. Use this when updating a resource and
-     * keeping a subset of the attachments. Don't use this unless you know what you're
-     * doing.
+     * The ID of an existing file object.
      */
     id: string;
   }