@whop/sdk 0.0.1-canary.0 → 0.0.2

package/src/resources/shared.ts

@@ -3,6 +3,11 @@
 import * as Shared from './shared';
 import { CursorPage } from '../core/pagination';
 
+/**
+ * The access level a given user (or company) has to an access pass or company.
+ */
+export type AccessLevel = 'no_access' | 'admin' | 'customer';
+
 /**
  * The different types an access pass can be.
  */
@@ -67,6 +72,12 @@ export interface App {
    */
   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: App.Icon | null;
+
   /**
    * The name of the app
    */
@@ -155,6 +166,18 @@ export namespace App {
     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;
+  }
+
   /**
    * A permission that the app requests from the admin of a company during the oauth
    * flow.
@@ -389,48 +412,51 @@ export namespace ChatChannel {
 }
 
 /**
- * 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 CheckoutConfiguration {
   /**
-   * 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: CheckoutConfiguration.Plan;
 
   /**
-   * 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
    */
   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 CheckoutConfiguration {
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   export interface Plan {
     /**
@@ -509,11 +535,21 @@ export interface Company {
    */
   created_at: string;
 
+  /**
+   * The creator pitch for the company.
+   */
+  description: string | null;
+
   /**
    * The different industry types a company can be in.
    */
   industry_type: IndustryTypes | null;
 
+  /**
+   * The company's logo.
+   */
+  logo: Company.Logo | null;
+
   /**
    * The number of members in the company.
    */
@@ -556,6 +592,17 @@ export interface Company {
 }
 
 export namespace Company {
+  /**
+   * The company's logo.
+   */
+  export interface Logo {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
   /**
    * The user who owns this company
    */
@@ -611,6 +658,11 @@ export interface CourseLessonInteraction {
    */
   completed: boolean;
 
+  /**
+   * The course for this lesson interaction
+   */
+  course: CourseLessonInteraction.Course;
+
   /**
    * When the interaction was created
    */
@@ -628,6 +680,38 @@ export interface CourseLessonInteraction {
 }
 
 export namespace CourseLessonInteraction {
+  /**
+   * The course for this lesson interaction
+   */
+  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 lesson this interaction is for
    */
@@ -848,6 +932,11 @@ export type Direction = 'asc' | 'desc';
  */
 export type DmsPostTypes = 'regular' | 'system' | 'automated';
 
+/**
+ * Email notification preference option for a forum feed
+ */
+export type EmailNotificationPreferences = 'all_admin_posts' | 'only_weekly_summary' | 'none';
+
 /**
  * An object representing an entry in a waitlist.
  */
@@ -989,6 +1078,11 @@ export interface Experience {
    */
   created_at: string;
 
+  /**
+   * The logo for the experience.
+   */
+  image: Experience.Image | null;
+
   /**
    * The written name of the description.
    */
@@ -1018,12 +1112,32 @@ export namespace Experience {
      */
     id: 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.
+     */
+    icon: App.Icon | null;
+
     /**
      * The name of the app
      */
     name: string;
   }
 
+  export namespace App {
+    /**
+     * 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;
+    }
+  }
+
   /**
    * The company that owns this experience.
    */
@@ -1044,6 +1158,17 @@ export namespace Experience {
     title: string;
   }
 
+  /**
+   * The logo for the experience.
+   */
+  export interface Image {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
   /**
    * An object representing a (sanitized) access pass.
    */
@@ -1065,6 +1190,53 @@ export namespace Experience {
   }
 }
 
+/**
+ * Represents a forum feed
+ */
+export interface Forum {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The email notification preference for this forum
+   */
+  email_notification_preference: EmailNotificationPreferences;
+
+  /**
+   * The experience for this forum
+   */
+  experience: Forum.Experience;
+
+  /**
+   * Who can comment on this forum
+   */
+  who_can_comment: WhoCanCommentTypes;
+
+  /**
+   * Who can post on this forum
+   */
+  who_can_post: WhoCanPostTypes;
+}
+
+export namespace Forum {
+  /**
+   * The experience for this forum
+   */
+  export interface Experience {
+    /**
+     * The unique ID representing this experience
+     */
+    id: string;
+
+    /**
+     * The written name of the description.
+     */
+    name: string;
+  }
+}
+
 /**
  * Represents a post in forum
  */
@@ -1426,6 +1598,30 @@ export namespace InvoiceListItem {
  */
 export type InvoiceStatus = 'open' | 'paid' | 'past_due' | 'void';
 
+/**
+ * The different most recent actions a member can have.
+ */
+export type MemberMostRecentActions =
+  | 'canceling'
+  | 'churned'
+  | 'finished_split_pay'
+  | 'paused'
+  | 'paid_subscriber'
+  | 'paid_once'
+  | 'expiring'
+  | 'joined'
+  | 'drafted'
+  | 'left'
+  | 'trialing'
+  | 'pending_entry'
+  | 'renewing'
+  | 'past_due';
+
+/**
+ * The different statuses a Member can have.
+ */
+export type MemberStatuses = 'drafted' | 'joined' | 'left';
+
 /**
  * A membership represents a purchase between a User and a Company for a specific
  * Product.
@@ -3069,11 +3265,21 @@ export type VisibilityFilter =
   | 'not_quick_link'
   | 'not_archived';
 
+/**
+ * Who can comment on a forum feed
+ */
+export type WhoCanCommentTypes = 'everyone' | 'admins';
+
 /**
  * Who can post on a chat feed
  */
 export type WhoCanPost = 'everyone' | 'admins';
 
+/**
+ * Who can post on a forum feed
+ */
+export type WhoCanPostTypes = 'everyone' | 'admins';
+
 /**
  * Who can react on a chat feed
  */

package/src/resources/users.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -50,12 +51,30 @@ export interface UserRetrieveResponse {
    */
   name: string | null;
 
+  /**
+   * The user's profile picture
+   */
+  profile_picture: UserRetrieveResponse.ProfilePicture | null;
+
   /**
    * The username of the user from their Whop account.
    */
   username: string;
 }
 
+export namespace UserRetrieveResponse {
+  /**
+   * The user's profile picture
+   */
+  export interface ProfilePicture {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+}
+
 /**
  * The result of a has access check for the developer API
  */
@@ -63,7 +82,7 @@ export interface UserCheckAccessResponse {
   /**
    * The permission level of the user
    */
-  access_level: 'no_access' | 'admin' | 'customer';
+  access_level: Shared.AccessLevel;
 
   /**
    * Whether the user has access to the resource