@whop/sdk 0.0.2 → 0.0.4

package/src/resources/ledger-accounts.ts

@@ -36,7 +36,19 @@ export interface LedgerAccountRetrieveResponse {
   /**
    * The different statuses a LedgerAccountAudit can be
    */
-  ledger_account_audit_status: 'reserves_imposed' | 'requested_more_information' | null;
+  ledger_account_audit_status:
+    | 'pending'
+    | 'approved'
+    | 'reserves_imposed'
+    | 'suspended'
+    | 'ignored'
+    | 'rejected'
+    | 'requested_more_information'
+    | 'information_submitted'
+    | 'requested_tos_violation_correction'
+    | 'clawback_attempted'
+    | 'awaiting_sales_review'
+    | null;
 
   /**
    * The type of ledger account.

package/src/resources/members.ts

@@ -325,6 +325,11 @@ export interface MemberListParams extends CursorPageParams {
    * The statuses to filter the members by
    */
   statuses?: Array<Shared.MemberStatuses> | null;
+
+  /**
+   * The user IDs to filter the members by
+   */
+  user_ids?: Array<string> | null;
 }
 
 export declare namespace Members {

package/src/resources/memberships.ts

@@ -43,7 +43,7 @@ export class Memberships extends APIResource {
    * - `member:basic:read`
    */
   list(
-    query: MembershipListParams,
+    query: MembershipListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse> {
     return this._client.getAPIList('/memberships', CursorPage<MembershipListResponse>, { query, ...options });
@@ -169,6 +169,11 @@ export interface MembershipListResponse {
    */
   plan: MembershipListResponse.Plan;
 
+  /**
+   * The Product this Membership grants access to.
+   */
+  product: MembershipListResponse.Product;
+
   /**
    * The Promo Code that is currently applied to this Membership.
    */
@@ -238,6 +243,21 @@ export namespace MembershipListResponse {
     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.
    */
@@ -277,11 +297,6 @@ export interface MembershipUpdateParams {
 }
 
 export interface MembershipListParams extends CursorPageParams {
-  /**
-   * The ID of the company to list memberships for
-   */
-  company_id: string;
-
   /**
    * The access pass IDs to filter the memberships by
    */
@@ -305,6 +320,11 @@ export interface MembershipListParams extends CursorPageParams {
     | 'testing'
   > | null;
 
+  /**
+   * The ID of the company to list memberships for
+   */
+  company_id?: string | null;
+
   /**
    * The minimum creation date to filter by
    */
@@ -349,6 +369,11 @@ export interface MembershipListParams extends CursorPageParams {
    * The membership status to filter the memberships by
    */
   statuses?: Array<Shared.MembershipStatus> | null;
+
+  /**
+   * Only return memberships from these whop user ids
+   */
+  user_ids?: Array<string> | null;
 }
 
 export interface MembershipCancelParams {

package/src/resources/messages.ts

@@ -30,6 +30,17 @@ export class Messages extends APIResource {
     return this._client.get(path`/messages/${id}`, options);
   }
 
+  /**
+   * Updates an existing message
+   */
+  update(
+    id: string,
+    body: MessageUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.Message> {
+    return this._client.patch(path`/messages/${id}`, { body, ...options });
+  }
+
   /**
    * Lists messages inside a channel
    *
@@ -210,7 +221,9 @@ export interface MessageCreateParams {
   /**
    * The attachments for this message, such as videos or images.
    */
-  attachments?: Array<MessageCreateParams.Attachment> | null;
+  attachments?: Array<
+    MessageCreateParams.AttachmentInputWithDirectUploadID | MessageCreateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * The poll for this message
@@ -222,20 +235,25 @@ export namespace MessageCreateParams {
   /**
    * Input for an attachment
    */
-  export interface Attachment {
-    /**
-     * 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 | null;
-
+  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 | null;
+    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;
   }
 
   /**
@@ -266,6 +284,51 @@ export namespace MessageCreateParams {
   }
 }
 
+export interface MessageUpdateParams {
+  /**
+   * The attachments for this message
+   */
+  attachments?: Array<
+    MessageUpdateParams.AttachmentInputWithDirectUploadID | MessageUpdateParams.AttachmentInputWithID
+  > | null;
+
+  /**
+   * The content of the message in Markdown format
+   */
+  content?: string | null;
+
+  /**
+   * Whether this message is pinned
+   */
+  is_pinned?: boolean | null;
+}
+
+export namespace MessageUpdateParams {
+  /**
+   * 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;
+  }
+}
+
 export interface MessageListParams extends CursorPageParams {
   /**
    * The ID of the channel or the experience ID to list messages for
@@ -298,6 +361,7 @@ export declare namespace Messages {
     type MessageListResponse as MessageListResponse,
     type MessageListResponsesCursorPage as MessageListResponsesCursorPage,
     type MessageCreateParams as MessageCreateParams,
+    type MessageUpdateParams as MessageUpdateParams,
     type MessageListParams as MessageListParams,
   };
 }

package/src/resources/payments.ts

@@ -141,6 +141,128 @@ export class Payments extends APIResource {
 
 export type PaymentListResponsesCursorPage = CursorPage<PaymentListResponse>;
 
+/**
+ * The reason why a specific payment was billed
+ */
+export type BillingReasons =
+  | 'subscription_create'
+  | 'subscription_cycle'
+  | 'subscription_update'
+  | 'one_time'
+  | 'manual'
+  | 'subscription';
+
+/**
+ * Possible card brands that a payment token can have
+ */
+export type CardBrands =
+  | 'mastercard'
+  | 'visa'
+  | 'amex'
+  | 'discover'
+  | 'unionpay'
+  | 'jcb'
+  | 'diners'
+  | 'link'
+  | 'troy'
+  | 'visadankort'
+  | 'visabancontact'
+  | 'china_union_pay'
+  | 'rupay'
+  | 'jcbrupay'
+  | 'elo'
+  | 'unknown';
+
+/**
+ * The different types of payment methods that can be used.
+ */
+export type PaymentMethodTypes =
+  | 'acss_debit'
+  | 'affirm'
+  | 'afterpay_clearpay'
+  | 'alipay'
+  | 'alma'
+  | 'amazon_pay'
+  | 'apple_pay'
+  | 'au_becs_debit'
+  | 'bacs_debit'
+  | 'bancontact'
+  | 'billie'
+  | 'blik'
+  | 'boleto'
+  | 'card'
+  | 'cashapp'
+  | 'crypto'
+  | 'eps'
+  | 'fpx'
+  | 'giropay'
+  | 'google_pay'
+  | 'grabpay'
+  | 'ideal'
+  | 'kakao_pay'
+  | 'klarna'
+  | 'konbini'
+  | 'kr_card'
+  | 'link'
+  | 'mobilepay'
+  | 'multibanco'
+  | 'naver_pay'
+  | 'nz_bank_account'
+  | 'oxxo'
+  | 'p24'
+  | 'pay_by_bank'
+  | 'payco'
+  | 'paynow'
+  | 'pix'
+  | 'promptpay'
+  | 'revolut_pay'
+  | 'samsung_pay'
+  | 'satispay'
+  | 'sepa_debit'
+  | 'sofort'
+  | 'swish'
+  | 'twint'
+  | 'us_bank_account'
+  | 'wechat_pay'
+  | 'zip'
+  | 'bizum'
+  | 'capchase_pay'
+  | 'kriya'
+  | 'mondu'
+  | 'ng_wallet'
+  | 'paypay'
+  | 'sequra'
+  | 'scalapay'
+  | 'vipps'
+  | 'custom'
+  | 'customer_balance'
+  | 'gopay'
+  | 'mb_way'
+  | 'ng_bank'
+  | 'ng_bank_transfer'
+  | 'ng_card'
+  | 'ng_market'
+  | 'ng_ussd'
+  | 'paypal'
+  | 'payto'
+  | 'qris'
+  | 'rechnung'
+  | 'south_korea_market'
+  | 'kr_market'
+  | 'shopeepay'
+  | 'upi'
+  | 'sunbit'
+  | 'netbanking'
+  | 'id_bank_transfer'
+  | 'demo_pay'
+  | 'shop_pay'
+  | 'sezzle'
+  | 'coinbase'
+  | 'splitit'
+  | 'platform_balance'
+  | 'apple'
+  | 'unknown';
+
 /**
  * An object representing a receipt for a membership.
  */
@@ -166,14 +288,14 @@ export interface PaymentListResponse {
   billing_address: PaymentListResponse.BillingAddress | null;
 
   /**
-   * The billing reason
+   * The reason why a specific payment was billed
    */
-  billing_reason: string | null;
+  billing_reason: 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: CardBrands | null;
 
   /**
    * The last 4 digits of the card used to make the payment.
@@ -220,16 +342,21 @@ export interface PaymentListResponse {
    */
   membership: PaymentListResponse.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: PaymentMethodTypes | null;
 
   /**
    * The plan attached to this payment.
@@ -247,7 +374,8 @@ export interface PaymentListResponse {
   promo_code: PaymentListResponse.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;
 
@@ -262,7 +390,9 @@ export interface PaymentListResponse {
   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;
 
@@ -297,7 +427,8 @@ export interface PaymentListResponse {
   user: PaymentListResponse.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;
 }
@@ -448,7 +579,7 @@ export namespace PaymentListResponse {
     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;
 
@@ -498,14 +629,7 @@ export interface PaymentListParams extends CursorPageParams {
   /**
    * The billing reason for the payment
    */
-  billing_reasons?: Array<
-    | 'subscription_create'
-    | 'subscription_cycle'
-    | 'subscription_update'
-    | 'one_time'
-    | 'manual'
-    | 'subscription'
-  > | null;
+  billing_reasons?: Array<BillingReasons> | null;
 
   /**
    * The minimum creation date to filter by
@@ -577,6 +701,9 @@ export interface PaymentRefundParams {
 
 export declare namespace Payments {
   export {
+    type BillingReasons as BillingReasons,
+    type CardBrands as CardBrands,
+    type PaymentMethodTypes as PaymentMethodTypes,
     type PaymentListResponse as PaymentListResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,
     type PaymentListParams as PaymentListParams,