@whop/sdk 0.0.38 → 0.0.40

package/src/resources/bounties.ts

@@ -0,0 +1,353 @@
+// 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';
+
+/**
+ * Bounties
+ */
+export class Bounties extends APIResource {
+  /**
+   * Returns a paginated list of workforce bounties. When experienceId is provided,
+   * returns bounties scoped to that experience. When omitted, returns bounties with
+   * no experience.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const bountyListResponse of client.bounties.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: BountyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BountyListResponsesCursorPage, BountyListResponse> {
+    return this._client.getAPIList('/bounties', CursorPage<BountyListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new workforce bounty by funding a dedicated bounty pool.
+   *
+   * Required permissions:
+   *
+   * - `bounty:create`
+   *
+   * @example
+   * ```ts
+   * const bounty = await client.bounties.create({
+   *   base_unit_amount: 6.9,
+   *   currency: 'usd',
+   *   description: 'description',
+   *   title: 'title',
+   * });
+   * ```
+   */
+  create(body: BountyCreateParams, options?: RequestOptions): APIPromise<BountyCreateResponse> {
+    return this._client.post('/bounties', { body, ...options });
+  }
+
+  /**
+   * Retrieves a workforce bounty for the current authenticated user.
+   *
+   * @example
+   * ```ts
+   * const bounty = await client.bounties.retrieve(
+   *   'bnty_xxxxxxxxxxxxx',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BountyRetrieveResponse> {
+    return this._client.get(path`/bounties/${id}`, options);
+  }
+}
+
+export type BountyListResponsesCursorPage = CursorPage<BountyListResponse>;
+
+/**
+ * A privately accessible bounty.
+ */
+export interface BountyCreateResponse {
+  /**
+   * The unique identifier for the bounty.
+   */
+  id: string;
+
+  /**
+   * The underlying bounty implementation type.
+   */
+  bounty_type: 'classic' | 'user_funded' | 'workforce';
+
+  /**
+   * The datetime the bounty was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency used for the bounty funds.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The description of the bounty.
+   */
+  description: string;
+
+  /**
+   * The current lifecycle status of the bounty.
+   */
+  status: 'published' | 'archived';
+
+  /**
+   * The title of the bounty.
+   */
+  title: string;
+
+  /**
+   * The total amount currently funded in the bounty pool for payout.
+   */
+  total_available: number;
+
+  /**
+   * The total amount paid out for this bounty.
+   */
+  total_paid: number;
+
+  /**
+   * The datetime the bounty was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The number of watcher votes required before the submission can resolve.
+   */
+  vote_threshold: number;
+}
+
+/**
+ * A privately accessible bounty.
+ */
+export interface BountyRetrieveResponse {
+  /**
+   * The unique identifier for the bounty.
+   */
+  id: string;
+
+  /**
+   * The underlying bounty implementation type.
+   */
+  bounty_type: 'classic' | 'user_funded' | 'workforce';
+
+  /**
+   * The datetime the bounty was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency used for the bounty funds.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The description of the bounty.
+   */
+  description: string;
+
+  /**
+   * The current lifecycle status of the bounty.
+   */
+  status: 'published' | 'archived';
+
+  /**
+   * The title of the bounty.
+   */
+  title: string;
+
+  /**
+   * The total amount currently funded in the bounty pool for payout.
+   */
+  total_available: number;
+
+  /**
+   * The total amount paid out for this bounty.
+   */
+  total_paid: number;
+
+  /**
+   * The datetime the bounty was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The number of watcher votes required before the submission can resolve.
+   */
+  vote_threshold: number;
+}
+
+/**
+ * A privately accessible bounty.
+ */
+export interface BountyListResponse {
+  /**
+   * The unique identifier for the bounty.
+   */
+  id: string;
+
+  /**
+   * The underlying bounty implementation type.
+   */
+  bounty_type: 'classic' | 'user_funded' | 'workforce';
+
+  /**
+   * The datetime the bounty was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency used for the bounty funds.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The description of the bounty.
+   */
+  description: string;
+
+  /**
+   * The current lifecycle status of the bounty.
+   */
+  status: 'published' | 'archived';
+
+  /**
+   * The title of the bounty.
+   */
+  title: string;
+
+  /**
+   * The total amount currently funded in the bounty pool for payout.
+   */
+  total_available: number;
+
+  /**
+   * The total amount paid out for this bounty.
+   */
+  total_paid: number;
+
+  /**
+   * The datetime the bounty was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The number of watcher votes required before the submission can resolve.
+   */
+  vote_threshold: number;
+}
+
+export interface BountyListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * The experience to list bounties for. When omitted, returns bounties with no
+   * experience.
+   */
+  experience_id?: 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 available bounty statuses to choose from.
+   */
+  status?: 'published' | 'archived' | null;
+}
+
+export interface BountyCreateParams {
+  /**
+   * The amount paid to each approved submission. The total bounty pool funded is
+   * this amount times accepted_submissions_limit.
+   */
+  base_unit_amount: number;
+
+  /**
+   * The currency for the bounty pool funding amount.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The description of the bounty.
+   */
+  description: string;
+
+  /**
+   * The title of the bounty.
+   */
+  title: string;
+
+  /**
+   * The number of submissions that can be approved before the bounty closes.
+   * Defaults to 1.
+   */
+  accepted_submissions_limit?: number | null;
+
+  /**
+   * The ISO3166 country codes where this bounty should be visible. Empty means
+   * globally visible.
+   */
+  allowed_country_codes?: Array<string> | null;
+
+  /**
+   * An optional experience to scope the bounty to.
+   */
+  experience_id?: string | null;
+
+  /**
+   * The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
+   * Defaults to the requester's personal balance when omitted. The requester must be
+   * the user themself or an owner/admin of the company.
+   */
+  origin_account_id?: string | null;
+
+  /**
+   * Optional markdown body for the anchor forum post. Falls back to the bounty
+   * description when omitted.
+   */
+  post_markdown_content?: string | null;
+
+  /**
+   * Optional title for the anchor forum post. Falls back to the bounty title when
+   * omitted.
+   */
+  post_title?: string | null;
+}
+
+export declare namespace Bounties {
+  export {
+    type BountyCreateResponse as BountyCreateResponse,
+    type BountyRetrieveResponse as BountyRetrieveResponse,
+    type BountyListResponse as BountyListResponse,
+    type BountyListResponsesCursorPage as BountyListResponsesCursorPage,
+    type BountyListParams as BountyListParams,
+    type BountyCreateParams as BountyCreateParams,
+  };
+}

package/src/resources/chat-channels.ts

@@ -11,6 +11,34 @@ import { path } from '../internal/utils/path';
  * Chat channels
  */
 export class ChatChannels extends APIResource {
+  /**
+   * Returns a paginated list of chat channels within a specific company, with
+   * optional filtering by product.
+   *
+   * Required permissions:
+   *
+   * - `chat:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const chatChannelListResponse of client.chatChannels.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ChatChannelListParams,
+    options?: RequestOptions,
+  ): PagePromise<ChatChannelListResponsesCursorPage, ChatChannelListResponse> {
+    return this._client.getAPIList('/chat_channels', CursorPage<ChatChannelListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Retrieves the details of an existing chat channel.
    *
@@ -49,34 +77,6 @@ export class ChatChannels extends APIResource {
   ): APIPromise<Shared.ChatChannel> {
     return this._client.patch(path`/chat_channels/${id}`, { body, ...options });
   }
-
-  /**
-   * Returns a paginated list of chat channels within a specific company, with
-   * optional filtering by product.
-   *
-   * Required permissions:
-   *
-   * - `chat:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const chatChannelListResponse of client.chatChannels.list(
-   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: ChatChannelListParams,
-    options?: RequestOptions,
-  ): PagePromise<ChatChannelListResponsesCursorPage, ChatChannelListResponse> {
-    return this._client.getAPIList('/chat_channels', CursorPage<ChatChannelListResponse>, {
-      query,
-      ...options,
-    });
-  }
 }
 
 export type ChatChannelListResponsesCursorPage = CursorPage<ChatChannelListResponse>;
@@ -146,73 +146,73 @@ export namespace ChatChannelListResponse {
   }
 }
 
-export interface ChatChannelUpdateParams {
+export interface ChatChannelListParams extends CursorPageParams {
   /**
-   * Whether media uploads such as images and videos are banned in this chat channel.
+   * The unique identifier of the company to list chat channels for.
    */
-  ban_media?: boolean | null;
+  company_id: string;
 
   /**
-   * Whether URLs and links are banned from being posted in this chat channel.
+   * Returns the elements in the list that come before the specified cursor.
    */
-  ban_urls?: boolean | null;
+  before?: string | null;
 
   /**
-   * A list of words that are automatically blocked from messages in this chat
-   * channel. For example, ['spam', 'scam'].
+   * Returns the first _n_ elements from the list.
    */
-  banned_words?: Array<string> | null;
+  first?: number | null;
 
   /**
-   * The minimum number of seconds a user must wait between sending messages in this
-   * chat channel.
+   * Returns the last _n_ elements from the list.
    */
-  user_posts_cooldown_seconds?: number | null;
+  last?: number | null;
 
   /**
-   * Who can post on a chat feed
+   * The unique identifier of a product to filter by. When set, only chat channels
+   * connected to this product are returned.
    */
-  who_can_post?: Shared.WhoCanPost | null;
+  product_id?: string | null;
+}
 
+export interface ChatChannelUpdateParams {
   /**
-   * Who can react on a chat feed
+   * Whether media uploads such as images and videos are banned in this chat channel.
    */
-  who_can_react?: Shared.WhoCanReact | null;
-}
+  ban_media?: boolean | null;
 
-export interface ChatChannelListParams extends CursorPageParams {
   /**
-   * The unique identifier of the company to list chat channels for.
+   * Whether URLs and links are banned from being posted in this chat channel.
    */
-  company_id: string;
+  ban_urls?: boolean | null;
 
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * A list of words that are automatically blocked from messages in this chat
+   * channel. For example, ['spam', 'scam'].
    */
-  before?: string | null;
+  banned_words?: Array<string> | null;
 
   /**
-   * Returns the first _n_ elements from the list.
+   * The minimum number of seconds a user must wait between sending messages in this
+   * chat channel.
    */
-  first?: number | null;
+  user_posts_cooldown_seconds?: number | null;
 
   /**
-   * Returns the last _n_ elements from the list.
+   * Who can post on a chat feed
    */
-  last?: number | null;
+  who_can_post?: Shared.WhoCanPost | null;
 
   /**
-   * The unique identifier of a product to filter by. When set, only chat channels
-   * connected to this product are returned.
+   * Who can react on a chat feed
    */
-  product_id?: string | null;
+  who_can_react?: Shared.WhoCanReact | null;
 }
 
 export declare namespace ChatChannels {
   export {
     type ChatChannelListResponse as ChatChannelListResponse,
     type ChatChannelListResponsesCursorPage as ChatChannelListResponsesCursorPage,
-    type ChatChannelUpdateParams as ChatChannelUpdateParams,
     type ChatChannelListParams as ChatChannelListParams,
+    type ChatChannelUpdateParams as ChatChannelUpdateParams,
   };
 }