@whop/sdk 0.0.3 → 0.0.5

package/src/resources/shared.ts

@@ -5,12 +5,13 @@ 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.
+ * The access level a given user (or company) has to a product or company.
  */
 export type AccessLevel = 'no_access' | 'admin' | 'customer';
 
 /**
- * The different types an access pass can be.
+ * The different types an product can be. Only use 'regular'. The rest are for
+ * internal use
  */
 export type AccessPassType = 'regular' | 'app' | 'experience_upsell' | 'api_only';
 
@@ -557,6 +558,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
    */
@@ -964,7 +971,7 @@ export interface Entry {
   plan: Entry.Plan | null;
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   product: Entry.Product | null;
 
@@ -1011,7 +1018,7 @@ export namespace Entry {
   }
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   export interface Product {
     /**
@@ -1096,10 +1103,9 @@ export interface Experience {
   order: string | null;
 
   /**
-   * The access passes that are associated with this experience. This should not be
-   * used unless you are trying to list all access passes the experience has, for
-   * some reason. You probably don't want to use this though and should be using
-   * accessPass.
+   * The products that this experience is attached to. This defines which set of
+   * customers have access and can view this experience. If empty, this experience is
+   * only visible to authorized users of the company
    */
   products: Array<Experience.Product>;
 }
@@ -1172,7 +1178,7 @@ export namespace Experience {
   }
 
   /**
-   * An object representing a (sanitized) access pass.
+   * Represents a product on whop. Use products to sell anything on the platform.
    */
   export interface Product {
     /**
@@ -1244,7 +1250,7 @@ export namespace Forum {
  */
 export interface ForumPost {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -1353,7 +1359,7 @@ export type FriendlyReceiptStatus =
   | 'canceled';
 
 /**
- * The different statuses of the global affiliate program for an access pass.
+ * The different statuses of the global affiliate program for a product.
  */
 export type GlobalAffiliateStatus = 'enabled' | 'disabled';
 
@@ -1846,7 +1852,7 @@ export type MembershipStatus =
  */
 export interface Message {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -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
    */
@@ -2110,7 +2122,7 @@ export interface Payment {
   plan: Payment.Plan | null;
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   product: Payment.Product | null;
 
@@ -2281,7 +2293,7 @@ export namespace Payment {
   }
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   export interface Product {
     /**
@@ -2362,7 +2374,9 @@ export namespace Payment {
 }
 
 /**
- * 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 Plan {
   /**
@@ -2430,13 +2444,18 @@ 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.
    */
   plan_type: PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: Plan.Product | null;
 
@@ -2553,7 +2572,33 @@ export namespace Plan {
   }
 
   /**
-   * 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 {
     /**
@@ -2569,12 +2614,12 @@ export namespace Plan {
 }
 
 /**
- * The type of plan that can be attached to an access pass
+ * The type of plan that can be attached to a product
  */
 export type PlanType = 'renewal' | 'one_time';
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface Product {
   /**
@@ -2765,7 +2810,7 @@ export namespace Product {
 }
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface ProductListItem {
   /**
@@ -3196,6 +3241,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/resources/users.ts

@@ -91,6 +91,9 @@ export interface UserCheckAccessResponse {
 }
 
 export interface UserCheckAccessParams {
+  /**
+   * The ID (user_xxx) or username of the user
+   */
   id: string;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.3'; // x-release-please-version
+export const VERSION = '0.0.5'; // 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.5";
 //# 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.5";
 //# 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.5'; // 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.5'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map