@whop/sdk 0.0.1-canary.0 → 0.0.3

package/src/client.ts

@@ -56,10 +56,44 @@ import {
   CheckoutConfigurations,
 } from './resources/checkout-configurations';
 import { Companies } from './resources/companies';
+import {
+  CourseChapter,
+  CourseChapterCreateParams,
+  CourseChapterDeleteResponse,
+  CourseChapterListParams,
+  CourseChapterListResponse,
+  CourseChapterListResponsesCursorPage,
+  CourseChapterUpdateParams,
+  CourseChapters,
+} from './resources/course-chapters';
 import {
   CourseLessonInteractionListParams,
   CourseLessonInteractions,
 } from './resources/course-lesson-interactions';
+import {
+  AssessmentQuestionTypes,
+  CourseLessonCreateParams,
+  CourseLessonDeleteResponse,
+  CourseLessonListParams,
+  CourseLessonListResponse,
+  CourseLessonListResponsesCursorPage,
+  CourseLessonUpdateParams,
+  CourseLessons,
+  Lesson,
+  LessonTypes,
+  LessonVisibilities,
+} from './resources/course-lessons';
+import {
+  Course,
+  CourseCreateParams,
+  CourseDeleteResponse,
+  CourseListParams,
+  CourseListResponse,
+  CourseListResponsesCursorPage,
+  CourseUpdateParams,
+  Courses,
+  Languages,
+} from './resources/courses';
 import {
   Entries,
   EntryApproveResponse,
@@ -72,6 +106,7 @@ import {
   ExperienceCreateParams,
   ExperienceDeleteResponse,
   ExperienceDetachParams,
+  ExperienceDuplicateParams,
   ExperienceListParams,
   ExperienceListResponse,
   ExperienceListResponsesCursorPage,
@@ -83,8 +118,16 @@ import {
   ForumPostListParams,
   ForumPostListResponse,
   ForumPostListResponsesCursorPage,
+  ForumPostUpdateParams,
   ForumPosts,
 } from './resources/forum-posts';
+import {
+  ForumListParams,
+  ForumListResponse,
+  ForumListResponsesCursorPage,
+  ForumUpdateParams,
+  Forums,
+} from './resources/forums';
 import {
   InvoiceCreateParams,
   InvoiceCreateResponse,
@@ -93,6 +136,13 @@ import {
   Invoices,
 } from './resources/invoices';
 import { LedgerAccountRetrieveResponse, LedgerAccounts } from './resources/ledger-accounts';
+import {
+  MemberListParams,
+  MemberListResponse,
+  MemberListResponsesCursorPage,
+  MemberRetrieveResponse,
+  Members,
+} from './resources/members';
 import {
   MembershipCancelParams,
   MembershipListParams,
@@ -107,12 +157,16 @@ import {
   MessageListParams,
   MessageListResponse,
   MessageListResponsesCursorPage,
+  MessageUpdateParams,
   Messages,
 } from './resources/messages';
 import {
+  BillingReasons,
+  CardBrands,
   PaymentListParams,
   PaymentListResponse,
   PaymentListResponsesCursorPage,
+  PaymentMethodTypes,
   PaymentRefundParams,
   Payments,
 } from './resources/payments';
@@ -132,6 +186,17 @@ import {
   ProductUpdateParams,
   Products,
 } from './resources/products';
+import {
+  PromoCode,
+  PromoCodeCreateParams,
+  PromoCodeDeleteResponse,
+  PromoCodeListParams,
+  PromoCodeListResponse,
+  PromoCodeListResponsesCursorPage,
+  PromoCodeStatus,
+  PromoCodes,
+  PromoDuration,
+} from './resources/promo-codes';
 import {
   ReactionCreateParams,
   ReactionListParams,
@@ -139,6 +204,14 @@ import {
   ReactionListResponsesCursorPage,
   Reactions,
 } from './resources/reactions';
+import {
+  ReviewListParams,
+  ReviewListResponse,
+  ReviewListResponsesCursorPage,
+  ReviewRetrieveResponse,
+  ReviewStatus,
+  Reviews,
+} from './resources/reviews';
 import {
   ShipmentCreateParams,
   ShipmentListParams,
@@ -167,10 +240,20 @@ import {
   Users,
 } from './resources/users';
 import {
+  CourseLessonInteractionCompletedWebhookEvent,
+  EntryApprovedWebhookEvent,
+  EntryCreatedWebhookEvent,
+  EntryDeletedWebhookEvent,
+  EntryDeniedWebhookEvent,
   InvoiceCreatedWebhookEvent,
   InvoicePaidWebhookEvent,
   InvoicePastDueWebhookEvent,
   InvoiceVoidedWebhookEvent,
+  MembershipActivatedWebhookEvent,
+  MembershipDeactivatedWebhookEvent,
+  PaymentFailedWebhookEvent,
+  PaymentPendingWebhookEvent,
+  PaymentSucceededWebhookEvent,
   UnwrapWebhookEvent,
   Webhooks,
 } from './resources/webhooks';
@@ -396,7 +479,7 @@ export class Whop {
   }
 
   protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+    return qs.stringify(query, { arrayFormat: 'brackets' });
   }
 
   private getUserAgent(): string {
@@ -884,6 +967,8 @@ export class Whop {
     }
   }
 
+  verifyUserToken: ReturnType<typeof makeUserTokenVerifierFromSdk> = makeUserTokenVerifierFromSdk(this);
+
   static Whop = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
@@ -926,8 +1011,13 @@ export class Whop {
   supportChannels: API.SupportChannels = new API.SupportChannels(this);
   experiences: API.Experiences = new API.Experiences(this);
   reactions: API.Reactions = new API.Reactions(this);
-
-  verifyUserToken: ReturnType<typeof makeUserTokenVerifierFromSdk> = makeUserTokenVerifierFromSdk(this);
+  members: API.Members = new API.Members(this);
+  forums: API.Forums = new API.Forums(this);
+  promoCodes: API.PromoCodes = new API.PromoCodes(this);
+  courses: API.Courses = new API.Courses(this);
+  courseChapters: API.CourseChapters = new API.CourseChapters(this);
+  courseLessons: API.CourseLessons = new API.CourseLessons(this);
+  reviews: API.Reviews = new API.Reviews(this);
 }
 
 Whop.Apps = Apps;
@@ -953,6 +1043,13 @@ Whop.Payments = Payments;
 Whop.SupportChannels = SupportChannels;
 Whop.Experiences = Experiences;
 Whop.Reactions = Reactions;
+Whop.Members = Members;
+Whop.Forums = Forums;
+Whop.PromoCodes = PromoCodes;
+Whop.Courses = Courses;
+Whop.CourseChapters = CourseChapters;
+Whop.CourseLessons = CourseLessons;
+Whop.Reviews = Reviews;
 
 export declare namespace Whop {
   export type RequestOptions = Opts.RequestOptions;
@@ -998,6 +1095,16 @@ export declare namespace Whop {
     type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent,
     type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent,
     type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent,
+    type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent,
+    type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent,
+    type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent,
+    type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent,
+    type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent,
+    type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent,
+    type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent,
+    type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
+    type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent,
+    type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
 
@@ -1024,6 +1131,7 @@ export declare namespace Whop {
     type ForumPostListResponse as ForumPostListResponse,
     type ForumPostListResponsesCursorPage as ForumPostListResponsesCursorPage,
     type ForumPostCreateParams as ForumPostCreateParams,
+    type ForumPostUpdateParams as ForumPostUpdateParams,
     type ForumPostListParams as ForumPostListParams,
   };
 
@@ -1087,6 +1195,7 @@ export declare namespace Whop {
     type MessageListResponse as MessageListResponse,
     type MessageListResponsesCursorPage as MessageListResponsesCursorPage,
     type MessageCreateParams as MessageCreateParams,
+    type MessageUpdateParams as MessageUpdateParams,
     type MessageListParams as MessageListParams,
   };
 
@@ -1107,6 +1216,9 @@ export declare namespace Whop {
 
   export {
     Payments as Payments,
+    type BillingReasons as BillingReasons,
+    type CardBrands as CardBrands,
+    type PaymentMethodTypes as PaymentMethodTypes,
     type PaymentListResponse as PaymentListResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,
     type PaymentListParams as PaymentListParams,
@@ -1131,6 +1243,7 @@ export declare namespace Whop {
     type ExperienceListParams as ExperienceListParams,
     type ExperienceAttachParams as ExperienceAttachParams,
     type ExperienceDetachParams as ExperienceDetachParams,
+    type ExperienceDuplicateParams as ExperienceDuplicateParams,
   };
 
   export {
@@ -1141,6 +1254,81 @@ export declare namespace Whop {
     type ReactionListParams as ReactionListParams,
   };
 
+  export {
+    Members as Members,
+    type MemberRetrieveResponse as MemberRetrieveResponse,
+    type MemberListResponse as MemberListResponse,
+    type MemberListResponsesCursorPage as MemberListResponsesCursorPage,
+    type MemberListParams as MemberListParams,
+  };
+
+  export {
+    Forums as Forums,
+    type ForumListResponse as ForumListResponse,
+    type ForumListResponsesCursorPage as ForumListResponsesCursorPage,
+    type ForumUpdateParams as ForumUpdateParams,
+    type ForumListParams as ForumListParams,
+  };
+
+  export {
+    PromoCodes as PromoCodes,
+    type PromoCode as PromoCode,
+    type PromoCodeStatus as PromoCodeStatus,
+    type PromoDuration as PromoDuration,
+    type PromoCodeListResponse as PromoCodeListResponse,
+    type PromoCodeDeleteResponse as PromoCodeDeleteResponse,
+    type PromoCodeListResponsesCursorPage as PromoCodeListResponsesCursorPage,
+    type PromoCodeCreateParams as PromoCodeCreateParams,
+    type PromoCodeListParams as PromoCodeListParams,
+  };
+
+  export {
+    Courses as Courses,
+    type Course as Course,
+    type Languages as Languages,
+    type CourseListResponse as CourseListResponse,
+    type CourseDeleteResponse as CourseDeleteResponse,
+    type CourseListResponsesCursorPage as CourseListResponsesCursorPage,
+    type CourseCreateParams as CourseCreateParams,
+    type CourseUpdateParams as CourseUpdateParams,
+    type CourseListParams as CourseListParams,
+  };
+
+  export {
+    CourseChapters as CourseChapters,
+    type CourseChapter as CourseChapter,
+    type CourseChapterListResponse as CourseChapterListResponse,
+    type CourseChapterDeleteResponse as CourseChapterDeleteResponse,
+    type CourseChapterListResponsesCursorPage as CourseChapterListResponsesCursorPage,
+    type CourseChapterCreateParams as CourseChapterCreateParams,
+    type CourseChapterUpdateParams as CourseChapterUpdateParams,
+    type CourseChapterListParams as CourseChapterListParams,
+  };
+
+  export {
+    CourseLessons as CourseLessons,
+    type AssessmentQuestionTypes as AssessmentQuestionTypes,
+    type Lesson as Lesson,
+    type LessonTypes as LessonTypes,
+    type LessonVisibilities as LessonVisibilities,
+    type CourseLessonListResponse as CourseLessonListResponse,
+    type CourseLessonDeleteResponse as CourseLessonDeleteResponse,
+    type CourseLessonListResponsesCursorPage as CourseLessonListResponsesCursorPage,
+    type CourseLessonCreateParams as CourseLessonCreateParams,
+    type CourseLessonUpdateParams as CourseLessonUpdateParams,
+    type CourseLessonListParams as CourseLessonListParams,
+  };
+
+  export {
+    Reviews as Reviews,
+    type ReviewStatus as ReviewStatus,
+    type ReviewRetrieveResponse as ReviewRetrieveResponse,
+    type ReviewListResponse as ReviewListResponse,
+    type ReviewListResponsesCursorPage as ReviewListResponsesCursorPage,
+    type ReviewListParams as ReviewListParams,
+  };
+
+  export type AccessLevel = API.AccessLevel;
   export type AccessPassType = API.AccessPassType;
   export type App = API.App;
   export type AppBuild = API.AppBuild;
@@ -1160,9 +1348,11 @@ export declare namespace Whop {
   export type CustomCta = API.CustomCta;
   export type Direction = API.Direction;
   export type DmsPostTypes = API.DmsPostTypes;
+  export type EmailNotificationPreferences = API.EmailNotificationPreferences;
   export type Entry = API.Entry;
   export type EntryStatus = API.EntryStatus;
   export type Experience = API.Experience;
+  export type Forum = API.Forum;
   export type ForumPost = API.ForumPost;
   export type FriendlyReceiptStatus = API.FriendlyReceiptStatus;
   export type GlobalAffiliateStatus = API.GlobalAffiliateStatus;
@@ -1170,6 +1360,8 @@ export declare namespace Whop {
   export type Invoice = API.Invoice;
   export type InvoiceListItem = API.InvoiceListItem;
   export type InvoiceStatus = API.InvoiceStatus;
+  export type MemberMostRecentActions = API.MemberMostRecentActions;
+  export type MemberStatuses = API.MemberStatuses;
   export type Membership = API.Membership;
   export type MembershipStatus = API.MembershipStatus;
   export type Message = API.Message;
@@ -1192,6 +1384,8 @@ export declare namespace Whop {
   export type Transfer = API.Transfer;
   export type Visibility = API.Visibility;
   export type VisibilityFilter = API.VisibilityFilter;
+  export type WhoCanCommentTypes = API.WhoCanCommentTypes;
   export type WhoCanPost = API.WhoCanPost;
+  export type WhoCanPostTypes = API.WhoCanPostTypes;
   export type WhoCanReact = API.WhoCanReact;
 }

package/src/resources/apps.ts

@@ -142,6 +142,12 @@ export interface AppListResponse {
    */
   experience_path: string | null;
 
+  /**
+   * 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.
+   */
+  icon: AppListResponse.Icon | null;
+
   /**
    * The name of the app
    */
@@ -198,6 +204,18 @@ export namespace AppListResponse {
      */
     username: 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.
+   */
+  export interface Icon {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
 }
 
 export interface AppCreateParams {

package/src/resources/checkout-configurations.ts

@@ -9,12 +9,14 @@ import { path } from '../internal/utils/path';
 
 export class CheckoutConfigurations extends APIResource {
   /**
-   * Creates a new checkout session
+   * Creates a new checkout configuration
    *
    * Required permissions:
    *
    * - `checkout_configuration:create`
    * - `plan:create`
+   * - `access_pass:create`
+   * - `access_pass:update`
    *
    * @example
    * ```ts
@@ -80,48 +82,52 @@ export class CheckoutConfigurations extends APIResource {
 export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutConfigurationListResponse>;
 
 /**
- * A checkout session
+ * A checkout configuration object.
+ *         Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
+ *         This configuration can be re-used by multiple users.
+ *         All successful payments and memberships resulting from a checkout will contain the passed metadata.
  */
 export interface CheckoutConfigurationListResponse {
   /**
-   * The ID of the checkout session
+   * The ID of the checkout configuration
    */
   id: string;
 
   /**
-   * The affiliate code to use for the checkout session
+   * The affiliate code to use for the checkout configuration
    */
-  affiliate_code: string;
+  affiliate_code: string | null;
 
   /**
-   * The ID of the company to use for the checkout session
+   * The ID of the company to use for the checkout configuration
    */
   company_id: string;
 
   /**
-   * The metadata to use for the checkout session
+   * The metadata to use for the checkout configuration
    */
   metadata: { [key: string]: unknown };
 
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   plan: CheckoutConfigurationListResponse.Plan;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * A URL you can send to customers to complete a checkout. It looks like
+   * `/checkout/plan_xxxx?session={id}`
    */
   purchase_url: string;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * The URL to redirect the user to after the checkout configuration is created
    */
-  redirect_url: string;
+  redirect_url: string | null;
 }
 
 export namespace CheckoutConfigurationListResponse {
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   export interface Plan {
     /**
@@ -178,34 +184,34 @@ export namespace CheckoutConfigurationListResponse {
 
 export interface CheckoutConfigurationCreateParams {
   /**
-   * The affiliate code to use for the checkout session
+   * The affiliate code to use for the checkout configuration
    */
   affiliate_code?: string | null;
 
   /**
-   * The metadata to use for the checkout session
+   * The metadata to use for the checkout configuration
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Pass this object to create a new plan for this checkout session
+   * Pass this object to create a new plan for this checkout configuration
    */
   plan?: CheckoutConfigurationCreateParams.Plan | null;
 
   /**
-   * The ID of the plan to use for the checkout session
+   * The ID of the plan to use for the checkout configuration
    */
   plan_id?: string | null;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * The URL to redirect the user to after the checkout configuration is created
    */
   redirect_url?: string | null;
 }
 
 export namespace CheckoutConfigurationCreateParams {
   /**
-   * Pass this object to create a new plan for this checkout session
+   * Pass this object to create a new plan for this checkout configuration
    */
   export interface Plan {
     /**
@@ -271,7 +277,13 @@ export namespace CheckoutConfigurationCreateParams {
     plan_type?: Shared.PlanType | null;
 
     /**
-     * The product the plan is related to.
+     * Pass this object to create a new product for this plan. We will use the product
+     * external identifier to find or create an existing product.
+     */
+    product?: Plan.Product | null;
+
+    /**
+     * The product the plan is related to. Either this or product is required.
      */
     product_id?: string | null;
 
@@ -352,6 +364,86 @@ export namespace CheckoutConfigurationCreateParams {
        */
       direct_upload_id?: string | null;
     }
+
+    /**
+     * Pass this object to create a new product for this plan. We will use the product
+     * external identifier to find or create an existing product.
+     */
+    export interface Product {
+      /**
+       * A unique ID used to find or create a product. When provided during creation, we
+       * will look for an existing product with this external identifier — if found, it
+       * will be updated; otherwise, a new product will be created.
+       */
+      external_identifier: string;
+
+      /**
+       * The title of the product.
+       */
+      title: string;
+
+      /**
+       * The different business types a company can be.
+       */
+      business_type?: Shared.BusinessTypes | null;
+
+      /**
+       * Whether or not to collect shipping information at checkout from the customer.
+       */
+      collect_shipping_address?: boolean | null;
+
+      /**
+       * The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+       * between 5 and 22 characters, contain at least one letter, and not contain any of
+       * the following characters: <, >, \, ', "
+       */
+      custom_statement_descriptor?: string | null;
+
+      /**
+       * A written description of the product.
+       */
+      description?: string | null;
+
+      /**
+       * The percentage of the revenue that goes to the global affiliate program.
+       */
+      global_affiliate_percentage?: number | null;
+
+      /**
+       * The different statuses of the global affiliate program for an access pass.
+       */
+      global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
+
+      /**
+       * The headline of the product.
+       */
+      headline?: string | null;
+
+      /**
+       * The different industry types a company can be in.
+       */
+      industry_type?: Shared.IndustryTypes | null;
+
+      /**
+       * The ID of the product tax code to apply to this product.
+       */
+      product_tax_code_id?: string | null;
+
+      /**
+       * The URL to redirect the customer to after a purchase.
+       */
+      redirect_purchase_url?: string | null;
+
+      /**
+       * The route of the product.
+       */
+      route?: string | null;
+
+      /**
+       * Visibility of a resource
+       */
+      visibility?: Shared.Visibility | null;
+    }
   }
 }