@whop/sdk 0.0.2 → 0.0.4

package/src/resources/reviews.ts

@@ -0,0 +1,348 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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 Reviews extends APIResource {
+  /**
+   * Retrieve a review by its ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ReviewRetrieveResponse> {
+    return this._client.get(path`/reviews/${id}`, options);
+  }
+
+  /**
+   * List all reviews
+   */
+  list(
+    query: ReviewListParams,
+    options?: RequestOptions,
+  ): PagePromise<ReviewListResponsesCursorPage, ReviewListResponse> {
+    return this._client.getAPIList('/reviews', CursorPage<ReviewListResponse>, { query, ...options });
+  }
+}
+
+export type ReviewListResponsesCursorPage = CursorPage<ReviewListResponse>;
+
+/**
+ * The statuses a review can have
+ */
+export type ReviewStatus = 'pending' | 'published' | 'removed';
+
+/**
+ * An object representing a user review of a company.
+ */
+export interface ReviewRetrieveResponse {
+  /**
+   * The internal ID of the review.
+   */
+  id: string;
+
+  /**
+   * The attachments attached to the review.
+   */
+  attachments: Array<ReviewRetrieveResponse.Attachment>;
+
+  /**
+   * The company the review is for.
+   */
+  company: ReviewRetrieveResponse.Company;
+
+  /**
+   * The timestamp of when the review was created.
+   */
+  created_at: string;
+
+  /**
+   * The description of the review.
+   */
+  description: string | null;
+
+  /**
+   * The timestamp of when the user joined the product.
+   */
+  joined_at: string | null;
+
+  /**
+   * Whether or not the user paid for the product. If null, the payment status is
+   * unknown.
+   */
+  paid_for_product: boolean | null;
+
+  /**
+   * The product the review is for.
+   */
+  product: ReviewRetrieveResponse.Product;
+
+  /**
+   * The timestamp of when the review was published.
+   */
+  published_at: string | null;
+
+  /**
+   * The number of stars the user gave the product.
+   */
+  stars: number;
+
+  /**
+   * The status of the review.
+   */
+  status: ReviewStatus;
+
+  /**
+   * The title of the review.
+   */
+  title: string | null;
+
+  /**
+   * The timestamp of when the review was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The user account that performed the action.
+   */
+  user: ReviewRetrieveResponse.User;
+}
+
+export namespace ReviewRetrieveResponse {
+  /**
+   * Represents an image attachment
+   */
+  export interface Attachment {
+    /**
+     * The ID of the attachment
+     */
+    id: string;
+
+    /**
+     * The attachment's content type (e.g., image/jpg, video/mp4)
+     */
+    content_type: string | null;
+
+    /**
+     * The name of the file
+     */
+    filename: string | null;
+
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
+  /**
+   * The company the review is for.
+   */
+  export interface Company {
+    /**
+     * The ID (tag) of the company.
+     */
+    id: string;
+
+    /**
+     * The slug/route of the company on the Whop site.
+     */
+    route: string;
+
+    /**
+     * The title of the company.
+     */
+    title: string;
+  }
+
+  /**
+   * The product the review is for.
+   */
+  export interface Product {
+    /**
+     * The internal ID of the public product.
+     */
+    id: string;
+
+    /**
+     * The title of the product. Use for Whop 4.0.
+     */
+    title: string;
+  }
+
+  /**
+   * The user account that performed the action.
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * 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 user review of a company.
+ */
+export interface ReviewListResponse {
+  /**
+   * The internal ID of the review.
+   */
+  id: string;
+
+  /**
+   * The attachments attached to the review.
+   */
+  attachments: Array<ReviewListResponse.Attachment>;
+
+  /**
+   * The timestamp of when the review was created.
+   */
+  created_at: string;
+
+  /**
+   * The description of the review.
+   */
+  description: string | null;
+
+  /**
+   * The timestamp of when the user joined the product.
+   */
+  joined_at: string | null;
+
+  /**
+   * Whether or not the user paid for the product. If null, the payment status is
+   * unknown.
+   */
+  paid_for_product: boolean | null;
+
+  /**
+   * The timestamp of when the review was published.
+   */
+  published_at: string | null;
+
+  /**
+   * The number of stars the user gave the product.
+   */
+  stars: number;
+
+  /**
+   * The status of the review.
+   */
+  status: ReviewStatus;
+
+  /**
+   * The title of the review.
+   */
+  title: string | null;
+
+  /**
+   * The timestamp of when the review was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The user account that performed the action.
+   */
+  user: ReviewListResponse.User;
+}
+
+export namespace ReviewListResponse {
+  /**
+   * Represents an image attachment
+   */
+  export interface Attachment {
+    /**
+     * The ID of the attachment
+     */
+    id: string;
+
+    /**
+     * The attachment's content type (e.g., image/jpg, video/mp4)
+     */
+    content_type: string | null;
+
+    /**
+     * The name of the file
+     */
+    filename: string | null;
+
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
+  /**
+   * The user account that performed the action.
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+export interface ReviewListParams extends CursorPageParams {
+  /**
+   * The ID of the product
+   */
+  product_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The maximum star rating of the review (inclusive)
+   */
+  max_stars?: number | null;
+
+  /**
+   * The minimum star rating of the review (inclusive)
+   */
+  min_stars?: number | null;
+}
+
+export declare namespace Reviews {
+  export {
+    type ReviewStatus as ReviewStatus,
+    type ReviewRetrieveResponse as ReviewRetrieveResponse,
+    type ReviewListResponse as ReviewListResponse,
+    type ReviewListResponsesCursorPage as ReviewListResponsesCursorPage,
+    type ReviewListParams as ReviewListParams,
+  };
+}

package/src/resources/shared.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Shared from './shared';
+import * as PaymentsAPI from './payments';
 import { CursorPage } from '../core/pagination';
 
 /**
@@ -444,7 +445,8 @@ export interface CheckoutConfiguration {
   plan: CheckoutConfiguration.Plan;
 
   /**
-   * The URL to redirect the user to after the checkout configuration is created
+   * A URL you can send to customers to complete a checkout. It looks like
+   * `/checkout/plan_xxxx?session={id}`
    */
   purchase_url: string;
 
@@ -555,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
    */
@@ -1256,6 +1264,11 @@ export interface ForumPost {
    */
   content: string | null;
 
+  /**
+   * The timestamp when the post was created
+   */
+  created_at: string;
+
   /**
    * Whether the forum post has been edited
    */
@@ -1286,6 +1299,11 @@ export interface ForumPost {
    */
   title: string | null;
 
+  /**
+   * The timestamp when the post was last updated
+   */
+  updated_at: string;
+
   /**
    * The user who created this forum post
    */
@@ -1439,7 +1457,8 @@ export interface Invoice {
   email_address: string | null;
 
   /**
-   * The token to fetch the invoice.
+   * A signed token that allows fetching the invoice data publically without being
+   * authenticated.
    */
   fetch_invoice_token: string;
 
@@ -1531,7 +1550,8 @@ export interface InvoiceListItem {
   email_address: string | null;
 
   /**
-   * The token to fetch the invoice.
+   * A signed token that allows fetching the invoice data publically without being
+   * authenticated.
    */
   fetch_invoice_token: string;
 
@@ -1694,6 +1714,11 @@ export interface Membership {
    */
   plan: Membership.Plan;
 
+  /**
+   * The Product this Membership grants access to.
+   */
+  product: Membership.Product;
+
   /**
    * The Promo Code that is currently applied to this Membership.
    */
@@ -1763,6 +1788,21 @@ export namespace Membership {
     id: string;
   }
 
+  /**
+   * The Product this Membership grants access to.
+   */
+  export interface Product {
+    /**
+     * The internal ID of the public product.
+     */
+    id: string;
+
+    /**
+     * The title of the product. Use for Whop 4.0.
+     */
+    title: string;
+  }
+
   /**
    * The Promo Code that is currently applied to this Membership.
    */
@@ -2006,14 +2046,14 @@ export interface Payment {
   billing_address: Payment.BillingAddress | null;
 
   /**
-   * The billing reason
+   * The reason why a specific payment was billed
    */
-  billing_reason: string | null;
+  billing_reason: PaymentsAPI.BillingReasons | null;
 
   /**
-   * The type of card used as the payment method.
+   * Possible card brands that a payment token can have
    */
-  card_brand: string | null;
+  card_brand: PaymentsAPI.CardBrands | null;
 
   /**
    * The last 4 digits of the card used to make the payment.
@@ -2060,16 +2100,21 @@ 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
    */
   paid_at: string | null;
 
   /**
-   * Returns the type of payment method used for the payment, if available. Ex.
-   * klarna, affirm, card, cashapp
+   * The different types of payment methods that can be used.
    */
-  payment_method_type: string | null;
+  payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
 
   /**
    * The plan attached to this payment.
@@ -2087,7 +2132,8 @@ export interface Payment {
   promo_code: Payment.PromoCode | null;
 
   /**
-   * Whether the payment can be refunded.
+   * True only for payments that are `paid`, have not been fully refunded, and were
+   * processed by a payment processor that allows refunds.
    */
   refundable: boolean;
 
@@ -2102,7 +2148,9 @@ export interface Payment {
   refunded_at: string | null;
 
   /**
-   * Whether the payment can be retried.
+   * True when the payment status is `open` and its membership is in one of the
+   * retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+   * otherwise false. Used to decide if Whop can attempt the charge again.
    */
   retryable: boolean;
 
@@ -2137,7 +2185,8 @@ export interface Payment {
   user: Payment.User | null;
 
   /**
-   * Whether the payment can be voided.
+   * True when the payment is tied to a membership in `past_due`, the payment status
+   * is `open`, and the processor allows voiding payments; otherwise false.
    */
   voidable: boolean;
 }
@@ -2288,7 +2337,7 @@ export namespace Payment {
     code: string | null;
 
     /**
-     * The number of billing cycles the promo is applied for.
+     * The number of months the promo is applied for.
      */
     number_of_intervals: number | null;
 
@@ -2393,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.
    */
@@ -2418,16 +2472,31 @@ export interface Plan {
    */
   renewal_price: number;
 
+  /**
+   * The number of units available for purchase. Only displayed to authorized actors
+   */
+  stock: number | null;
+
   /**
    * The tax type for the plan.
    */
   tax_type: TaxType;
 
+  /**
+   * The title of the plan. This will be visible on the product page to customers.
+   */
+  title: string | null;
+
   /**
    * The number of free trial days added before a renewal plan.
    */
   trial_period_days: number | null;
 
+  /**
+   * Limits/doesn't limit the number of units available for purchase.
+   */
+  unlimited_stock: boolean;
+
   /**
    * When the plan was last updated.
    */
@@ -2500,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.
    */
@@ -2565,6 +2660,13 @@ export interface Product {
    */
   description: string | null;
 
+  /**
+   * A unique identifier used to create or update products. When provided on product
+   * creation endpoints, we’ll look up an existing product by this identifier — if it
+   * exists, we’ll update it; if not, we’ll create a new one.
+   */
+  external_identifier: string | null;
+
   /**
    * The percentage of a transaction a user is eligible to earn from the whop
    * marketplace global affiliate program.
@@ -2724,6 +2826,13 @@ export interface ProductListItem {
    */
   created_at: string;
 
+  /**
+   * A unique identifier used to create or update products. When provided on product
+   * creation endpoints, we’ll look up an existing product by this identifier — if it
+   * exists, we’ll update it; if not, we’ll create a new one.
+   */
+  external_identifier: string | null;
+
   /**
    * The headline of the product.
    */
@@ -3130,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.2'; // 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.2";
+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.2";
+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.2'; // 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.2'; // x-release-please-version
+export const VERSION = '0.0.4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map