@whop/sdk 0.0.3 → 0.0.4

package/src/resources/messages.ts

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

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.
    */
@@ -257,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.
    */
@@ -317,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
@@ -337,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
    */
@@ -425,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.
      */
-    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 +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.
@@ -496,6 +566,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 +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 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

@@ -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.
@@ -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/shared.ts

@@ -557,6 +557,12 @@ export interface Company {
    */
   member_count: number;
 
+  /**
+   * A key-value store of data for the account, created/updated by the platform that
+   * made the account.
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The user who owns this company
    */
@@ -2094,6 +2100,12 @@ export interface Payment {
    */
   membership: Payment.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
    */
@@ -2430,6 +2442,11 @@ export interface Plan {
    */
   member_count: number | null;
 
+  /**
+   * The explicit payment method configuration for the plan, if any.
+   */
+  payment_method_configuration: Plan.PaymentMethodConfiguration | null;
+
   /**
    * Indicates if the plan is a one time payment or recurring.
    */
@@ -2552,6 +2569,32 @@ export namespace Plan {
     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.
    */
@@ -3196,6 +3239,11 @@ export interface Transfer {
    */
   fee_amount: number | null;
 
+  /**
+   * A hash of metadata attached to the transfer
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The notes of the credit transaction transfer
    */

package/src/resources/transfers.ts

@@ -106,6 +106,11 @@ export interface TransferListResponse {
    */
   fee_amount: number | null;
 
+  /**
+   * A hash of metadata attached to the transfer
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The notes of the credit transaction transfer
    */
@@ -145,6 +150,11 @@ export interface TransferCreateParams {
    */
   idempotence_key?: string | null;
 
+  /**
+   * A hash of metadata to attach to the transfer.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
   /**
    * Notes for the transfer. Maximum of 50 characters.
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.3'; // x-release-please-version
+export const VERSION = '0.0.4'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.3";
+export declare const VERSION = "0.0.4";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.3";
+export declare const VERSION = "0.0.4";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.3'; // x-release-please-version
+exports.VERSION = '0.0.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.3'; // x-release-please-version
+export const VERSION = '0.0.4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map