@whop/sdk 0.0.4 → 0.0.6

package/src/resources/course-lessons.ts

@@ -118,6 +118,11 @@ export type CourseLessonListResponsesCursorPage = CursorPage<CourseLessonListRes
  */
 export type AssessmentQuestionTypes = 'short_answer' | 'true_false' | 'multiple_choice' | 'multiple_select';
 
+/**
+ * The type of embed for a lesson
+ */
+export type EmbedType = 'youtube' | 'loom';
+
 /**
  * A lesson from the courses app
  */
@@ -147,6 +152,16 @@ export interface Lesson {
    */
   days_from_course_start_until_unlock: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type: EmbedType | null;
+
   /**
    * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
    */
@@ -162,6 +177,11 @@ export interface Lesson {
    */
   order: number;
 
+  /**
+   * The thumbnail for the lesson
+   */
+  thumbnail: Lesson.Thumbnail | null;
+
   /**
    * The title of the lesson
    */
@@ -332,6 +352,17 @@ export namespace Lesson {
     url: string | null;
   }
 
+  /**
+   * The thumbnail for the lesson
+   */
+  export interface Thumbnail {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
   /**
    * The associated Mux asset for video lessons
    */
@@ -383,6 +414,16 @@ export interface CourseLessonListResponse {
    */
   days_from_course_start_until_unlock: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type: EmbedType | null;
+
   /**
    * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
    */
@@ -393,6 +434,11 @@ export interface CourseLessonListResponse {
    */
   order: number;
 
+  /**
+   * The thumbnail for the lesson
+   */
+  thumbnail: CourseLessonListResponse.Thumbnail | null;
+
   /**
    * The title of the lesson
    */
@@ -405,6 +451,19 @@ export interface CourseLessonListResponse {
   visibility: LessonVisibilities;
 }
 
+export namespace CourseLessonListResponse {
+  /**
+   * The thumbnail for the lesson
+   */
+  export interface Thumbnail {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+}
+
 /**
  * Represents `true` or `false` values.
  */
@@ -431,12 +490,56 @@ export interface CourseLessonCreateParams {
    */
   days_from_course_start_until_unlock?: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id?: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type?: EmbedType | null;
+
+  /**
+   * The thumbnail for the lesson in png, jpeg, or gif format
+   */
+  thumbnail?:
+    | CourseLessonCreateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonCreateParams.AttachmentInputWithID
+    | null;
+
   /**
    * The title of the lesson
    */
   title?: string | null;
 }
 
+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
+   */
+  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;
+  }
+}
+
 export interface CourseLessonUpdateParams {
   /**
    * Completion requirements for quiz/knowledge check lessons
@@ -468,6 +571,16 @@ export interface CourseLessonUpdateParams {
    */
   days_from_course_start_until_unlock?: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id?: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type?: EmbedType | null;
+
   /**
    * The available types for a lesson
    */
@@ -491,6 +604,14 @@ export interface CourseLessonUpdateParams {
    */
   mux_asset_id?: string | null;
 
+  /**
+   * The thumbnail for the lesson in png, jpeg, or gif format
+   */
+  thumbnail?:
+    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonUpdateParams.AttachmentInputWithID
+    | null;
+
   /**
    * The title of the lesson
    */
@@ -654,6 +775,30 @@ export namespace CourseLessonUpdateParams {
      */
     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
+   */
+  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;
+  }
 }
 
 export interface CourseLessonListParams extends CursorPageParams {
@@ -686,6 +831,7 @@ export interface CourseLessonListParams extends CursorPageParams {
 export declare namespace CourseLessons {
   export {
     type AssessmentQuestionTypes as AssessmentQuestionTypes,
+    type EmbedType as EmbedType,
     type Lesson as Lesson,
     type LessonTypes as LessonTypes,
     type LessonVisibilities as LessonVisibilities,

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 {
@@ -405,6 +433,13 @@ export interface CourseCreateParams {
    */
   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
@@ -423,6 +458,12 @@ export interface CourseCreateParams {
     | 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 {
@@ -478,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
@@ -501,6 +548,12 @@ export interface CourseUpdateParams {
    * 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 {
@@ -611,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/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;
 

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,
@@ -61,6 +62,7 @@ export {
 export {
   CourseLessons,
   type AssessmentQuestionTypes,
+  type EmbedType,
   type Lesson,
   type LessonTypes,
   type LessonVisibilities,
@@ -81,6 +83,7 @@ export {
 export {
   Courses,
   type Course,
+  type CourseVisibilities,
   type Languages,
   type CourseListResponse,
   type CourseDeleteResponse,
@@ -154,6 +157,11 @@ export {
   type MessageListParams,
   type MessageListResponsesCursorPage,
 } from './messages';
+export {
+  Notifications,
+  type NotificationCreateResponse,
+  type NotificationCreateParams,
+} from './notifications';
 export {
   Payments,
   type BillingReasons,

package/src/resources/invoices.ts

@@ -176,7 +176,7 @@ export declare namespace InvoiceCreateParams {
       internal_notes?: string | null;
 
       /**
-       * The type of plan that can be attached to an access pass
+       * The type of plan that can be attached to a product
        */
       plan_type?: Shared.PlanType | null;
 
@@ -354,7 +354,7 @@ export declare namespace InvoiceCreateParams {
       internal_notes?: string | null;
 
       /**
-       * The type of plan that can be attached to an access pass
+       * The type of plan that can be attached to a product
        */
       plan_type?: Shared.PlanType | null;
 
@@ -533,7 +533,7 @@ export declare namespace InvoiceCreateParams {
       internal_notes?: string | null;
 
       /**
-       * The type of plan that can be attached to an access pass
+       * The type of plan that can be attached to a product
        */
       plan_type?: Shared.PlanType | null;
 
@@ -695,7 +695,7 @@ export declare namespace InvoiceCreateParams {
       internal_notes?: string | null;
 
       /**
-       * The type of plan that can be attached to an access pass
+       * The type of plan that can be attached to a product
        */
       plan_type?: Shared.PlanType | null;
 
@@ -779,14 +779,14 @@ export interface InvoiceListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The direction of the sort.
+   * Filter invoices by their collection method
    */
-  direction?: Shared.Direction | null;
+  collection_methods?: Array<Shared.CollectionMethod> | null;
 
   /**
-   * The filters to apply to the invoices
+   * The direction of the sort.
    */
-  filters?: InvoiceListParams.Filters | null;
+  direction?: Shared.Direction | null;
 
   /**
    * Returns the first _n_ elements from the list.
@@ -802,28 +802,16 @@ export interface InvoiceListParams extends CursorPageParams {
    * Which columns can be used to sort.
    */
   order?: 'id' | 'created_at' | 'due_date' | null;
-}
 
-export namespace InvoiceListParams {
   /**
-   * The filters to apply to the invoices
+   * Return only invoices created for these specific product ids
    */
-  export interface Filters {
-    /**
-     * The access pass IDs to filter the invoices by
-     */
-    access_pass_ids?: Array<string> | null;
+  product_ids?: Array<string> | null;
 
-    /**
-     * The collection methods to filter the invoices by
-     */
-    collection_methods?: Array<Shared.CollectionMethod> | null;
-
-    /**
-     * The statuses to filter the invoices by
-     */
-    statuses?: Array<Shared.InvoiceStatus> | null;
-  }
+  /**
+   * The statuses to filter the invoices by
+   */
+  statuses?: Array<Shared.InvoiceStatus> | null;
 }
 
 export declare namespace Invoices {

package/src/resources/ledger-accounts.ts

@@ -8,7 +8,7 @@ import { path } from '../internal/utils/path';
 
 export class LedgerAccounts extends APIResource {
   /**
-   * Retrieves a ledger account by ID
+   * Retrieves a ledger account by its ID, company ID or user ID
    *
    * Required permissions:
    *

package/src/resources/members.ts

@@ -53,9 +53,9 @@ export interface MemberRetrieveResponse {
 
   /**
    * The access level of the product member. If its admin, the member is an
-   * authorized user of the access pass. If its customer, the member has a valid
-   * membership to the access pass. If its no_access, the member does not have access
-   * to the access pass.
+   * authorized user of the company. If its customer, the member has a valid
+   * membership to any product on the company. If its no_access, the member does not
+   * have access to the product.
    */
   access_level: Shared.AccessLevel;
 
@@ -170,9 +170,9 @@ export interface MemberListResponse {
 
   /**
    * The access level of the product member. If its admin, the member is an
-   * authorized user of the access pass. If its customer, the member has a valid
-   * membership to the access pass. If its no_access, the member does not have access
-   * to the access pass.
+   * authorized user of the company. If its customer, the member has a valid
+   * membership to any product on the company. If its no_access, the member does not
+   * have access to the product.
    */
   access_level: Shared.AccessLevel;
 
@@ -256,15 +256,10 @@ export interface MemberListParams extends CursorPageParams {
   company_id: string;
 
   /**
-   * The access level a given user (or company) has to an access pass or company.
+   * The access level a given user (or company) has to a product or company.
    */
   access_level?: Shared.AccessLevel | null;
 
-  /**
-   * The access pass IDs to filter the members by
-   */
-  access_pass_ids?: Array<string> | null;
-
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -310,6 +305,11 @@ export interface MemberListParams extends CursorPageParams {
    */
   plan_ids?: Array<string> | null;
 
+  /**
+   * The product IDs to filter the members by
+   */
+  product_ids?: Array<string> | null;
+
   /**
    * The promo code IDs to filter the members by
    */

package/src/resources/memberships.ts

@@ -297,11 +297,6 @@ export interface MembershipUpdateParams {
 }
 
 export interface MembershipListParams extends CursorPageParams {
-  /**
-   * The access pass IDs to filter the memberships by
-   */
-  access_pass_ids?: Array<string> | null;
-
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -360,6 +355,11 @@ export interface MembershipListParams extends CursorPageParams {
    */
   plan_ids?: Array<string> | null;
 
+  /**
+   * The product IDs to filter the memberships by
+   */
+  product_ids?: Array<string> | null;
+
   /**
    * The promo code IDs to filter the memberships by
    */

package/src/resources/messages.ts

@@ -63,7 +63,7 @@ export type MessageListResponsesCursorPage = CursorPage<MessageListResponse>;
  */
 export interface MessageListResponse {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;