@whop/sdk 0.0.2 → 0.0.4

package/src/resources/plans.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 PaymentsAPI from './payments';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
@@ -175,6 +176,11 @@ export interface PlanListResponse {
    */
   member_count: number | null;
 
+  /**
+   * The explicit payment method configuration for the plan, if any.
+   */
+  payment_method_configuration: PlanListResponse.PaymentMethodConfiguration | null;
+
   /**
    * Indicates if the plan is a one time payment or recurring.
    */
@@ -200,11 +206,26 @@ export interface PlanListResponse {
    */
   renewal_price: number;
 
+  /**
+   * The number of units available for purchase. Only displayed to authorized actors
+   */
+  stock: number | null;
+
+  /**
+   * 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.
    */
@@ -242,6 +263,32 @@ export namespace PlanListResponse {
     id: string;
   }
 
+  /**
+   * The explicit payment method configuration for the plan, if any.
+   */
+  export interface PaymentMethodConfiguration {
+    /**
+     * An array of payment method identifiers that are explicitly disabled. Only
+     * applies if the include_platform_defaults is true.
+     */
+    disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * An array of payment method identifiers that are explicitly enabled. This means
+     * these payment methods will be shown on checkout. Example use case is to only
+     * enable a specific payment method like cashapp, or extending the platform
+     * defaults with additional methods.
+     */
+    enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * Whether Whop's platform default payment method enablement settings are included
+     * in this configuration. The full list of default payment methods can be found in
+     * the documentation at docs.whop.com/payments.
+     */
+    include_platform_defaults: boolean;
+  }
+
   /**
    * The access pass for the plan.
    */
@@ -275,7 +322,7 @@ export interface PlanCreateParams {
   product_id: string;
 
   /**
-   * The interval at which the plan charges (renewal plans).
+   * The interval in days at which the plan charges (renewal plans).
    */
   billing_period?: number | null;
 
@@ -302,7 +349,7 @@ export interface PlanCreateParams {
   /**
    * An image for the plan. This will be visible on the product page to customers.
    */
-  image?: PlanCreateParams.Image | null;
+  image?: PlanCreateParams.AttachmentInputWithDirectUploadID | PlanCreateParams.AttachmentInputWithID | null;
 
   /**
    * An additional amount charged upon first purchase. Use only if a one time payment
@@ -322,6 +369,12 @@ export interface PlanCreateParams {
    */
   override_tax_type?: Shared.TaxType | null;
 
+  /**
+   * The explicit payment method configuration for the plan. If not provided, the
+   * platform or company's defaults will apply.
+   */
+  payment_method_configuration?: PlanCreateParams.PaymentMethodConfiguration | null;
+
   /**
    * The type of plan that can be attached to an access pass
    */
@@ -338,6 +391,23 @@ export interface PlanCreateParams {
    */
   renewal_price?: number | null;
 
+  /**
+   * The number of units available for purchase.
+   */
+  stock?: number | null;
+
+  /**
+   * The price to display with a strikethrough for the initial price. Provided as a
+   * number in dollars. Eg: 19.99 for $19.99
+   */
+  strike_through_initial_price?: number | null;
+
+  /**
+   * The price to display with a strikethrough for the renewal price. Provided as a
+   * number in dollars. Eg: 19.99 for $19.99
+   */
+  strike_through_renewal_price?: number | null;
+
   /**
    * The title of the plan. This will be visible on the product page to customers.
    */
@@ -348,6 +418,11 @@ export interface PlanCreateParams {
    */
   trial_period_days?: number | null;
 
+  /**
+   * Limits/doesn't limit the number of units available for purchase.
+   */
+  unlimited_stock?: boolean | null;
+
   /**
    * Visibility of a resource
    */
@@ -388,22 +463,54 @@ export namespace PlanCreateParams {
   }
 
   /**
-   * An image for the plan. This will be visible on the product page to customers.
+   * Input for an attachment
    */
-  export interface Image {
+  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 | null;
+    id: string;
+  }
 
+  /**
+   * The explicit payment method configuration for the plan. If not provided, the
+   * platform or company's defaults will apply.
+   */
+  export interface PaymentMethodConfiguration {
     /**
-     * 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.
+     * An array of payment method identifiers that are explicitly disabled. Only
+     * applies if the include_platform_defaults is true.
+     */
+    disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * An array of payment method identifiers that are explicitly enabled. This means
+     * these payment methods will be shown on checkout. Example use case is to only
+     * enable a specific payment method like cashapp, or extending the platform
+     * defaults with additional methods.
+     */
+    enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * Whether Whop's platform default payment method enablement settings are included
+     * in this configuration. The full list of default payment methods can be found in
+     * the documentation at docs.whop.com/payments.
      */
-    direct_upload_id?: string | null;
+    include_platform_defaults: boolean;
   }
 }
 
@@ -436,7 +543,7 @@ export interface PlanUpdateParams {
   /**
    * An image for the plan. This will be visible on the product page to customers.
    */
-  image?: PlanUpdateParams.Image | null;
+  image?: PlanUpdateParams.AttachmentInputWithDirectUploadID | PlanUpdateParams.AttachmentInputWithID | null;
 
   /**
    * An additional amount charged upon first purchase.
@@ -459,11 +566,34 @@ export interface PlanUpdateParams {
    */
   override_tax_type?: Shared.TaxType | null;
 
+  /**
+   * The explicit payment method configuration for the plan. If sent as null, the
+   * custom configuration will be removed.
+   */
+  payment_method_configuration?: PlanUpdateParams.PaymentMethodConfiguration | null;
+
   /**
    * The amount the customer is charged every billing period.
    */
   renewal_price?: number | null;
 
+  /**
+   * The number of units available for purchase.
+   */
+  stock?: number | null;
+
+  /**
+   * The price to display with a strikethrough for the initial price. Provided as a
+   * number in dollars. Eg: 19.99 for $19.99
+   */
+  strike_through_initial_price?: number | null;
+
+  /**
+   * The price to display with a strikethrough for the renewal price. Provided as a
+   * number in dollars. Eg: 19.99 for $19.99
+   */
+  strike_through_renewal_price?: number | null;
+
   /**
    * The title of the plan. This will be visible on the product page to customers.
    */
@@ -474,6 +604,11 @@ export interface PlanUpdateParams {
    */
   trial_period_days?: number | null;
 
+  /**
+   * Limits/doesn't limit the number of units available for purchase.
+   */
+  unlimited_stock?: boolean | null;
+
   /**
    * Visibility of a resource
    */
@@ -514,22 +649,54 @@ export namespace PlanUpdateParams {
   }
 
   /**
-   * An image for the plan. This will be visible on the product page to customers.
+   * Input for an attachment
    */
-  export interface Image {
+  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 | null;
+    id: string;
+  }
 
+  /**
+   * The explicit payment method configuration for the plan. If sent as null, the
+   * custom configuration will be removed.
+   */
+  export interface PaymentMethodConfiguration {
     /**
-     * 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.
+     * An array of payment method identifiers that are explicitly disabled. Only
+     * applies if the include_platform_defaults is true.
+     */
+    disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * An array of payment method identifiers that are explicitly enabled. This means
+     * these payment methods will be shown on checkout. Example use case is to only
+     * enable a specific payment method like cashapp, or extending the platform
+     * defaults with additional methods.
+     */
+    enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+    /**
+     * Whether Whop's platform default payment method enablement settings are included
+     * in this configuration. The full list of default payment methods can be found in
+     * the documentation at docs.whop.com/payments.
      */
-    direct_upload_id?: string | null;
+    include_platform_defaults: boolean;
   }
 }
 

package/src/resources/products.ts

@@ -129,16 +129,6 @@ export interface ProductCreateParams {
    */
   title: string;
 
-  /**
-   * The different types an access pass can be.
-   */
-  access_pass_type?: Shared.AccessPassType | null;
-
-  /**
-   * A banner image for the product in png, jpeg format
-   */
-  banner_image?: ProductCreateParams.BannerImage | null;
-
   /**
    * The different business types a company can be.
    */
@@ -238,25 +228,6 @@ export interface ProductCreateParams {
 }
 
 export namespace ProductCreateParams {
-  /**
-   * A banner image for the product in png, jpeg format
-   */
-  export interface BannerImage {
-    /**
-     * 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 | null;
-
-    /**
-     * 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 | null;
-  }
-
   /**
    * The details to assign an autogenerated plan.
    */
@@ -362,7 +333,10 @@ export interface ProductUpdateParams {
   /**
    * A banner image for the product in png, jpeg format
    */
-  banner_image?: ProductUpdateParams.BannerImage | null;
+  banner_image?:
+    | ProductUpdateParams.AttachmentInputWithDirectUploadID
+    | ProductUpdateParams.AttachmentInputWithID
+    | null;
 
   /**
    * The different business types a company can be.
@@ -441,6 +415,11 @@ export interface ProductUpdateParams {
    */
   route?: string | null;
 
+  /**
+   * Configuration for a product on the company's store page.
+   */
+  store_page_config?: ProductUpdateParams.StorePageConfig | null;
+
   /**
    * The title of the product.
    */
@@ -454,22 +433,42 @@ export interface ProductUpdateParams {
 
 export namespace ProductUpdateParams {
   /**
-   * A banner image for the product in png, jpeg format
+   * 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 BannerImage {
+  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 | null;
+    id: string;
+  }
 
+  /**
+   * Configuration for a product on the company's store page.
+   */
+  export interface StorePageConfig {
     /**
-     * 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.
+     * Custom call-to-action text for the product's store page.
+     */
+    custom_cta?: string | null;
+
+    /**
+     * Whether or not to show the price on the product's store page.
      */
-    direct_upload_id?: string | null;
+    show_price?: boolean | null;
   }
 }