@whop/sdk 0.0.1-canary.0 → 0.0.3

package/src/resources/members.ts

@@ -0,0 +1,342 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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 Members extends APIResource {
+  /**
+   * Retrieves a member of a company by ID
+   *
+   * Required permissions:
+   *
+   * - `member:basic:read`
+   * - `member:email:read`
+   * - `member:phone:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<MemberRetrieveResponse> {
+    return this._client.get(path`/members/${id}`, options);
+  }
+
+  /**
+   * List the members of a company
+   *
+   * Required permissions:
+   *
+   * - `member:basic:read`
+   * - `member:email:read`
+   * - `member:phone:read`
+   */
+  list(
+    query: MemberListParams,
+    options?: RequestOptions,
+  ): PagePromise<MemberListResponsesCursorPage, MemberListResponse> {
+    return this._client.getAPIList('/members', CursorPage<MemberListResponse>, { query, ...options });
+  }
+}
+
+export type MemberListResponsesCursorPage = CursorPage<MemberListResponse>;
+
+/**
+ * An object representing a connection between a creator and a user/company_buyer.
+ * This type should only be made visible to the user/company_buyer who is a part of
+ * the connection.
+ */
+export interface MemberRetrieveResponse {
+  /**
+   * The ID of the member
+   */
+  id: string;
+
+  /**
+   * The access level of the product member. If its admin, the member is an
+   * authorized user of the access pass. If its customer, the member has a valid
+   * membership to the access pass. If its no_access, the member does not have access
+   * to the access pass.
+   */
+  access_level: Shared.AccessLevel;
+
+  /**
+   * The company for the member.
+   */
+  company: MemberRetrieveResponse.Company;
+
+  /**
+   * When the member was created
+   */
+  created_at: string;
+
+  /**
+   * When the member joined the company
+   */
+  joined_at: string;
+
+  /**
+   * The different most recent actions a member can have.
+   */
+  most_recent_action: Shared.MemberMostRecentActions | null;
+
+  /**
+   * The time for the most recent action, if applicable.
+   */
+  most_recent_action_at: string | null;
+
+  /**
+   * The phone number for the member, if available.
+   */
+  phone: string | null;
+
+  /**
+   * The status of the member
+   */
+  status: Shared.MemberStatuses;
+
+  /**
+   * The timestamp of when this member was last updated
+   */
+  updated_at: string;
+
+  /**
+   * How much money this customer has spent on the company's products and plans
+   */
+  usd_total_spent: number;
+
+  /**
+   * The user for this member, if any.
+   */
+  user: MemberRetrieveResponse.User | null;
+}
+
+export namespace MemberRetrieveResponse {
+  /**
+   * The company for the member.
+   */
+  export interface Company {
+    /**
+     * The ID of the company
+     */
+    id: string;
+
+    /**
+     * The slug/route of the company on the Whop site.
+     */
+    route: string;
+
+    /**
+     * The written name of the company.
+     */
+    title: string;
+  }
+
+  /**
+   * The user for this member, if any.
+   */
+  export interface User {
+    /**
+     * The internal ID of the user account.
+     */
+    id: string;
+
+    /**
+     * The digital mailing address of the user.
+     */
+    email: string | null;
+
+    /**
+     * The user's full name.
+     */
+    name: string | null;
+
+    /**
+     * The whop username.
+     */
+    username: string;
+  }
+}
+
+/**
+ * An object representing a connection between a creator and a user/company_buyer.
+ * This type should only be made visible to the user/company_buyer who is a part of
+ * the connection.
+ */
+export interface MemberListResponse {
+  /**
+   * The ID of the member
+   */
+  id: string;
+
+  /**
+   * The access level of the product member. If its admin, the member is an
+   * authorized user of the access pass. If its customer, the member has a valid
+   * membership to the access pass. If its no_access, the member does not have access
+   * to the access pass.
+   */
+  access_level: Shared.AccessLevel;
+
+  /**
+   * When the member was created
+   */
+  created_at: string;
+
+  /**
+   * When the member joined the company
+   */
+  joined_at: string;
+
+  /**
+   * The different most recent actions a member can have.
+   */
+  most_recent_action: Shared.MemberMostRecentActions | null;
+
+  /**
+   * The time for the most recent action, if applicable.
+   */
+  most_recent_action_at: string | null;
+
+  /**
+   * The phone number for the member, if available.
+   */
+  phone: string | null;
+
+  /**
+   * The status of the member
+   */
+  status: Shared.MemberStatuses;
+
+  /**
+   * The timestamp of when this member was last updated
+   */
+  updated_at: string;
+
+  /**
+   * How much money this customer has spent on the company's products and plans
+   */
+  usd_total_spent: number;
+
+  /**
+   * The user for this member, if any.
+   */
+  user: MemberListResponse.User | null;
+}
+
+export namespace MemberListResponse {
+  /**
+   * The user for this member, if any.
+   */
+  export interface User {
+    /**
+     * The internal ID of the user account.
+     */
+    id: string;
+
+    /**
+     * The digital mailing address of the user.
+     */
+    email: string | null;
+
+    /**
+     * The user's full name.
+     */
+    name: string | null;
+
+    /**
+     * The whop username.
+     */
+    username: string;
+  }
+}
+
+export interface MemberListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list members for
+   */
+  company_id: string;
+
+  /**
+   * The access level a given user (or company) has to an access pass or company.
+   */
+  access_level?: Shared.AccessLevel | null;
+
+  /**
+   * The access pass IDs to filter the members by
+   */
+  access_pass_ids?: Array<string> | null;
+
+  /**
+   * 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;
+
+  /**
+   * The most recent actions to filter the members by
+   */
+  most_recent_actions?: Array<Shared.MemberMostRecentActions> | null;
+
+  /**
+   * Which columns can be used to sort.
+   */
+  order?: 'id' | 'usd_total_spent' | 'created_at' | 'joined_at' | 'most_recent_action' | null;
+
+  /**
+   * The plan IDs to filter the members by
+   */
+  plan_ids?: Array<string> | null;
+
+  /**
+   * The promo code IDs to filter the members by
+   */
+  promo_code_ids?: Array<string> | null;
+
+  /**
+   * The name, username, or email to filter the members by. The email filter will
+   * only apply if the current actor has the `member:email:read` permission.
+   */
+  query?: string | null;
+
+  /**
+   * 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 {
+  export {
+    type MemberRetrieveResponse as MemberRetrieveResponse,
+    type MemberListResponse as MemberListResponse,
+    type MemberListResponsesCursorPage as MemberListResponsesCursorPage,
+    type MemberListParams as MemberListParams,
+  };
+}

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
    *
@@ -266,6 +277,44 @@ export namespace MessageCreateParams {
   }
 }
 
+export interface MessageUpdateParams {
+  /**
+   * The attachments for this message
+   */
+  attachments?: Array<MessageUpdateParams.Attachment> | 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 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;
+
+    /**
+     * 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;
+  }
+}
+
 export interface MessageListParams extends CursorPageParams {
   /**
    * The ID of the channel or the experience ID to list messages for
@@ -298,6 +347,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,127 @@ 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'
+  | 'apple'
+  | 'sezzle'
+  | 'coinbase'
+  | 'splitit'
+  | 'unknown';
+
 /**
  * An object representing a receipt for a membership.
  */
@@ -166,14 +287,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.
@@ -226,10 +347,9 @@ export interface PaymentListResponse {
   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 +367,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 +383,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 +420,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 +572,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 +622,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 +694,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,