@whop/sdk 0.0.6 → 0.0.8

package/src/client.ts

@@ -32,6 +32,7 @@ import {
   AppListParams,
   AppListResponse,
   AppListResponsesCursorPage,
+  AppType,
   AppUpdateParams,
   Apps,
 } from './resources/apps';
@@ -55,6 +56,7 @@ import {
   CheckoutConfigurationListResponse,
   CheckoutConfigurationListResponsesCursorPage,
   CheckoutConfigurations,
+  CheckoutModes,
 } from './resources/checkout-configurations';
 import {
   Companies,
@@ -84,6 +86,10 @@ import {
   CourseLessonListParams,
   CourseLessonListResponse,
   CourseLessonListResponsesCursorPage,
+  CourseLessonMarkAsCompletedResponse,
+  CourseLessonStartResponse,
+  CourseLessonSubmitAssessmentParams,
+  CourseLessonSubmitAssessmentResponse,
   CourseLessonUpdateParams,
   CourseLessons,
   EmbedType,
@@ -110,6 +116,15 @@ import {
   Courses,
   Languages,
 } from './resources/courses';
+import {
+  Dispute,
+  DisputeListParams,
+  DisputeListResponse,
+  DisputeListResponsesCursorPage,
+  DisputeStatuses,
+  DisputeUpdateEvidenceParams,
+  Disputes,
+} from './resources/disputes';
 import {
   Entries,
   EntryApproveResponse,
@@ -135,6 +150,7 @@ import {
   ForumPostListResponse,
   ForumPostListResponsesCursorPage,
   ForumPostUpdateParams,
+  ForumPostVisibilityType,
   ForumPosts,
 } from './resources/forum-posts';
 import {
@@ -219,6 +235,17 @@ import {
   ReactionListResponsesCursorPage,
   Reactions,
 } from './resources/reactions';
+import {
+  PaymentProvider,
+  RefundListParams,
+  RefundListResponse,
+  RefundListResponsesCursorPage,
+  RefundReferenceStatus,
+  RefundReferenceType,
+  RefundRetrieveResponse,
+  RefundStatus,
+  Refunds,
+} from './resources/refunds';
 import {
   ReviewListParams,
   ReviewListResponse,
@@ -256,6 +283,8 @@ import {
 } from './resources/users';
 import {
   CourseLessonInteractionCompletedWebhookEvent,
+  DisputeCreatedWebhookEvent,
+  DisputeUpdatedWebhookEvent,
   EntryApprovedWebhookEvent,
   EntryCreatedWebhookEvent,
   EntryDeletedWebhookEvent,
@@ -269,9 +298,22 @@ import {
   PaymentFailedWebhookEvent,
   PaymentPendingWebhookEvent,
   PaymentSucceededWebhookEvent,
+  RefundCreatedWebhookEvent,
+  RefundUpdatedWebhookEvent,
   UnwrapWebhookEvent,
   Webhooks,
 } from './resources/webhooks';
+import {
+  WithdrawalFeeTypes,
+  WithdrawalListParams,
+  WithdrawalListResponse,
+  WithdrawalListResponsesCursorPage,
+  WithdrawalRetrieveResponse,
+  WithdrawalSpeeds,
+  WithdrawalStatus,
+  WithdrawalTypes,
+  Withdrawals,
+} from './resources/withdrawals';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -1031,6 +1073,9 @@ export class Whop {
   courseStudents: API.CourseStudents = new API.CourseStudents(this);
   accessTokens: API.AccessTokens = new API.AccessTokens(this);
   notifications: API.Notifications = new API.Notifications(this);
+  disputes: API.Disputes = new API.Disputes(this);
+  refunds: API.Refunds = new API.Refunds(this);
+  withdrawals: API.Withdrawals = new API.Withdrawals(this);
 }
 
 Whop.Apps = Apps;
@@ -1066,6 +1111,9 @@ Whop.Reviews = Reviews;
 Whop.CourseStudents = CourseStudents;
 Whop.AccessTokens = AccessTokens;
 Whop.Notifications = Notifications;
+Whop.Disputes = Disputes;
+Whop.Refunds = Refunds;
+Whop.Withdrawals = Withdrawals;
 
 export declare namespace Whop {
   export type RequestOptions = Opts.RequestOptions;
@@ -1075,6 +1123,7 @@ export declare namespace Whop {
 
   export {
     Apps as Apps,
+    type AppType as AppType,
     type AppListResponse as AppListResponse,
     type AppListResponsesCursorPage as AppListResponsesCursorPage,
     type AppCreateParams as AppCreateParams,
@@ -1126,6 +1175,10 @@ export declare namespace Whop {
     type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
     type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent,
     type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent,
+    type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent,
+    type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent,
+    type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent,
+    type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
 
@@ -1149,6 +1202,7 @@ export declare namespace Whop {
 
   export {
     ForumPosts as ForumPosts,
+    type ForumPostVisibilityType as ForumPostVisibilityType,
     type ForumPostListResponse as ForumPostListResponse,
     type ForumPostListResponsesCursorPage as ForumPostListResponsesCursorPage,
     type ForumPostCreateParams as ForumPostCreateParams,
@@ -1205,6 +1259,7 @@ export declare namespace Whop {
 
   export {
     CheckoutConfigurations as CheckoutConfigurations,
+    type CheckoutModes as CheckoutModes,
     type CheckoutConfigurationListResponse as CheckoutConfigurationListResponse,
     type CheckoutConfigurationListResponsesCursorPage as CheckoutConfigurationListResponsesCursorPage,
     type CheckoutConfigurationCreateParams as CheckoutConfigurationCreateParams,
@@ -1336,10 +1391,14 @@ export declare namespace Whop {
     type LessonVisibilities as LessonVisibilities,
     type CourseLessonListResponse as CourseLessonListResponse,
     type CourseLessonDeleteResponse as CourseLessonDeleteResponse,
+    type CourseLessonMarkAsCompletedResponse as CourseLessonMarkAsCompletedResponse,
+    type CourseLessonStartResponse as CourseLessonStartResponse,
+    type CourseLessonSubmitAssessmentResponse as CourseLessonSubmitAssessmentResponse,
     type CourseLessonListResponsesCursorPage as CourseLessonListResponsesCursorPage,
     type CourseLessonCreateParams as CourseLessonCreateParams,
     type CourseLessonUpdateParams as CourseLessonUpdateParams,
     type CourseLessonListParams as CourseLessonListParams,
+    type CourseLessonSubmitAssessmentParams as CourseLessonSubmitAssessmentParams,
   };
 
   export {
@@ -1371,6 +1430,40 @@ export declare namespace Whop {
     type NotificationCreateParams as NotificationCreateParams,
   };
 
+  export {
+    Disputes as Disputes,
+    type Dispute as Dispute,
+    type DisputeStatuses as DisputeStatuses,
+    type DisputeListResponse as DisputeListResponse,
+    type DisputeListResponsesCursorPage as DisputeListResponsesCursorPage,
+    type DisputeListParams as DisputeListParams,
+    type DisputeUpdateEvidenceParams as DisputeUpdateEvidenceParams,
+  };
+
+  export {
+    Refunds as Refunds,
+    type PaymentProvider as PaymentProvider,
+    type RefundReferenceStatus as RefundReferenceStatus,
+    type RefundReferenceType as RefundReferenceType,
+    type RefundStatus as RefundStatus,
+    type RefundRetrieveResponse as RefundRetrieveResponse,
+    type RefundListResponse as RefundListResponse,
+    type RefundListResponsesCursorPage as RefundListResponsesCursorPage,
+    type RefundListParams as RefundListParams,
+  };
+
+  export {
+    Withdrawals as Withdrawals,
+    type WithdrawalFeeTypes as WithdrawalFeeTypes,
+    type WithdrawalSpeeds as WithdrawalSpeeds,
+    type WithdrawalStatus as WithdrawalStatus,
+    type WithdrawalTypes as WithdrawalTypes,
+    type WithdrawalRetrieveResponse as WithdrawalRetrieveResponse,
+    type WithdrawalListResponse as WithdrawalListResponse,
+    type WithdrawalListResponsesCursorPage as WithdrawalListResponsesCursorPage,
+    type WithdrawalListParams as WithdrawalListParams,
+  };
+
   export type AccessLevel = API.AccessLevel;
   export type AccessPassType = API.AccessPassType;
   export type App = API.App;

package/src/resources/access-tokens.ts

@@ -6,15 +6,15 @@ import { RequestOptions } from '../internal/request-options';
 
 export class AccessTokens extends APIResource {
   /**
-   * Creates an access token for a user to access a specific resource. These access
-   * tokens are designed to be used with Whop's embedded components.
+   * Create a short-lived access token to authenticate API requests on behalf of a
+   * Company or User. This token should be used with Whop's web and mobile embedded
+   * components. You must provide either a company_id or a user_id argument, but not
+   * both.
    *
    * @example
    * ```ts
    * const accessToken = await client.accessTokens.create({
-   *   scoped_actions: ['string'],
-   *   target_resource_id: 'target_resource_id',
-   *   target_resource_type: 'company',
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
    * });
    * ```
    */
@@ -38,30 +38,57 @@ export interface AccessTokenCreateResponse {
   expires_at: string;
 }
 
-export interface AccessTokenCreateParams {
-  /**
-   * Array of desired scoped actions for the access token. This list must be a subset
-   * of the API keys's existing permissions. Otherwise, an error will be raised.
-   */
-  scoped_actions: Array<string>;
+export type AccessTokenCreateParams =
+  | AccessTokenCreateParams.CreateAccessTokenInputWithCompanyID
+  | AccessTokenCreateParams.CreateAccessTokenInputWithUserID;
 
-  /**
-   * The ID of the target resource (Company, User, etc.) for which the access token
-   * is being created.
-   */
-  target_resource_id: string;
+export declare namespace AccessTokenCreateParams {
+  export interface CreateAccessTokenInputWithCompanyID {
+    /**
+     * The ID of the Company to generate the token for. The API key must have
+     * permission to access this Company, such as the being the company the API key
+     * belongs to or a sub-merchant of it
+     */
+    company_id: string;
 
-  /**
-   * The type of the target resource (company, user, product, experience, etc.).
-   */
-  target_resource_type: 'company' | 'product' | 'experience' | 'app' | 'user';
+    /**
+     * The expiration timestamp for the access token. If not provided, a default
+     * expiration time of 1 hour will be used. The expiration can be set to a maximum
+     * of 3 hours from the current time.
+     */
+    expires_at?: string | null;
 
-  /**
-   * The expiration timestamp for the access token. If not provided, a default
-   * expiration time of 1 hour will be used. The expiration can be set to a maximum
-   * of 3 hours from the current time.
-   */
-  expires_at?: string | null;
+    /**
+     * Array of desired scoped actions for the access token. If sent as an empty array
+     * or not provided, all permissions from the API key making the request will be
+     * available on the token. If sending an explicit list, they must be a subset of
+     * the API keys's existing permissions. Otherwise, an error will be raised.
+     */
+    scoped_actions?: Array<string> | null;
+  }
+
+  export interface CreateAccessTokenInputWithUserID {
+    /**
+     * The ID of the User to generate the token for. The API key must have permission
+     * to access this User.
+     */
+    user_id: string;
+
+    /**
+     * The expiration timestamp for the access token. If not provided, a default
+     * expiration time of 1 hour will be used. The expiration can be set to a maximum
+     * of 3 hours from the current time.
+     */
+    expires_at?: string | null;
+
+    /**
+     * Array of desired scoped actions for the access token. If sent as an empty array
+     * or not provided, all permissions from the API key making the request will be
+     * available on the token. If sending an explicit list, they must be a subset of
+     * the API keys's existing permissions. Otherwise, an error will be raised.
+     */
+    scoped_actions?: Array<string> | null;
+  }
 }
 
 export declare namespace AccessTokens {

package/src/resources/apps.ts

@@ -88,6 +88,11 @@ export class Apps extends APIResource {
 
 export type AppListResponsesCursorPage = CursorPage<AppListResponse>;
 
+/**
+ * The type of end-user an app is built for
+ */
+export type AppType = 'b2b_app' | 'b2c_app' | 'company_app' | 'component';
+
 /**
  * An object representing an app
  */
@@ -97,6 +102,11 @@ export interface AppListResponse {
    */
   id: string;
 
+  /**
+   * The type of end-user an app is built for
+   */
+  app_type: AppType;
+
   /**
    * The base url of the app
    */
@@ -241,6 +251,11 @@ export interface AppUpdateParams {
    */
   app_store_description?: string | null;
 
+  /**
+   * The type of end-user an app is built for
+   */
+  app_type?: AppType | null;
+
   /**
    * The base production url of the app
    */
@@ -314,6 +329,11 @@ export namespace AppUpdateParams {
 }
 
 export interface AppListParams extends CursorPageParams {
+  /**
+   * The type of end-user an app is built for
+   */
+  app_type?: AppType | null;
+
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -369,6 +389,7 @@ export interface AppListParams extends CursorPageParams {
 
 export declare namespace Apps {
   export {
+    type AppType as AppType,
     type AppListResponse as AppListResponse,
     type AppListResponsesCursorPage as AppListResponsesCursorPage,
     type AppCreateParams as AppCreateParams,

package/src/resources/checkout-configurations.ts

@@ -18,6 +18,7 @@ export class CheckoutConfigurations extends APIResource {
    * - `plan:create`
    * - `access_pass:create`
    * - `access_pass:update`
+   * - `checkout_configuration:basic:read`
    *
    * @example
    * ```ts
@@ -66,6 +67,11 @@ export class CheckoutConfigurations extends APIResource {
 
 export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutConfigurationListResponse>;
 
+/**
+ * The different modes a checkout can be set to.
+ */
+export type CheckoutModes = 'payment' | 'setup';
+
 /**
  * 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.
@@ -91,12 +97,24 @@ export interface CheckoutConfigurationListResponse {
   /**
    * The metadata to use for the checkout configuration
    */
-  metadata: { [key: string]: unknown };
+  metadata: { [key: string]: unknown } | null;
+
+  /**
+   * The mode of the checkout session.
+   */
+  mode: CheckoutModes;
+
+  /**
+   * The explicit payment method configuration for the session, if any. This
+   * currently only works in 'setup' mode. Use the plan's
+   * payment_method_configuration for payment method.
+   */
+  payment_method_configuration: CheckoutConfigurationListResponse.PaymentMethodConfiguration | null;
 
   /**
    * The plan to use for the checkout configuration
    */
-  plan: CheckoutConfigurationListResponse.Plan;
+  plan: CheckoutConfigurationListResponse.Plan | null;
 
   /**
    * A URL you can send to customers to complete a checkout. It looks like
@@ -111,6 +129,34 @@ export interface CheckoutConfigurationListResponse {
 }
 
 export namespace CheckoutConfigurationListResponse {
+  /**
+   * The explicit payment method configuration for the session, if any. This
+   * currently only works in 'setup' mode. Use the plan's
+   * payment_method_configuration for payment method.
+   */
+  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 plan to use for the checkout configuration
    */
@@ -168,15 +214,16 @@ export namespace CheckoutConfigurationListResponse {
 }
 
 export type CheckoutConfigurationCreateParams =
-  | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputWithPlan
-  | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputWithPlanID;
+  | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputModePaymentWithPlan
+  | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputModePaymentWithPlanID
+  | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputModeSetup;
 
 export declare namespace CheckoutConfigurationCreateParams {
-  export interface CreateCheckoutSessionInputWithPlan {
+  export interface CreateCheckoutSessionInputModePaymentWithPlan {
     /**
      * Pass this object to create a new plan for this checkout configuration
      */
-    plan: CreateCheckoutSessionInputWithPlan.Plan;
+    plan: CreateCheckoutSessionInputModePaymentWithPlan.Plan;
 
     /**
      * The affiliate code to use for the checkout configuration
@@ -188,13 +235,22 @@ export declare namespace CheckoutConfigurationCreateParams {
      */
     metadata?: { [key: string]: unknown } | null;
 
+    mode?: 'payment';
+
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    payment_method_configuration?: CreateCheckoutSessionInputModePaymentWithPlan.PaymentMethodConfiguration | null;
+
     /**
      * The URL to redirect the user to after the checkout configuration is created
      */
     redirect_url?: string | null;
   }
 
-  export namespace CreateCheckoutSessionInputWithPlan {
+  export namespace CreateCheckoutSessionInputModePaymentWithPlan {
     /**
      * Pass this object to create a new plan for this checkout configuration
      */
@@ -205,14 +261,14 @@ export declare namespace CheckoutConfigurationCreateParams {
       company_id: string;
 
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The respective currency identifier for the plan.
        */
-      billing_period?: number | null;
+      currency: Shared.Currency;
 
       /**
-       * The available currencies on the platform
+       * The interval at which the plan charges (renewal plans).
        */
-      currency?: Shared.Currency | null;
+      billing_period?: number | null;
 
       /**
        * An array of custom field objects.
@@ -468,9 +524,37 @@ export declare namespace CheckoutConfigurationCreateParams {
         visibility?: Shared.Visibility | null;
       }
     }
+
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    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;
+    }
   }
 
-  export interface CreateCheckoutSessionInputWithPlanID {
+  export interface CreateCheckoutSessionInputModePaymentWithPlanID {
     /**
      * The ID of the plan to use for the checkout configuration
      */
@@ -486,11 +570,107 @@ export declare namespace CheckoutConfigurationCreateParams {
      */
     metadata?: { [key: string]: unknown } | null;
 
+    mode?: 'payment';
+
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    payment_method_configuration?: CreateCheckoutSessionInputModePaymentWithPlanID.PaymentMethodConfiguration | null;
+
+    /**
+     * The URL to redirect the user to after the checkout configuration is created
+     */
+    redirect_url?: string | null;
+  }
+
+  export namespace CreateCheckoutSessionInputModePaymentWithPlanID {
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    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;
+    }
+  }
+
+  export interface CreateCheckoutSessionInputModeSetup {
+    /**
+     * The ID of the company for which to generate the checkout configuration. Only
+     * required in setup mode.
+     */
+    company_id: string;
+
+    mode: 'setup';
+
+    /**
+     * The metadata to use for the checkout configuration
+     */
+    metadata?: { [key: string]: unknown } | null;
+
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    payment_method_configuration?: CreateCheckoutSessionInputModeSetup.PaymentMethodConfiguration | null;
+
     /**
      * The URL to redirect the user to after the checkout configuration is created
      */
     redirect_url?: string | null;
   }
+
+  export namespace CreateCheckoutSessionInputModeSetup {
+    /**
+     * This currently only works for configurations made in 'setup' mode. The explicit
+     * payment method configuration for the checkout session. If not provided, the
+     * platform or company's defaults will apply.
+     */
+    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;
+    }
+  }
 }
 
 export interface CheckoutConfigurationListParams extends CursorPageParams {
@@ -527,6 +707,7 @@ export interface CheckoutConfigurationListParams extends CursorPageParams {
 
 export declare namespace CheckoutConfigurations {
   export {
+    type CheckoutModes as CheckoutModes,
     type CheckoutConfigurationListResponse as CheckoutConfigurationListResponse,
     type CheckoutConfigurationListResponsesCursorPage as CheckoutConfigurationListResponsesCursorPage,
     type CheckoutConfigurationCreateParams as CheckoutConfigurationCreateParams,