@whop/sdk 0.0.24 → 0.0.26

package/src/resources/dm-members.ts

@@ -0,0 +1,248 @@
+// 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 DmMembers extends APIResource {
+  /**
+   * Adds a user to a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmMember = await client.dmMembers.create({
+   *   channel_id: 'channel_id',
+   *   user_id: 'user_xxxxxxxxxxxxx',
+   * });
+   * ```
+   */
+  create(body: DmMemberCreateParams, options?: RequestOptions): APIPromise<DmMember> {
+    return this._client.post('/dm_members', { body, ...options });
+  }
+
+  /**
+   * Retrieves a DM channel member
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * const dmMember = await client.dmMembers.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DmMember> {
+    return this._client.get(path`/dm_members/${id}`, options);
+  }
+
+  /**
+   * Updates a DM channel member's settings
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmMember = await client.dmMembers.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: DmMemberUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DmMember> {
+    return this._client.patch(path`/dm_members/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists members of a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dmMemberListResponse of client.dmMembers.list(
+   *   { channel_id: 'channel_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: DmMemberListParams,
+    options?: RequestOptions,
+  ): PagePromise<DmMemberListResponsesCursorPage, DmMemberListResponse> {
+    return this._client.getAPIList('/dm_members', CursorPage<DmMemberListResponse>, { query, ...options });
+  }
+
+  /**
+   * Removes a user from a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmMember = await client.dmMembers.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<DmMemberDeleteResponse> {
+    return this._client.delete(path`/dm_members/${id}`, options);
+  }
+}
+
+export type DmMemberListResponsesCursorPage = CursorPage<DmMemberListResponse>;
+
+/**
+ * The notification preferences for a DMs feed member
+ */
+export type DmFeedMemberNotificationPreferences = 'all' | 'mentions' | 'none';
+
+/**
+ * The statuses of a DMs feed member
+ */
+export type DmFeedMemberStatuses = 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
+
+/**
+ * Represents a member of a DM channel
+ */
+export interface DmMember {
+  /**
+   * 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: DmFeedMemberNotificationPreferences;
+
+  /**
+   * The status of the membership (requested, accepted, rejected)
+   */
+  status: DmFeedMemberStatuses;
+
+  /**
+   * The ID of the user who is a member of the channel
+   */
+  user_id: string;
+}
+
+/**
+ * Represents a member of a DM channel
+ */
+export interface DmMemberListResponse {
+  /**
+   * 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 status of the membership (requested, accepted, rejected)
+   */
+  status: DmFeedMemberStatuses;
+
+  /**
+   * The ID of the user who is a member of the channel
+   */
+  user_id: string;
+}
+
+/**
+ * Represents `true` or `false` values.
+ */
+export type DmMemberDeleteResponse = boolean;
+
+export interface DmMemberCreateParams {
+  /**
+   * The ID of the DM channel to add the member to
+   */
+  channel_id: string;
+
+  /**
+   * The ID of the user to add to the channel
+   */
+  user_id: string;
+}
+
+export interface DmMemberUpdateParams {
+  /**
+   * The notification preferences for a DMs feed member
+   */
+  notification_preference?: DmFeedMemberNotificationPreferences | null;
+
+  /**
+   * The statuses of a DMs feed member
+   */
+  status?: DmFeedMemberStatuses | null;
+}
+
+export interface DmMemberListParams extends CursorPageParams {
+  /**
+   * The ID of the DM channel to list members for
+   */
+  channel_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;
+}
+
+export declare namespace DmMembers {
+  export {
+    type DmFeedMemberNotificationPreferences as DmFeedMemberNotificationPreferences,
+    type DmFeedMemberStatuses as DmFeedMemberStatuses,
+    type DmMember as DmMember,
+    type DmMemberListResponse as DmMemberListResponse,
+    type DmMemberDeleteResponse as DmMemberDeleteResponse,
+    type DmMemberListResponsesCursorPage as DmMemberListResponsesCursorPage,
+    type DmMemberCreateParams as DmMemberCreateParams,
+    type DmMemberUpdateParams as DmMemberUpdateParams,
+    type DmMemberListParams as DmMemberListParams,
+  };
+}

package/src/resources/files.ts

@@ -36,6 +36,11 @@ 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
  */
@@ -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)
@@ -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/index.ts

@@ -1,6 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  AIChats,
+  type AIChat,
+  type AIChatListResponse,
+  type AIChatDeleteResponse,
+  type AIChatCreateParams,
+  type AIChatUpdateParams,
+  type AIChatListParams,
+  type AIChatListResponsesCursorPage,
+} from './ai-chats';
 export { AccessTokens, type AccessTokenCreateResponse, type AccessTokenCreateParams } from './access-tokens';
 export { AccountLinks, type AccountLinkCreateResponse, type AccountLinkCreateParams } from './account-links';
 export {
@@ -49,6 +59,15 @@ export {
   type CompanyListParams,
   type CompanyListResponsesCursorPage,
 } from './companies';
+export {
+  CompanyTokenTransactions,
+  type BotTokenTransactionTypes,
+  type CompanyTokenTransaction,
+  type CompanyTokenTransactionListResponse,
+  type CompanyTokenTransactionCreateParams,
+  type CompanyTokenTransactionListParams,
+  type CompanyTokenTransactionListResponsesCursorPage,
+} from './company-token-transactions';
 export {
   CourseChapters,
   type CourseChapter,
@@ -109,6 +128,28 @@ 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 DmFeedMemberNotificationPreferences,
+  type DmFeedMemberStatuses,
+  type DmMember,
+  type DmMemberListResponse,
+  type DmMemberDeleteResponse,
+  type DmMemberCreateParams,
+  type DmMemberUpdateParams,
+  type DmMemberListParams,
+  type DmMemberListResponsesCursorPage,
+} from './dm-members';
 export {
   Entries,
   type EntryListResponse,
@@ -138,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,
@@ -163,9 +210,7 @@ export {
 } from './invoices';
 export {
   Leads,
-  type LeadCreateResponse,
-  type LeadRetrieveResponse,
-  type LeadUpdateResponse,
+  type Lead,
   type LeadListResponse,
   type LeadCreateParams,
   type LeadUpdateParams,
@@ -182,6 +227,7 @@ export {
 } from './members';
 export {
   Memberships,
+  type CancelOptions,
   type MembershipListResponse,
   type MembershipUpdateParams,
   type MembershipListParams,
@@ -192,6 +238,7 @@ export {
 export {
   Messages,
   type MessageListResponse,
+  type MessageDeleteResponse,
   type MessageCreateParams,
   type MessageUpdateParams,
   type MessageListParams,
@@ -226,6 +273,7 @@ export {
 } from './payments';
 export {
   PayoutMethods,
+  type PayoutDestinationCategory,
   type PayoutMethodRetrieveResponse,
   type PayoutMethodListResponse,
   type PayoutMethodListParams,
@@ -261,8 +309,10 @@ export {
 export {
   Reactions,
   type ReactionListResponse,
+  type ReactionDeleteResponse,
   type ReactionCreateParams,
   type ReactionListParams,
+  type ReactionDeleteParams,
   type ReactionListResponsesCursorPage,
 } from './reactions';
 export {
@@ -320,12 +370,18 @@ export {
   type UserCheckAccessResponse,
   type UserCheckAccessParams,
 } 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,
@@ -363,11 +419,10 @@ export {
 } from './webhooks';
 export {
   Withdrawals,
+  type Withdrawal,
   type WithdrawalFeeTypes,
   type WithdrawalSpeeds,
   type WithdrawalStatus,
-  type WithdrawalCreateResponse,
-  type WithdrawalRetrieveResponse,
   type WithdrawalListResponse,
   type WithdrawalCreateParams,
   type WithdrawalListParams,

package/src/resources/leads.ts

@@ -24,7 +24,7 @@ export class Leads extends APIResource {
    * });
    * ```
    */
-  create(body: LeadCreateParams, options?: RequestOptions): APIPromise<LeadCreateResponse> {
+  create(body: LeadCreateParams, options?: RequestOptions): APIPromise<Lead> {
     return this._client.post('/leads', { body, ...options });
   }
 
@@ -45,7 +45,7 @@ export class Leads extends APIResource {
    * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<LeadRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Lead> {
     return this._client.get(path`/leads/${id}`, options);
   }
 
@@ -70,7 +70,7 @@ export class Leads extends APIResource {
     id: string,
     body: LeadUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LeadUpdateResponse> {
+  ): APIPromise<Lead> {
     return this._client.patch(path`/leads/${id}`, { body, ...options });
   }
 
@@ -107,7 +107,7 @@ export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
 /**
  * An object representing a lead (someone who is interested in a whop).
  */
-export interface LeadCreateResponse {
+export interface Lead {
   /**
    * The ID of the lead.
    */
@@ -121,7 +121,7 @@ export interface LeadCreateResponse {
   /**
    * The converted member, if any.
    */
-  member: LeadCreateResponse.Member | null;
+  member: Lead.Member | null;
 
   /**
    * Custom metadata for the lead.
@@ -131,7 +131,7 @@ export interface LeadCreateResponse {
   /**
    * The access pass the lead is interested in, if available.
    */
-  product: LeadCreateResponse.Product | null;
+  product: Lead.Product | null;
 
   /**
    * The referrer URL that brought this lead.
@@ -146,204 +146,10 @@ export interface LeadCreateResponse {
   /**
    * The user who is the lead.
    */
-  user: LeadCreateResponse.User;
+  user: Lead.User;
 }
 
-export namespace LeadCreateResponse {
-  /**
-   * The converted member, if any.
-   */
-  export interface Member {
-    /**
-     * The ID of the member
-     */
-    id: string;
-  }
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  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 who is the lead.
-   */
-  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 lead (someone who is interested in a whop).
- */
-export interface LeadRetrieveResponse {
-  /**
-   * The ID of the lead.
-   */
-  id: string;
-
-  /**
-   * The timestamp of when the lead was created.
-   */
-  created_at: string;
-
-  /**
-   * The converted member, if any.
-   */
-  member: LeadRetrieveResponse.Member | null;
-
-  /**
-   * Custom metadata for the lead.
-   */
-  metadata: { [key: string]: unknown } | null;
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  product: LeadRetrieveResponse.Product | null;
-
-  /**
-   * The referrer URL that brought this lead.
-   */
-  referrer: string | null;
-
-  /**
-   * The timestamp of when the lead was last updated.
-   */
-  updated_at: string;
-
-  /**
-   * The user who is the lead.
-   */
-  user: LeadRetrieveResponse.User;
-}
-
-export namespace LeadRetrieveResponse {
-  /**
-   * The converted member, if any.
-   */
-  export interface Member {
-    /**
-     * The ID of the member
-     */
-    id: string;
-  }
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  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 who is the lead.
-   */
-  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 lead (someone who is interested in a whop).
- */
-export interface LeadUpdateResponse {
-  /**
-   * The ID of the lead.
-   */
-  id: string;
-
-  /**
-   * The timestamp of when the lead was created.
-   */
-  created_at: string;
-
-  /**
-   * The converted member, if any.
-   */
-  member: LeadUpdateResponse.Member | null;
-
-  /**
-   * Custom metadata for the lead.
-   */
-  metadata: { [key: string]: unknown } | null;
-
-  /**
-   * The access pass the lead is interested in, if available.
-   */
-  product: LeadUpdateResponse.Product | null;
-
-  /**
-   * The referrer URL that brought this lead.
-   */
-  referrer: string | null;
-
-  /**
-   * The timestamp of when the lead was last updated.
-   */
-  updated_at: string;
-
-  /**
-   * The user who is the lead.
-   */
-  user: LeadUpdateResponse.User;
-}
-
-export namespace LeadUpdateResponse {
+export namespace Lead {
   /**
    * The converted member, if any.
    */
@@ -571,9 +377,7 @@ export interface LeadListParams extends CursorPageParams {
 
 export declare namespace Leads {
   export {
-    type LeadCreateResponse as LeadCreateResponse,
-    type LeadRetrieveResponse as LeadRetrieveResponse,
-    type LeadUpdateResponse as LeadUpdateResponse,
+    type Lead as Lead,
     type LeadListResponse as LeadListResponse,
     type LeadListResponsesCursorPage as LeadListResponsesCursorPage,
     type LeadCreateParams as LeadCreateParams,