@whop/sdk 0.0.3 → 0.0.5

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;
 
@@ -221,7 +221,9 @@ export interface MessageCreateParams {
   /**
    * The attachments for this message, such as videos or images.
    */
-  attachments?: Array<MessageCreateParams.Attachment> | null;
+  attachments?: Array<
+    MessageCreateParams.AttachmentInputWithDirectUploadID | MessageCreateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * The poll for this message
@@ -233,20 +235,25 @@ export namespace MessageCreateParams {
   /**
    * Input for an attachment
    */
-  export interface Attachment {
-    /**
-     * 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;
-
+  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 | null;
+    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;
   }
 
   /**
@@ -281,7 +288,9 @@ export interface MessageUpdateParams {
   /**
    * The attachments for this message
    */
-  attachments?: Array<MessageUpdateParams.Attachment> | null;
+  attachments?: Array<
+    MessageUpdateParams.AttachmentInputWithDirectUploadID | MessageUpdateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * The content of the message in Markdown format
@@ -298,20 +307,25 @@ export namespace MessageUpdateParams {
   /**
    * Input for an attachment
    */
-  export interface Attachment {
-    /**
-     * 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;
-
+  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 | null;
+    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;
   }
 }
 

package/src/resources/payments.ts

@@ -256,10 +256,11 @@ export type PaymentMethodTypes =
   | 'id_bank_transfer'
   | 'demo_pay'
   | 'shop_pay'
-  | 'apple'
   | 'sezzle'
   | 'coinbase'
   | 'splitit'
+  | 'platform_balance'
+  | 'apple'
   | 'unknown';
 
 /**
@@ -341,6 +342,12 @@ export interface PaymentListResponse {
    */
   membership: PaymentListResponse.Membership | null;
 
+  /**
+   * The custom metadata stored on this payment. This will be copied the checkout
+   * configuration for which this payment was made
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The datetime the payment was paid
    */
@@ -357,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;
 
@@ -528,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

@@ -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';
@@ -117,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 {
   /**
@@ -175,13 +178,18 @@ 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.
    */
   plan_type: Shared.PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: PlanListResponse.Product | null;
 
@@ -258,7 +266,33 @@ export namespace PlanListResponse {
   }
 
   /**
-   * The access pass for the plan.
+   * 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 product that this plan belongs to.
    */
   export interface Product {
     /**
@@ -317,7 +351,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
@@ -338,7 +372,13 @@ export interface PlanCreateParams {
   override_tax_type?: Shared.TaxType | null;
 
   /**
-   * The type of plan that can be attached to an access pass
+   * 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 a product
    */
   plan_type?: Shared.PlanType | null;
 
@@ -425,22 +465,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.
      */
-    direct_upload_id?: string | null;
+    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;
   }
 }
 
@@ -473,7 +545,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.
@@ -496,6 +568,12 @@ 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.
    */
@@ -573,22 +651,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 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 Image {
+  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

@@ -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;
 
@@ -333,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.
@@ -373,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;
 
@@ -393,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;
 
@@ -430,22 +433,27 @@ export interface ProductUpdateParams {
 
 export namespace ProductUpdateParams {
   /**
-   * A banner image for the product in png, jpeg format
+   * Input for an attachment
    */
-  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;
-
+  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 | null;
+    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;
   }
 
   /**

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 {
     /**