@whop/sdk 0.0.3 → 0.0.5

package/src/resources/course-students.ts

@@ -0,0 +1,238 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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';
+
+export class CourseStudents extends APIResource {
+  /**
+   * Retrieves a course student by interaction ID
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   * - `course_analytics:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CourseStudentRetrieveResponse> {
+    return this._client.get(path`/course_students/${id}`, options);
+  }
+
+  /**
+   * Lists students for a course
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   * - `course_analytics:read`
+   */
+  list(
+    query: CourseStudentListParams,
+    options?: RequestOptions,
+  ): PagePromise<CourseStudentListResponsesCursorPage, CourseStudentListResponse> {
+    return this._client.getAPIList('/course_students', CursorPage<CourseStudentListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListResponse>;
+
+/**
+ * A course student (enrollment of a student in a course)
+ */
+export interface CourseStudentRetrieveResponse {
+  /**
+   * The ID of the course student. Looks like crsi_XXX
+   */
+  id: string;
+
+  /**
+   * The number of lessons the student has completed
+   */
+  completed_lessons_count: number;
+
+  /**
+   * The percentage of lessons completed (0-100)
+   */
+  completion_rate: number;
+
+  /**
+   * The course the student is enrolled in
+   */
+  course: CourseStudentRetrieveResponse.Course;
+
+  /**
+   * When the student first interacted with the course
+   */
+  first_interaction_at: string;
+
+  /**
+   * When the student last interacted with the course
+   */
+  last_interaction_at: string;
+
+  /**
+   * The total number of lessons the student has access to
+   */
+  total_lessons_count: number;
+
+  /**
+   * The user who is enrolled in the course
+   */
+  user: CourseStudentRetrieveResponse.User;
+}
+
+export namespace CourseStudentRetrieveResponse {
+  /**
+   * The course the student is enrolled in
+   */
+  export interface Course {
+    /**
+     * The ID of the course. Looks like cors_XXX
+     */
+    id: string;
+
+    /**
+     * The experience that the course belongs to
+     */
+    experience: Course.Experience;
+
+    /**
+     * The title of the course
+     */
+    title: string | null;
+  }
+
+  export namespace Course {
+    /**
+     * The experience that the course belongs to
+     */
+    export interface Experience {
+      /**
+       * The unique ID representing this experience
+       */
+      id: string;
+    }
+  }
+
+  /**
+   * The user who is enrolled in the course
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+/**
+ * A course student (enrollment of a student in a course)
+ */
+export interface CourseStudentListResponse {
+  /**
+   * The ID of the course student. Looks like crsi_XXX
+   */
+  id: string;
+
+  /**
+   * The number of lessons the student has completed
+   */
+  completed_lessons_count: number;
+
+  /**
+   * The percentage of lessons completed (0-100)
+   */
+  completion_rate: number;
+
+  /**
+   * When the student first interacted with the course
+   */
+  first_interaction_at: string;
+
+  /**
+   * When the student last interacted with the course
+   */
+  last_interaction_at: string;
+
+  /**
+   * The total number of lessons the student has access to
+   */
+  total_lessons_count: number;
+
+  /**
+   * The user who is enrolled in the course
+   */
+  user: CourseStudentListResponse.User;
+}
+
+export namespace CourseStudentListResponse {
+  /**
+   * The user who is enrolled in the course
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+export interface CourseStudentListParams extends CursorPageParams {
+  /**
+   * The ID of the course
+   */
+  course_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Filter students by name - returns students whose names match the keyword
+   */
+  keyword?: string | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+}
+
+export declare namespace CourseStudents {
+  export {
+    type CourseStudentRetrieveResponse as CourseStudentRetrieveResponse,
+    type CourseStudentListResponse as CourseStudentListResponse,
+    type CourseStudentListResponsesCursorPage as CourseStudentListResponsesCursorPage,
+    type CourseStudentListParams as CourseStudentListParams,
+  };
+}

package/src/resources/courses.ts

@@ -146,6 +146,11 @@ export interface Course {
    */
   language: Languages;
 
+  /**
+   * The order of the course within its experience
+   */
+  order: string;
+
   /**
    * Whether the course requires students to complete the previous lesson before
    * moving on to the next one
@@ -171,6 +176,12 @@ export interface Course {
    * The timestamp of when the course was last updated
    */
   updated_at: string;
+
+  /**
+   * The visibility of the course. Determines how / whether this course is visible to
+   * users.
+   */
+  visibility: CourseVisibilities;
 }
 
 export namespace Course {
@@ -259,6 +270,12 @@ export namespace Course {
   }
 }
 
+/**
+ * The available visibilities for a course. Determines how / whether a course is
+ * visible to users.
+ */
+export type CourseVisibilities = 'visible' | 'hidden';
+
 /**
  * The available languages for a course
  */
@@ -317,6 +334,11 @@ export interface CourseListResponse {
    */
   language: Languages;
 
+  /**
+   * The order of the course within its experience
+   */
+  order: string;
+
   /**
    * Whether the course requires students to complete the previous lesson before
    * moving on to the next one
@@ -342,6 +364,12 @@ export interface CourseListResponse {
    * The timestamp of when the course was last updated
    */
   updated_at: string;
+
+  /**
+   * The visibility of the course. Determines how / whether this course is visible to
+   * users.
+   */
+  visibility: CourseVisibilities;
 }
 
 export namespace CourseListResponse {
@@ -394,11 +422,30 @@ export interface CourseCreateParams {
    */
   title: string;
 
+  /**
+   * Whether the course will award its students a PDF certificate after completing
+   * all lessons
+   */
+  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)
+   * to place between existing courses.
+   */
+  order?: string | null;
+
+  /**
+   * Whether the course requires students to complete the previous lesson before
+   * moving on to the next one
+   */
+  require_completing_lessons_in_order?: boolean | null;
+
   /**
    * The tagline of the course
    */
@@ -407,27 +454,41 @@ export interface CourseCreateParams {
   /**
    * The thumbnail for the course in png, jpeg, or gif format
    */
-  thumbnail?: CourseCreateParams.Thumbnail | null;
+  thumbnail?:
+    | CourseCreateParams.AttachmentInputWithDirectUploadID
+    | CourseCreateParams.AttachmentInputWithID
+    | null;
+
+  /**
+   * The available visibilities for a course. Determines how / whether a course is
+   * visible to users.
+   */
+  visibility?: CourseVisibilities | null;
 }
 
 export namespace CourseCreateParams {
   /**
-   * The thumbnail for the course in png, jpeg, or gif format
+   * Input for an attachment
    */
-  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.
-     */
-    id?: string | null;
-
+  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 | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * 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.
+     */
+    id: string;
   }
 }
 
@@ -458,6 +519,12 @@ export interface CourseUpdateParams {
    */
   language?: Languages | null;
 
+  /**
+   * The decimal order position of the course within its experience. Use fractional
+   * values (e.g., 1.5) to place between existing courses.
+   */
+  order?: string | null;
+
   /**
    * Whether the course requires students to complete the previous lesson before
    * moving on to the next one
@@ -472,12 +539,21 @@ export interface CourseUpdateParams {
   /**
    * The thumbnail for the course in png, jpeg, or gif format
    */
-  thumbnail?: CourseUpdateParams.Thumbnail | null;
+  thumbnail?:
+    | CourseUpdateParams.AttachmentInputWithDirectUploadID
+    | CourseUpdateParams.AttachmentInputWithID
+    | null;
 
   /**
    * The title of the course
    */
   title?: string | null;
+
+  /**
+   * The available visibilities for a course. Determines how / whether a course is
+   * visible to users.
+   */
+  visibility?: CourseVisibilities | null;
 }
 
 export namespace CourseUpdateParams {
@@ -534,22 +610,27 @@ export namespace CourseUpdateParams {
   }
 
   /**
-   * The thumbnail for the course in png, jpeg, or gif format
+   * Input for an attachment
    */
-  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.
-     */
-    id?: string | null;
-
+  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 | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * 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.
+     */
+    id: string;
   }
 }
 
@@ -583,6 +664,7 @@ export interface CourseListParams extends CursorPageParams {
 export declare namespace Courses {
   export {
     type Course as Course,
+    type CourseVisibilities as CourseVisibilities,
     type Languages as Languages,
     type CourseListResponse as CourseListResponse,
     type CourseDeleteResponse as CourseDeleteResponse,

package/src/resources/entries.ts

@@ -82,7 +82,7 @@ export interface EntryListResponse {
   plan: EntryListResponse.Plan | null;
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   product: EntryListResponse.Product | null;
 
@@ -109,7 +109,7 @@ export namespace EntryListResponse {
   }
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   export interface Product {
     /**

package/src/resources/experiences.ts

@@ -313,7 +313,10 @@ export interface ExperienceUpdateParams {
   /**
    * The logo for the experience
    */
-  logo?: ExperienceUpdateParams.Logo | null;
+  logo?:
+    | ExperienceUpdateParams.AttachmentInputWithDirectUploadID
+    | ExperienceUpdateParams.AttachmentInputWithID
+    | null;
 
   /**
    * The name of the experience.
@@ -333,22 +336,27 @@ export interface ExperienceUpdateParams {
 
 export namespace ExperienceUpdateParams {
   /**
-   * The logo for the experience
+   * Input for an attachment
    */
-  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.
-     */
-    id?: string | null;
-
+  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 | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * 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.
+     */
+    id: string;
   }
 }
 

package/src/resources/forum-posts.ts

@@ -90,7 +90,7 @@ export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>
  */
 export interface ForumPostListResponse {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -186,7 +186,9 @@ export interface ForumPostCreateParams {
   /**
    * The attachments for this post
    */
-  attachments?: Array<ForumPostCreateParams.Attachment> | null;
+  attachments?: Array<
+    ForumPostCreateParams.AttachmentInputWithDirectUploadID | ForumPostCreateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * This is the main body of the post in Markdown format. Hidden if paywalled and
@@ -238,20 +240,25 @@ export namespace ForumPostCreateParams {
   /**
    * Input for an attachment
    */
-  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.
-     */
-    id?: string | null;
-
+  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 | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * 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.
+     */
+    id: string;
   }
 
   /**
@@ -286,7 +293,9 @@ export interface ForumPostUpdateParams {
   /**
    * The attachments for this post
    */
-  attachments?: Array<ForumPostUpdateParams.Attachment> | null;
+  attachments?: Array<
+    ForumPostUpdateParams.AttachmentInputWithDirectUploadID | ForumPostUpdateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * This is the main body of the post in Markdown format. Hidden if paywalled and
@@ -309,20 +318,25 @@ export namespace ForumPostUpdateParams {
   /**
    * Input for an attachment
    */
-  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.
-     */
-    id?: string | null;
-
+  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 | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * 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.
+     */
+    id: string;
   }
 }
 

package/src/resources/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export { AccessTokens, type AccessTokenCreateResponse, type AccessTokenCreateParams } from './access-tokens';
 export {
   AppBuilds,
   type AppBuildListResponse,
@@ -37,7 +38,13 @@ export {
   type CheckoutConfigurationListParams,
   type CheckoutConfigurationListResponsesCursorPage,
 } from './checkout-configurations';
-export { Companies } from './companies';
+export {
+  Companies,
+  type CompanyListResponse,
+  type CompanyCreateParams,
+  type CompanyListParams,
+  type CompanyListResponsesCursorPage,
+} from './companies';
 export {
   CourseChapters,
   type CourseChapter,
@@ -55,6 +62,7 @@ export {
 export {
   CourseLessons,
   type AssessmentQuestionTypes,
+  type EmbedType,
   type Lesson,
   type LessonTypes,
   type LessonVisibilities,
@@ -65,9 +73,17 @@ export {
   type CourseLessonListParams,
   type CourseLessonListResponsesCursorPage,
 } from './course-lessons';
+export {
+  CourseStudents,
+  type CourseStudentRetrieveResponse,
+  type CourseStudentListResponse,
+  type CourseStudentListParams,
+  type CourseStudentListResponsesCursorPage,
+} from './course-students';
 export {
   Courses,
   type Course,
+  type CourseVisibilities,
   type Languages,
   type CourseListResponse,
   type CourseDeleteResponse,
@@ -112,7 +128,6 @@ export {
 } from './forums';
 export {
   Invoices,
-  type InvoiceCreateResponse,
   type InvoiceVoidResponse,
   type InvoiceCreateParams,
   type InvoiceListParams,