@whop/sdk 0.0.7 → 0.0.9

package/src/resources/forum-posts.ts

@@ -85,6 +85,11 @@ export class ForumPosts extends APIResource {
 
 export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>;
 
+/**
+ * The visibility types for forum posts
+ */
+export type ForumPostVisibilityType = 'members_only' | 'globally_visible';
+
 /**
  * Represents a post in forum
  */
@@ -238,7 +243,7 @@ export interface ForumPostCreateParams {
   /**
    * The visibility types for forum posts
    */
-  visibility?: 'members_only' | 'globally_visible' | null;
+  visibility?: ForumPostVisibilityType | null;
 }
 
 export namespace ForumPostCreateParams {
@@ -321,7 +326,7 @@ export interface ForumPostUpdateParams {
   /**
    * The visibility types for forum posts
    */
-  visibility?: 'members_only' | 'globally_visible' | null;
+  visibility?: ForumPostVisibilityType | null;
 }
 
 export namespace ForumPostUpdateParams {
@@ -384,6 +389,7 @@ export interface ForumPostListParams extends CursorPageParams {
 
 export declare namespace ForumPosts {
   export {
+    type ForumPostVisibilityType as ForumPostVisibilityType,
     type ForumPostListResponse as ForumPostListResponse,
     type ForumPostListResponsesCursorPage as ForumPostListResponsesCursorPage,
     type ForumPostCreateParams as ForumPostCreateParams,

package/src/resources/index.ts

@@ -2,6 +2,7 @@
 
 export * from './shared';
 export { AccessTokens, type AccessTokenCreateResponse, type AccessTokenCreateParams } from './access-tokens';
+export { AccountLinks, type AccountLinkCreateResponse, type AccountLinkCreateParams } from './account-links';
 export {
   AppBuilds,
   type AppBuildListResponse,
@@ -11,6 +12,7 @@ export {
 } from './app-builds';
 export {
   Apps,
+  type AppType,
   type AppListResponse,
   type AppCreateParams,
   type AppUpdateParams,
@@ -33,6 +35,7 @@ export {
 } from './chat-channels';
 export {
   CheckoutConfigurations,
+  type CheckoutModes,
   type CheckoutConfigurationListResponse,
   type CheckoutConfigurationCreateParams,
   type CheckoutConfigurationListParams,
@@ -68,9 +71,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 +129,7 @@ export {
 } from './experiences';
 export {
   ForumPosts,
+  type ForumPostVisibilityType,
   type ForumPostListResponse,
   type ForumPostCreateParams,
   type ForumPostUpdateParams,
@@ -215,6 +223,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 +287,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/invoices.ts

@@ -783,6 +783,16 @@ export interface InvoiceListParams extends CursorPageParams {
    */
   collection_methods?: Array<Shared.CollectionMethod> | null;
 
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_before?: string | null;
+
   /**
    * The direction of the sort.
    */

package/src/resources/payments.ts

@@ -262,6 +262,7 @@ export type PaymentMethodTypes =
   | 'splitit'
   | 'platform_balance'
   | 'apple'
+  | 'venmo'
   | 'unknown';
 
 /**

package/src/resources/plans.ts

@@ -344,7 +344,7 @@ export interface PlanCreateParams {
   description?: string | null;
 
   /**
-   * The interval at which the plan charges (expiration plans).
+   * The interval at which the plan expires and revokes access (expiration plans).
    */
   expiration_days?: number | null;
 
@@ -398,18 +398,6 @@ export interface PlanCreateParams {
    */
   stock?: number | null;
 
-  /**
-   * The price to display with a strikethrough for the initial price. Provided as a
-   * number in dollars. Eg: 19.99 for $19.99
-   */
-  strike_through_initial_price?: number | null;
-
-  /**
-   * The price to display with a strikethrough for the renewal price. Provided as a
-   * number in dollars. Eg: 19.99 for $19.99
-   */
-  strike_through_renewal_price?: number | null;
-
   /**
    * The title of the plan. This will be visible on the product page to customers.
    */
@@ -713,6 +701,16 @@ export interface PlanListParams extends CursorPageParams {
    */
   before?: string | null;
 
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_before?: string | null;
+
   /**
    * The direction of the sort.
    */

package/src/resources/products.ts

@@ -330,14 +330,6 @@ export namespace ProductCreateParams {
 }
 
 export interface ProductUpdateParams {
-  /**
-   * A banner image for the product in png, jpeg format
-   */
-  banner_image?:
-    | ProductUpdateParams.AttachmentInputWithDirectUploadID
-    | ProductUpdateParams.AttachmentInputWithID
-    | null;
-
   /**
    * The different business types a company can be.
    */
@@ -432,30 +424,6 @@ export interface ProductUpdateParams {
 }
 
 export namespace ProductUpdateParams {
-  /**
-   * 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 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;
-  }
-
   /**
    * Configuration for a product on the company's store page.
    */
@@ -483,6 +451,16 @@ export interface ProductListParams extends CursorPageParams {
    */
   before?: string | null;
 
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_before?: string | null;
+
   /**
    * The direction of the sort.
    */

package/src/resources/promo-codes.ts

@@ -450,6 +450,16 @@ export interface PromoCodeListParams extends CursorPageParams {
    */
   before?: string | null;
 
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_before?: string | null;
+
   /**
    * Returns the first _n_ elements from the list.
    */

package/src/resources/refunds.ts

@@ -0,0 +1,393 @@
+// 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 minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_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/reviews.ts

@@ -316,6 +316,16 @@ export interface ReviewListParams extends CursorPageParams {
    */
   before?: string | null;
 
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_before?: string | null;
+
   /**
    * Returns the first _n_ elements from the list.
    */