@whop/sdk 0.0.4 → 0.0.5

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,

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;
 

package/src/resources/payments.ts

@@ -364,7 +364,7 @@ export interface PaymentListResponse {
   plan: PaymentListResponse.Plan | null;
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   product: PaymentListResponse.Product | null;
 
@@ -535,7 +535,7 @@ export namespace PaymentListResponse {
   }
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   export interface Product {
     /**

package/src/resources/plans.ts

@@ -118,7 +118,9 @@ export class Plans extends APIResource {
 export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
 
 /**
- * An object representing a (sanitized) plan of an access pass.
+ * A plan for an product. Plans define the core parameters that define a checkout
+ * and payment on whop. Use plans to create different ways to price your products
+ * (Eg renewal / one_time)
  */
 export interface PlanListResponse {
   /**
@@ -187,7 +189,7 @@ export interface PlanListResponse {
   plan_type: Shared.PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: PlanListResponse.Product | null;
 
@@ -290,7 +292,7 @@ export namespace PlanListResponse {
   }
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   export interface Product {
     /**
@@ -376,7 +378,7 @@ export interface PlanCreateParams {
   payment_method_configuration?: PlanCreateParams.PaymentMethodConfiguration | 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;
 

package/src/resources/products.ts

@@ -172,7 +172,7 @@ export interface ProductCreateParams {
   global_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -192,7 +192,7 @@ export interface ProductCreateParams {
   member_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -253,7 +253,7 @@ export namespace ProductCreateParams {
     initial_price?: number | 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;
 
@@ -376,7 +376,7 @@ export interface ProductUpdateParams {
   global_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -396,7 +396,7 @@ export interface ProductUpdateParams {
   member_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 

package/src/resources/promo-codes.ts

@@ -164,7 +164,7 @@ export interface PromoCode {
   one_per_customer: boolean;
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   product: PromoCode.Product | null;
 
@@ -216,7 +216,7 @@ export namespace PromoCode {
   }
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   export interface Product {
     /**
@@ -302,7 +302,7 @@ export interface PromoCodeListResponse {
   one_per_customer: boolean;
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   product: PromoCodeListResponse.Product | null;
 
@@ -339,7 +339,7 @@ export interface PromoCodeListResponse {
 
 export namespace PromoCodeListResponse {
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   export interface Product {
     /**

package/src/resources/shared.ts

@@ -5,12 +5,13 @@ import * as PaymentsAPI from './payments';
 import { CursorPage } from '../core/pagination';
 
 /**
- * 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.
  */
 export type AccessLevel = 'no_access' | 'admin' | 'customer';
 
 /**
- * The different types an access pass can be.
+ * The different types an product can be. Only use 'regular'. The rest are for
+ * internal use
  */
 export type AccessPassType = 'regular' | 'app' | 'experience_upsell' | 'api_only';
 
@@ -970,7 +971,7 @@ export interface Entry {
   plan: Entry.Plan | null;
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   product: Entry.Product | null;
 
@@ -1017,7 +1018,7 @@ export namespace Entry {
   }
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   export interface Product {
     /**
@@ -1102,10 +1103,9 @@ export interface Experience {
   order: string | null;
 
   /**
-   * The access passes that are associated with this experience. This should not be
-   * used unless you are trying to list all access passes the experience has, for
-   * some reason. You probably don't want to use this though and should be using
-   * accessPass.
+   * The products that this experience is attached to. This defines which set of
+   * customers have access and can view this experience. If empty, this experience is
+   * only visible to authorized users of the company
    */
   products: Array<Experience.Product>;
 }
@@ -1178,7 +1178,7 @@ export namespace Experience {
   }
 
   /**
-   * An object representing a (sanitized) access pass.
+   * Represents a product on whop. Use products to sell anything on the platform.
    */
   export interface Product {
     /**
@@ -1250,7 +1250,7 @@ export namespace Forum {
  */
 export interface ForumPost {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -1359,7 +1359,7 @@ export type FriendlyReceiptStatus =
   | 'canceled';
 
 /**
- * The different statuses of the global affiliate program for an access pass.
+ * The different statuses of the global affiliate program for a product.
  */
 export type GlobalAffiliateStatus = 'enabled' | 'disabled';
 
@@ -1852,7 +1852,7 @@ export type MembershipStatus =
  */
 export interface Message {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -2122,7 +2122,7 @@ export interface Payment {
   plan: Payment.Plan | null;
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   product: Payment.Product | null;
 
@@ -2293,7 +2293,7 @@ export namespace Payment {
   }
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   export interface Product {
     /**
@@ -2374,7 +2374,9 @@ export namespace Payment {
 }
 
 /**
- * An object representing a (sanitized) plan of an access pass.
+ * A plan for an product. Plans define the core parameters that define a checkout
+ * and payment on whop. Use plans to create different ways to price your products
+ * (Eg renewal / one_time)
  */
 export interface Plan {
   /**
@@ -2453,7 +2455,7 @@ export interface Plan {
   plan_type: PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: Plan.Product | null;
 
@@ -2596,7 +2598,7 @@ export namespace Plan {
   }
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   export interface Product {
     /**
@@ -2612,12 +2614,12 @@ export namespace Plan {
 }
 
 /**
- * The type of plan that can be attached to an access pass
+ * The type of plan that can be attached to a product
  */
 export type PlanType = 'renewal' | 'one_time';
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface Product {
   /**
@@ -2808,7 +2810,7 @@ export namespace Product {
 }
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface ProductListItem {
   /**

package/src/resources/users.ts

@@ -91,6 +91,9 @@ export interface UserCheckAccessResponse {
 }
 
 export interface UserCheckAccessParams {
+  /**
+   * The ID (user_xxx) or username of the user
+   */
   id: string;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.4'; // x-release-please-version
+export const VERSION = '0.0.5'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.4";
+export declare const VERSION = "0.0.5";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.4";
+export declare const VERSION = "0.0.5";
 //# sourceMappingURL=version.d.ts.map