@whop/sdk 0.0.25 → 0.0.27

package/src/resources/dm-members.ts

@@ -22,7 +22,7 @@ export class DmMembers extends APIResource {
    * });
    * ```
    */
-  create(body: DmMemberCreateParams, options?: RequestOptions): APIPromise<DmMemberCreateResponse> {
+  create(body: DmMemberCreateParams, options?: RequestOptions): APIPromise<DmMember> {
     return this._client.post('/dm_members', { body, ...options });
   }
 
@@ -38,7 +38,7 @@ export class DmMembers extends APIResource {
    * const dmMember = await client.dmMembers.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<DmMemberRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<DmMember> {
     return this._client.get(path`/dm_members/${id}`, options);
   }
 
@@ -58,7 +58,7 @@ export class DmMembers extends APIResource {
     id: string,
     body: DmMemberUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DmMemberUpdateResponse> {
+  ): APIPromise<DmMember> {
     return this._client.patch(path`/dm_members/${id}`, { body, ...options });
   }
 
@@ -106,81 +106,19 @@ export class DmMembers extends APIResource {
 export type DmMemberListResponsesCursorPage = CursorPage<DmMemberListResponse>;
 
 /**
- * Represents a member of a DM channel
+ * The notification preferences for a DMs feed member
  */
-export interface DmMemberCreateResponse {
-  /**
-   * The unique identifier for the entity
-   */
-  id: string;
-
-  /**
-   * The ID of the DM channel
-   */
-  channel_id: string;
-
-  /**
-   * Timestamp when the member last viewed the channel (in milliseconds since Unix
-   * epoch)
-   */
-  last_viewed_at: string | null;
-
-  /**
-   * The notification preference for this member (all, mentions, none)
-   */
-  notification_preference: 'all' | 'mentions' | 'none';
-
-  /**
-   * The status of the membership (requested, accepted, rejected)
-   */
-  status: 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
-
-  /**
-   * The ID of the user who is a member of the channel
-   */
-  user_id: string;
-}
+export type DmFeedMemberNotificationPreferences = 'all' | 'mentions' | 'none';
 
 /**
- * Represents a member of a DM channel
+ * The statuses of a DMs feed member
  */
-export interface DmMemberRetrieveResponse {
-  /**
-   * The unique identifier for the entity
-   */
-  id: string;
-
-  /**
-   * The ID of the DM channel
-   */
-  channel_id: string;
-
-  /**
-   * Timestamp when the member last viewed the channel (in milliseconds since Unix
-   * epoch)
-   */
-  last_viewed_at: string | null;
-
-  /**
-   * The notification preference for this member (all, mentions, none)
-   */
-  notification_preference: 'all' | 'mentions' | 'none';
-
-  /**
-   * The status of the membership (requested, accepted, rejected)
-   */
-  status: 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
-
-  /**
-   * The ID of the user who is a member of the channel
-   */
-  user_id: string;
-}
+export type DmFeedMemberStatuses = 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
 
 /**
  * Represents a member of a DM channel
  */
-export interface DmMemberUpdateResponse {
+export interface DmMember {
   /**
    * The unique identifier for the entity
    */
@@ -200,12 +138,12 @@ export interface DmMemberUpdateResponse {
   /**
    * The notification preference for this member (all, mentions, none)
    */
-  notification_preference: 'all' | 'mentions' | 'none';
+  notification_preference: DmFeedMemberNotificationPreferences;
 
   /**
    * The status of the membership (requested, accepted, rejected)
    */
-  status: 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
+  status: DmFeedMemberStatuses;
 
   /**
    * The ID of the user who is a member of the channel
@@ -236,7 +174,7 @@ export interface DmMemberListResponse {
   /**
    * The status of the membership (requested, accepted, rejected)
    */
-  status: 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
+  status: DmFeedMemberStatuses;
 
   /**
    * The ID of the user who is a member of the channel
@@ -265,12 +203,12 @@ export interface DmMemberUpdateParams {
   /**
    * The notification preferences for a DMs feed member
    */
-  notification_preference?: 'all' | 'mentions' | 'none' | null;
+  notification_preference?: DmFeedMemberNotificationPreferences | null;
 
   /**
    * The statuses of a DMs feed member
    */
-  status?: 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived' | null;
+  status?: DmFeedMemberStatuses | null;
 }
 
 export interface DmMemberListParams extends CursorPageParams {
@@ -297,9 +235,9 @@ export interface DmMemberListParams extends CursorPageParams {
 
 export declare namespace DmMembers {
   export {
-    type DmMemberCreateResponse as DmMemberCreateResponse,
-    type DmMemberRetrieveResponse as DmMemberRetrieveResponse,
-    type DmMemberUpdateResponse as DmMemberUpdateResponse,
+    type DmFeedMemberNotificationPreferences as DmFeedMemberNotificationPreferences,
+    type DmFeedMemberStatuses as DmFeedMemberStatuses,
+    type DmMember as DmMember,
     type DmMemberListResponse as DmMemberListResponse,
     type DmMemberDeleteResponse as DmMemberDeleteResponse,
     type DmMemberListResponsesCursorPage as DmMemberListResponsesCursorPage,

package/src/resources/entries.ts

@@ -63,16 +63,16 @@ export class Entries extends APIResource {
 export type EntryListResponsesCursorPage = CursorPage<EntryListResponse>;
 
 /**
- * An object representing an entry in a waitlist.
+ * An entry represents a user's signup for a waitlisted plan.
  */
 export interface EntryListResponse {
   /**
-   * The internal ID of the entry.
+   * The unique identifier for the entry.
    */
   id: string;
 
   /**
-   * When the entry was created.
+   * The datetime the entry was created.
    */
   created_at: string | null;
 
@@ -103,7 +103,7 @@ export namespace EntryListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -113,7 +113,7 @@ export namespace EntryListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -128,7 +128,7 @@ export namespace EntryListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/experiences.ts

@@ -170,11 +170,12 @@ export class Experiences extends APIResource {
 export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListResponse>;
 
 /**
- * An object representing an experience belonging to a company.
+ * An experience is a feature or content module within a product, such as a chat,
+ * course, or app.
  */
 export interface ExperienceListResponse {
   /**
-   * The unique ID representing this experience
+   * The unique identifier for the experience.
    */
   id: string;
 
@@ -189,7 +190,7 @@ export interface ExperienceListResponse {
   company: ExperienceListResponse.Company;
 
   /**
-   * The timestamp of when this experience was created.
+   * The datetime the experience was created.
    */
   created_at: string;
 
@@ -220,7 +221,7 @@ export namespace ExperienceListResponse {
    */
   export interface App {
     /**
-     * The ID of the app
+     * The unique identifier for the app.
      */
     id: string;
 
@@ -255,7 +256,7 @@ export namespace ExperienceListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 

package/src/resources/fee-markups.ts

@@ -84,12 +84,12 @@ export type FeeMarkupType =
  */
 export interface FeeMarkupCreateResponse {
   /**
-   * The unique identifier of the fee markup.
+   * The unique identifier for the fee markup.
    */
   id: string;
 
   /**
-   * When this fee markup was created.
+   * The datetime the fee markup was created.
    */
   created_at: string;
 
@@ -114,7 +114,7 @@ export interface FeeMarkupCreateResponse {
   percentage_fee: number | null;
 
   /**
-   * When this fee markup was last updated.
+   * The datetime the fee markup was last updated.
    */
   updated_at: string;
 }
@@ -124,12 +124,12 @@ export interface FeeMarkupCreateResponse {
  */
 export interface FeeMarkupListResponse {
   /**
-   * The unique identifier of the fee markup.
+   * The unique identifier for the fee markup.
    */
   id: string;
 
   /**
-   * When this fee markup was created.
+   * The datetime the fee markup was created.
    */
   created_at: string;
 
@@ -154,7 +154,7 @@ export interface FeeMarkupListResponse {
   percentage_fee: number | null;
 
   /**
-   * When this fee markup was last updated.
+   * The datetime the fee markup was last updated.
    */
   updated_at: string;
 }

package/src/resources/files.ts

@@ -36,12 +36,17 @@ export class Files extends APIResource {
   }
 }
 
+/**
+ * The upload status of a file
+ */
+export type UploadStatus = 'pending' | 'processing' | 'ready' | 'failed';
+
 /**
  * A file that has been uploaded or is pending upload
  */
 export interface FileCreateResponse {
   /**
-   * The ID of the file
+   * The unique identifier for the file.
    */
   id: string;
 
@@ -68,7 +73,7 @@ export interface FileCreateResponse {
   /**
    * The upload status of the file
    */
-  upload_status: 'pending' | 'processing' | 'ready' | 'failed';
+  upload_status: UploadStatus;
 
   /**
    * The presigned URL to upload the file to (only on create)
@@ -86,7 +91,7 @@ export interface FileCreateResponse {
  */
 export interface FileRetrieveResponse {
   /**
-   * The ID of the file
+   * The unique identifier for the file.
    */
   id: string;
 
@@ -108,7 +113,7 @@ export interface FileRetrieveResponse {
   /**
    * The upload status of the file
    */
-  upload_status: 'pending' | 'processing' | 'ready' | 'failed';
+  upload_status: UploadStatus;
 
   /**
    * The URL to access the file
@@ -132,6 +137,7 @@ export interface FileUploadOptions extends RequestOptions {
 
 export declare namespace Files {
   export {
+    type UploadStatus as UploadStatus,
     type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileCreateParams as FileCreateParams,

package/src/resources/forum-posts.ts

@@ -95,7 +95,11 @@ export type ForumPostVisibilityType = 'members_only' | 'globally_visible';
  */
 export interface ForumPostListResponse {
   /**
-   * The unique identifier of the resource.
+   * Represents a unique identifier that is Base64 obfuscated. It is often used to
+   * refetch an object or as key for a cache. The ID type appears in a JSON response
+   * as a String; however, it is not intended to be human-readable. When expected as
+   * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+   * input value will be accepted as an ID.
    */
   id: string;
 
@@ -166,7 +170,7 @@ export namespace ForumPostListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -213,8 +217,8 @@ export interface ForumPostCreateParams {
   parent_id?: string | null;
 
   /**
-   * The amount to paywall this post by. A paywalled post requires the user to
-   * purchase it in order to view its content.
+   * The price in paywall_currency to unlock this post (e.g., 5.00 for $5.00). If
+   * set, users must purchase access to view the post content.
    */
   paywall_amount?: number | null;
 

package/src/resources/forums.ts

@@ -87,7 +87,7 @@ export namespace ForumListResponse {
    */
   export interface Experience {
     /**
-     * The unique ID representing this experience
+     * The unique identifier for the experience.
      */
     id: string;
 

package/src/resources/index.ts

@@ -3,9 +3,7 @@
 export * from './shared';
 export {
   AIChats,
-  type AIChatCreateResponse,
-  type AIChatRetrieveResponse,
-  type AIChatUpdateResponse,
+  type AIChat,
   type AIChatListResponse,
   type AIChatDeleteResponse,
   type AIChatCreateParams,
@@ -63,8 +61,8 @@ export {
 } from './companies';
 export {
   CompanyTokenTransactions,
-  type CompanyTokenTransactionCreateResponse,
-  type CompanyTokenTransactionRetrieveResponse,
+  type BotTokenTransactionTypes,
+  type CompanyTokenTransaction,
   type CompanyTokenTransactionListResponse,
   type CompanyTokenTransactionCreateParams,
   type CompanyTokenTransactionListParams,
@@ -130,11 +128,21 @@ export {
   type DisputeUpdateEvidenceParams,
   type DisputeListResponsesCursorPage,
 } from './disputes';
+export {
+  DmChannels,
+  type DmChannel,
+  type DmChannelListResponse,
+  type DmChannelDeleteResponse,
+  type DmChannelCreateParams,
+  type DmChannelUpdateParams,
+  type DmChannelListParams,
+  type DmChannelListResponsesCursorPage,
+} from './dm-channels';
 export {
   DmMembers,
-  type DmMemberCreateResponse,
-  type DmMemberRetrieveResponse,
-  type DmMemberUpdateResponse,
+  type DmFeedMemberNotificationPreferences,
+  type DmFeedMemberStatuses,
+  type DmMember,
   type DmMemberListResponse,
   type DmMemberDeleteResponse,
   type DmMemberCreateParams,
@@ -171,7 +179,13 @@ export {
   type FeeMarkupListParams,
   type FeeMarkupListResponsesCursorPage,
 } from './fee-markups';
-export { Files, type FileCreateResponse, type FileRetrieveResponse, type FileCreateParams } from './files';
+export {
+  Files,
+  type UploadStatus,
+  type FileCreateResponse,
+  type FileRetrieveResponse,
+  type FileCreateParams,
+} from './files';
 export {
   ForumPosts,
   type ForumPostVisibilityType,
@@ -196,9 +210,7 @@ export {
 } from './invoices';
 export {
   Leads,
-  type LeadCreateResponse,
-  type LeadRetrieveResponse,
-  type LeadUpdateResponse,
+  type Lead,
   type LeadListResponse,
   type LeadCreateParams,
   type LeadUpdateParams,
@@ -215,6 +227,7 @@ export {
 } from './members';
 export {
   Memberships,
+  type CancelOptions,
   type MembershipListResponse,
   type MembershipUpdateParams,
   type MembershipListParams,
@@ -260,6 +273,7 @@ export {
 } from './payments';
 export {
   PayoutMethods,
+  type PayoutDestinationCategory,
   type PayoutMethodRetrieveResponse,
   type PayoutMethodListResponse,
   type PayoutMethodListParams,
@@ -352,16 +366,23 @@ export {
 } from './transfers';
 export {
   Users,
-  type UserRetrieveResponse,
+  type User,
   type UserCheckAccessResponse,
   type UserCheckAccessParams,
+  type UserUpdateProfileParams,
 } from './users';
-export { Verifications, type VerificationRetrieveResponse } from './verifications';
+export {
+  Verifications,
+  type VerificationErrorCode,
+  type VerificationStatus,
+  type VerificationRetrieveResponse,
+} from './verifications';
 export {
   Webhooks,
+  type APIVersion,
+  type Webhook,
+  type WebhookEvent,
   type WebhookCreateResponse,
-  type WebhookRetrieveResponse,
-  type WebhookUpdateResponse,
   type WebhookListResponse,
   type WebhookDeleteResponse,
   type InvoiceCreatedWebhookEvent,
@@ -399,11 +420,10 @@ export {
 } from './webhooks';
 export {
   Withdrawals,
+  type Withdrawal,
   type WithdrawalFeeTypes,
   type WithdrawalSpeeds,
   type WithdrawalStatus,
-  type WithdrawalCreateResponse,
-  type WithdrawalRetrieveResponse,
   type WithdrawalListResponse,
   type WithdrawalCreateParams,
   type WithdrawalListParams,