@whop/sdk 0.0.1-canary.0 → 0.0.3

package/src/resources/shared.ts

@@ -1,8 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Shared from './shared';
+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.
+ */
+export type AccessLevel = 'no_access' | 'admin' | 'customer';
+
 /**
  * The different types an access pass can be.
  */
@@ -67,6 +73,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 +167,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 +413,52 @@ 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
+   * 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 CheckoutConfiguration {
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   export interface Plan {
     /**
@@ -509,11 +537,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 +594,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 +660,11 @@ export interface CourseLessonInteraction {
    */
   completed: boolean;
 
+  /**
+   * The course for this lesson interaction
+   */
+  course: CourseLessonInteraction.Course;
+
   /**
    * When the interaction was created
    */
@@ -628,6 +682,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 +934,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 +1080,11 @@ export interface Experience {
    */
   created_at: string;
 
+  /**
+   * The logo for the experience.
+   */
+  image: Experience.Image | null;
+
   /**
    * The written name of the description.
    */
@@ -1018,12 +1114,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 +1160,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 +1192,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
  */
@@ -1084,6 +1258,11 @@ export interface ForumPost {
    */
   content: string | null;
 
+  /**
+   * The timestamp when the post was created
+   */
+  created_at: string;
+
   /**
    * Whether the forum post has been edited
    */
@@ -1114,6 +1293,11 @@ export interface ForumPost {
    */
   title: string | null;
 
+  /**
+   * The timestamp when the post was last updated
+   */
+  updated_at: string;
+
   /**
    * The user who created this forum post
    */
@@ -1267,7 +1451,8 @@ export interface Invoice {
   email_address: string | null;
 
   /**
-   * The token to fetch the invoice.
+   * A signed token that allows fetching the invoice data publically without being
+   * authenticated.
    */
   fetch_invoice_token: string;
 
@@ -1359,7 +1544,8 @@ export interface InvoiceListItem {
   email_address: string | null;
 
   /**
-   * The token to fetch the invoice.
+   * A signed token that allows fetching the invoice data publically without being
+   * authenticated.
    */
   fetch_invoice_token: string;
 
@@ -1426,6 +1612,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.
@@ -1498,6 +1708,11 @@ export interface Membership {
    */
   plan: Membership.Plan;
 
+  /**
+   * The Product this Membership grants access to.
+   */
+  product: Membership.Product;
+
   /**
    * The Promo Code that is currently applied to this Membership.
    */
@@ -1567,6 +1782,21 @@ export namespace Membership {
     id: string;
   }
 
+  /**
+   * The Product this Membership grants access to.
+   */
+  export interface Product {
+    /**
+     * The internal ID of the public product.
+     */
+    id: string;
+
+    /**
+     * The title of the product. Use for Whop 4.0.
+     */
+    title: string;
+  }
+
   /**
    * The Promo Code that is currently applied to this Membership.
    */
@@ -1810,14 +2040,14 @@ export interface Payment {
   billing_address: Payment.BillingAddress | null;
 
   /**
-   * The billing reason
+   * The reason why a specific payment was billed
    */
-  billing_reason: string | null;
+  billing_reason: PaymentsAPI.BillingReasons | null;
 
   /**
-   * The type of card used as the payment method.
+   * Possible card brands that a payment token can have
    */
-  card_brand: string | null;
+  card_brand: PaymentsAPI.CardBrands | null;
 
   /**
    * The last 4 digits of the card used to make the payment.
@@ -1870,10 +2100,9 @@ export interface Payment {
   paid_at: string | null;
 
   /**
-   * Returns the type of payment method used for the payment, if available. Ex.
-   * klarna, affirm, card, cashapp
+   * The different types of payment methods that can be used.
    */
-  payment_method_type: string | null;
+  payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
 
   /**
    * The plan attached to this payment.
@@ -1891,7 +2120,8 @@ export interface Payment {
   promo_code: Payment.PromoCode | null;
 
   /**
-   * Whether the payment can be refunded.
+   * True only for payments that are `paid`, have not been fully refunded, and were
+   * processed by a payment processor that allows refunds.
    */
   refundable: boolean;
 
@@ -1906,7 +2136,9 @@ export interface Payment {
   refunded_at: string | null;
 
   /**
-   * Whether the payment can be retried.
+   * True when the payment status is `open` and its membership is in one of the
+   * retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+   * otherwise false. Used to decide if Whop can attempt the charge again.
    */
   retryable: boolean;
 
@@ -1941,7 +2173,8 @@ export interface Payment {
   user: Payment.User | null;
 
   /**
-   * Whether the payment can be voided.
+   * True when the payment is tied to a membership in `past_due`, the payment status
+   * is `open`, and the processor allows voiding payments; otherwise false.
    */
   voidable: boolean;
 }
@@ -2092,7 +2325,7 @@ export namespace Payment {
     code: string | null;
 
     /**
-     * The number of billing cycles the promo is applied for.
+     * The number of months the promo is applied for.
      */
     number_of_intervals: number | null;
 
@@ -2222,16 +2455,31 @@ export interface Plan {
    */
   renewal_price: number;
 
+  /**
+   * The number of units available for purchase. Only displayed to authorized actors
+   */
+  stock: number | null;
+
   /**
    * The tax type for the plan.
    */
   tax_type: TaxType;
 
+  /**
+   * The title of the plan. This will be visible on the product page to customers.
+   */
+  title: string | null;
+
   /**
    * The number of free trial days added before a renewal plan.
    */
   trial_period_days: number | null;
 
+  /**
+   * Limits/doesn't limit the number of units available for purchase.
+   */
+  unlimited_stock: boolean;
+
   /**
    * When the plan was last updated.
    */
@@ -2369,6 +2617,13 @@ export interface Product {
    */
   description: string | null;
 
+  /**
+   * A unique identifier used to create or update products. When provided on product
+   * creation endpoints, we’ll look up an existing product by this identifier — if it
+   * exists, we’ll update it; if not, we’ll create a new one.
+   */
+  external_identifier: string | null;
+
   /**
    * The percentage of a transaction a user is eligible to earn from the whop
    * marketplace global affiliate program.
@@ -2528,6 +2783,13 @@ export interface ProductListItem {
    */
   created_at: string;
 
+  /**
+   * A unique identifier used to create or update products. When provided on product
+   * creation endpoints, we’ll look up an existing product by this identifier — if it
+   * exists, we’ll update it; if not, we’ll create a new one.
+   */
+  external_identifier: string | null;
+
   /**
    * The headline of the product.
    */
@@ -3069,11 +3331,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