@whop/sdk 0.0.7 → 0.0.8

package/src/resources/index.ts

@@ -11,6 +11,7 @@ export {
 } from './app-builds';
 export {
   Apps,
+  type AppType,
   type AppListResponse,
   type AppCreateParams,
   type AppUpdateParams,
@@ -33,6 +34,7 @@ export {
 } from './chat-channels';
 export {
   CheckoutConfigurations,
+  type CheckoutModes,
   type CheckoutConfigurationListResponse,
   type CheckoutConfigurationCreateParams,
   type CheckoutConfigurationListParams,
@@ -68,9 +70,13 @@ export {
   type LessonVisibilities,
   type CourseLessonListResponse,
   type CourseLessonDeleteResponse,
+  type CourseLessonMarkAsCompletedResponse,
+  type CourseLessonStartResponse,
+  type CourseLessonSubmitAssessmentResponse,
   type CourseLessonCreateParams,
   type CourseLessonUpdateParams,
   type CourseLessonListParams,
+  type CourseLessonSubmitAssessmentParams,
   type CourseLessonListResponsesCursorPage,
 } from './course-lessons';
 export {
@@ -122,6 +128,7 @@ export {
 } from './experiences';
 export {
   ForumPosts,
+  type ForumPostVisibilityType,
   type ForumPostListResponse,
   type ForumPostCreateParams,
   type ForumPostUpdateParams,
@@ -215,6 +222,17 @@ export {
   type ReactionListParams,
   type ReactionListResponsesCursorPage,
 } from './reactions';
+export {
+  Refunds,
+  type PaymentProvider,
+  type RefundReferenceStatus,
+  type RefundReferenceType,
+  type RefundStatus,
+  type RefundRetrieveResponse,
+  type RefundListResponse,
+  type RefundListParams,
+  type RefundListResponsesCursorPage,
+} from './refunds';
 export {
   Reviews,
   type ReviewStatus,
@@ -268,5 +286,18 @@ export {
   type PaymentPendingWebhookEvent,
   type DisputeCreatedWebhookEvent,
   type DisputeUpdatedWebhookEvent,
+  type RefundCreatedWebhookEvent,
+  type RefundUpdatedWebhookEvent,
   type UnwrapWebhookEvent,
 } from './webhooks';
+export {
+  Withdrawals,
+  type WithdrawalFeeTypes,
+  type WithdrawalSpeeds,
+  type WithdrawalStatus,
+  type WithdrawalTypes,
+  type WithdrawalRetrieveResponse,
+  type WithdrawalListResponse,
+  type WithdrawalListParams,
+  type WithdrawalListResponsesCursorPage,
+} from './withdrawals';

package/src/resources/refunds.ts

@@ -0,0 +1,383 @@
+// 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';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Refunds extends APIResource {
+  /**
+   * Retrieves a Refund by ID
+   *
+   * Required permissions:
+   *
+   * - `payment:basic:read`
+   * - `member:email:read`
+   * - `member:basic:read`
+   * - `member:phone:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<RefundRetrieveResponse> {
+    return this._client.get(path`/refunds/${id}`, options);
+  }
+
+  /**
+   * Lists Refunds for a payment.
+   *
+   * Required permissions:
+   *
+   * - `payment:basic:read`
+   */
+  list(
+    query: RefundListParams,
+    options?: RequestOptions,
+  ): PagePromise<RefundListResponsesCursorPage, RefundListResponse> {
+    return this._client.getAPIList('/refunds', CursorPage<RefundListResponse>, { query, ...options });
+  }
+}
+
+export type RefundListResponsesCursorPage = CursorPage<RefundListResponse>;
+
+/**
+ * The different payment providers.
+ */
+export type PaymentProvider =
+  | 'stripe'
+  | 'coinbase'
+  | 'paypal'
+  | 'apple'
+  | 'sezzle'
+  | 'splitit'
+  | 'platform_balance'
+  | 'multi_psp';
+
+/**
+ * The status of the refund reference.
+ */
+export type RefundReferenceStatus = 'available' | 'pending' | 'unavailable';
+
+/**
+ * The type of refund reference that was made available by the payment provider.
+ */
+export type RefundReferenceType =
+  | 'acquirer_reference_number'
+  | 'retrieval_reference_number'
+  | 'system_trace_audit_number';
+
+/**
+ * The different statuses for a Refund object
+ */
+export type RefundStatus = 'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled';
+
+/**
+ * An object representing a refund made on a payment.
+ */
+export interface RefundRetrieveResponse {
+  /**
+   * The ID of the refund.
+   */
+  id: string;
+
+  /**
+   * The amount of the refund.
+   */
+  amount: number;
+
+  /**
+   * The time the refund was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency of the refund.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The payment associated with the refund.
+   */
+  payment: RefundRetrieveResponse.Payment | null;
+
+  /**
+   * The provider of the refund.
+   */
+  provider: PaymentProvider;
+
+  /**
+   * The time the refund was created by the provider.
+   */
+  provider_created_at: string | null;
+
+  /**
+   * The status of the refund reference.
+   */
+  reference_status: RefundReferenceStatus | null;
+
+  /**
+   * The type of refund reference that was made available by the payment provider.
+   */
+  reference_type: RefundReferenceType | null;
+
+  /**
+   * The value of the reference.
+   */
+  reference_value: string | null;
+
+  /**
+   * The status of the refund.
+   */
+  status: RefundStatus;
+}
+
+export namespace RefundRetrieveResponse {
+  /**
+   * The payment associated with the refund.
+   */
+  export interface Payment {
+    /**
+     * The payment ID
+     */
+    id: string;
+
+    /**
+     * The reason why a specific payment was billed
+     */
+    billing_reason: PaymentsAPI.BillingReasons | null;
+
+    /**
+     * Possible card brands that a payment token can have
+     */
+    card_brand: PaymentsAPI.CardBrands | null;
+
+    /**
+     * The last 4 digits of the card used to make the payment.
+     */
+    card_last4: string | null;
+
+    /**
+     * The datetime the payment was created
+     */
+    created_at: string;
+
+    /**
+     * The available currencies on the platform
+     */
+    currency: Shared.Currency | null;
+
+    /**
+     * When an alert came in that this transaction will be disputed
+     */
+    dispute_alerted_at: string | null;
+
+    /**
+     * The member attached to this payment.
+     */
+    member: Payment.Member | null;
+
+    /**
+     * The membership attached to this payment.
+     */
+    membership: Payment.Membership | null;
+
+    /**
+     * The datetime the payment was paid
+     */
+    paid_at: string | null;
+
+    /**
+     * The different types of payment methods that can be used.
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
+
+    /**
+     * The subtotal to show to the creator (excluding buyer fees).
+     */
+    subtotal: number | null;
+
+    /**
+     * The total to show to the creator (excluding buyer fees).
+     */
+    total: number | null;
+
+    /**
+     * The total in USD to show to the creator (excluding buyer fees).
+     */
+    usd_total: number | null;
+
+    /**
+     * The user that made this payment.
+     */
+    user: Payment.User | null;
+  }
+
+  export namespace Payment {
+    /**
+     * The member attached to this payment.
+     */
+    export interface Member {
+      /**
+       * The ID of the member
+       */
+      id: string;
+
+      /**
+       * The phone number for the member, if available.
+       */
+      phone: string | null;
+    }
+
+    /**
+     * The membership attached to this payment.
+     */
+    export interface Membership {
+      /**
+       * The internal ID of the membership.
+       */
+      id: string;
+
+      /**
+       * The state of the membership.
+       */
+      status: Shared.MembershipStatus;
+    }
+
+    /**
+     * The user that made this payment.
+     */
+    export interface User {
+      /**
+       * The internal ID of the user.
+       */
+      id: string;
+
+      /**
+       * The email of the user
+       */
+      email: string | null;
+
+      /**
+       * The name of the user from their Whop account.
+       */
+      name: string | null;
+
+      /**
+       * The username of the user from their Whop account.
+       */
+      username: string;
+    }
+  }
+}
+
+/**
+ * An object representing a refund made on a payment.
+ */
+export interface RefundListResponse {
+  /**
+   * The ID of the refund.
+   */
+  id: string;
+
+  /**
+   * The amount of the refund.
+   */
+  amount: number;
+
+  /**
+   * The time the refund was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency of the refund.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The payment associated with the refund.
+   */
+  payment: RefundListResponse.Payment | null;
+
+  /**
+   * The provider of the refund.
+   */
+  provider: PaymentProvider;
+
+  /**
+   * The time the refund was created by the provider.
+   */
+  provider_created_at: string | null;
+
+  /**
+   * The status of the refund reference.
+   */
+  reference_status: RefundReferenceStatus | null;
+
+  /**
+   * The type of refund reference that was made available by the payment provider.
+   */
+  reference_type: RefundReferenceType | null;
+
+  /**
+   * The value of the reference.
+   */
+  reference_value: string | null;
+
+  /**
+   * The status of the refund.
+   */
+  status: RefundStatus;
+}
+
+export namespace RefundListResponse {
+  /**
+   * The payment associated with the refund.
+   */
+  export interface Payment {
+    /**
+     * The payment ID
+     */
+    id: string;
+  }
+}
+
+export interface RefundListParams extends CursorPageParams {
+  /**
+   * The ID of the payment to list refunds for
+   */
+  payment_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+}
+
+export declare namespace Refunds {
+  export {
+    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,
+  };
+}

package/src/resources/shared.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Shared from './shared';
+import * as AppsAPI from './apps';
+import * as CheckoutConfigurationsAPI from './checkout-configurations';
 import * as PaymentsAPI from './payments';
 import { CursorPage } from '../core/pagination';
 
@@ -29,6 +31,11 @@ export interface App {
    */
   api_key: App.APIKey | null;
 
+  /**
+   * The type of end-user an app is built for
+   */
+  app_type: AppsAPI.AppType;
+
   /**
    * The base url of the app
    */
@@ -438,12 +445,24 @@ export interface CheckoutConfiguration {
   /**
    * The metadata to use for the checkout configuration
    */
-  metadata: { [key: string]: unknown };
+  metadata: { [key: string]: unknown } | null;
+
+  /**
+   * The mode of the checkout session.
+   */
+  mode: CheckoutConfigurationsAPI.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: CheckoutConfiguration.PaymentMethodConfiguration | null;
 
   /**
    * The plan to use for the checkout configuration
    */
-  plan: CheckoutConfiguration.Plan;
+  plan: CheckoutConfiguration.Plan | null;
 
   /**
    * A URL you can send to customers to complete a checkout. It looks like
@@ -458,6 +477,34 @@ export interface CheckoutConfiguration {
 }
 
 export namespace CheckoutConfiguration {
+  /**
+   * 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
    */