@whop/sdk 0.0.24 → 0.0.26

package/src/resources/checkout-configurations.ts

@@ -258,6 +258,11 @@ export declare namespace CheckoutConfigurationCreateParams {
      * The URL to redirect the user to after the checkout configuration is created
      */
     redirect_url?: string | null;
+
+    /**
+     * The URL of the page where the checkout is being initiated from.
+     */
+    source_url?: string | null;
   }
 
   export namespace CreateCheckoutSessionInputModePaymentWithPlan {
@@ -601,6 +606,11 @@ export declare namespace CheckoutConfigurationCreateParams {
      * The URL to redirect the user to after the checkout configuration is created
      */
     redirect_url?: string | null;
+
+    /**
+     * The URL of the page where the checkout is being initiated from.
+     */
+    source_url?: string | null;
   }
 
   export namespace CreateCheckoutSessionInputModePaymentWithPlanID {
@@ -663,6 +673,11 @@ export declare namespace CheckoutConfigurationCreateParams {
      * The URL to redirect the user to after the checkout configuration is created
      */
     redirect_url?: string | null;
+
+    /**
+     * The URL of the page where the checkout is being initiated from.
+     */
+    source_url?: string | null;
   }
 
   export namespace CreateCheckoutSessionInputModeSetup {

package/src/resources/company-token-transactions.ts

@@ -0,0 +1,433 @@
+// 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 CompanyTokenTransactions extends APIResource {
+  /**
+   * Create a token transaction (add/subtract/transfer) for a member
+   *
+   * Required permissions:
+   *
+   * - `company_token_transaction:create`
+   * - `member:basic:read`
+   * - `company:basic:read`
+   *
+   * @example
+   * ```ts
+   * const companyTokenTransaction =
+   *   await client.companyTokenTransactions.create({
+   *     amount: 6.9,
+   *     company_id: 'biz_xxxxxxxxxxxxxx',
+   *     destination_user_id: 'destination_user_id',
+   *     transaction_type: 'transfer',
+   *     user_id: 'user_xxxxxxxxxxxxx',
+   *   });
+   * ```
+   */
+  create(
+    body: CompanyTokenTransactionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CompanyTokenTransaction> {
+    return this._client.post('/company_token_transactions', { body, ...options });
+  }
+
+  /**
+   * Retrieves a token transaction by ID
+   *
+   * Required permissions:
+   *
+   * - `company_token_transaction:read`
+   * - `member:basic:read`
+   * - `company:basic:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransaction> {
+    return this._client.get(path`/company_token_transactions/${id}`, options);
+  }
+
+  /**
+   * Lists token transactions for a company
+   *
+   * Required permissions:
+   *
+   * - `company_token_transaction:read`
+   * - `member:basic:read`
+   * - `company:basic:read`
+   */
+  list(
+    query: CompanyTokenTransactionListParams,
+    options?: RequestOptions,
+  ): PagePromise<CompanyTokenTransactionListResponsesCursorPage, CompanyTokenTransactionListResponse> {
+    return this._client.getAPIList(
+      '/company_token_transactions',
+      CursorPage<CompanyTokenTransactionListResponse>,
+      { query, ...options },
+    );
+  }
+}
+
+export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
+
+/**
+ * The type of token transaction
+ */
+export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
+
+/**
+ * A token transaction within a company
+ */
+export interface CompanyTokenTransaction {
+  /**
+   * The ID of the transaction
+   */
+  id: string;
+
+  /**
+   * The transaction amount (always positive)
+   */
+  amount: number;
+
+  /**
+   * The company
+   */
+  company: CompanyTokenTransaction.Company;
+
+  /**
+   * When the transaction was created
+   */
+  created_at: string;
+
+  /**
+   * Optional description
+   */
+  description: string | null;
+
+  /**
+   * Optional idempotency key to prevent duplicate transactions
+   */
+  idempotency_key: string | null;
+
+  /**
+   * For transfers, the ID of the linked transaction
+   */
+  linked_transaction_id: string | null;
+
+  /**
+   * The member
+   */
+  member: CompanyTokenTransaction.Member;
+
+  /**
+   * The type of transaction
+   */
+  transaction_type: BotTokenTransactionTypes;
+
+  /**
+   * The user whose balance changed
+   */
+  user: CompanyTokenTransaction.User;
+}
+
+export namespace CompanyTokenTransaction {
+  /**
+   * The company
+   */
+  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 member
+   */
+  export interface Member {
+    /**
+     * The ID of the member
+     */
+    id: string;
+  }
+
+  /**
+   * The user whose balance changed
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+/**
+ * A token transaction within a company
+ */
+export interface CompanyTokenTransactionListResponse {
+  /**
+   * The ID of the transaction
+   */
+  id: string;
+
+  /**
+   * The transaction amount (always positive)
+   */
+  amount: number;
+
+  /**
+   * The company
+   */
+  company: CompanyTokenTransactionListResponse.Company;
+
+  /**
+   * When the transaction was created
+   */
+  created_at: string;
+
+  /**
+   * Optional description
+   */
+  description: string | null;
+
+  /**
+   * Optional idempotency key to prevent duplicate transactions
+   */
+  idempotency_key: string | null;
+
+  /**
+   * For transfers, the ID of the linked transaction
+   */
+  linked_transaction_id: string | null;
+
+  /**
+   * The member
+   */
+  member: CompanyTokenTransactionListResponse.Member;
+
+  /**
+   * The type of transaction
+   */
+  transaction_type: BotTokenTransactionTypes;
+
+  /**
+   * The user whose balance changed
+   */
+  user: CompanyTokenTransactionListResponse.User;
+}
+
+export namespace CompanyTokenTransactionListResponse {
+  /**
+   * The company
+   */
+  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 member
+   */
+  export interface Member {
+    /**
+     * The ID of the member
+     */
+    id: string;
+  }
+
+  /**
+   * The user whose balance changed
+   */
+  export interface User {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+export type CompanyTokenTransactionCreateParams =
+  | CompanyTokenTransactionCreateParams.CreateCompanyTokenTransactionInputTransactionTypeTransfer
+  | CompanyTokenTransactionCreateParams.CreateCompanyTokenTransactionInputTransactionTypeAdd
+  | CompanyTokenTransactionCreateParams.CreateCompanyTokenTransactionInputTransactionTypeSubtract;
+
+export declare namespace CompanyTokenTransactionCreateParams {
+  export interface CreateCompanyTokenTransactionInputTransactionTypeTransfer {
+    /**
+     * The positive amount of tokens
+     */
+    amount: number;
+
+    /**
+     * The company ID
+     */
+    company_id: string;
+
+    /**
+     * Required for transfers - the user to receive tokens
+     */
+    destination_user_id: string;
+
+    transaction_type: 'transfer';
+
+    /**
+     * The user ID whose balance will change
+     */
+    user_id: string;
+
+    /**
+     * Optional description for the transaction
+     */
+    description?: string | null;
+
+    /**
+     * Optional key to prevent duplicate transactions
+     */
+    idempotency_key?: string | null;
+  }
+
+  export interface CreateCompanyTokenTransactionInputTransactionTypeAdd {
+    /**
+     * The positive amount of tokens
+     */
+    amount: number;
+
+    /**
+     * The company ID
+     */
+    company_id: string;
+
+    transaction_type: 'add';
+
+    /**
+     * The user ID whose balance will change
+     */
+    user_id: string;
+
+    /**
+     * Optional description for the transaction
+     */
+    description?: string | null;
+
+    /**
+     * Optional key to prevent duplicate transactions
+     */
+    idempotency_key?: string | null;
+  }
+
+  export interface CreateCompanyTokenTransactionInputTransactionTypeSubtract {
+    /**
+     * The positive amount of tokens
+     */
+    amount: number;
+
+    /**
+     * The company ID
+     */
+    company_id: string;
+
+    transaction_type: 'subtract';
+
+    /**
+     * The user ID whose balance will change
+     */
+    user_id: string;
+
+    /**
+     * Optional description for the transaction
+     */
+    description?: string | null;
+
+    /**
+     * Optional key to prevent duplicate transactions
+     */
+    idempotency_key?: string | null;
+  }
+}
+
+export interface CompanyTokenTransactionListParams extends CursorPageParams {
+  /**
+   * The ID of the company
+   */
+  company_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;
+
+  /**
+   * The type of token transaction
+   */
+  transaction_type?: BotTokenTransactionTypes | null;
+
+  /**
+   * Filter by user ID
+   */
+  user_id?: string | null;
+}
+
+export declare namespace CompanyTokenTransactions {
+  export {
+    type BotTokenTransactionTypes as BotTokenTransactionTypes,
+    type CompanyTokenTransaction as CompanyTokenTransaction,
+    type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse,
+    type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage,
+    type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,
+    type CompanyTokenTransactionListParams as CompanyTokenTransactionListParams,
+  };
+}

package/src/resources/dm-channels.ts

@@ -0,0 +1,212 @@
+// 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 DmChannels extends APIResource {
+  /**
+   * Creates a DM channel
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.create({
+   *   with_user_ids: ['string'],
+   * });
+   * ```
+   */
+  create(body: DmChannelCreateParams, options?: RequestOptions): APIPromise<DmChannel> {
+    return this._client.post('/dm_channels', { body, ...options });
+  }
+
+  /**
+   * Retrieves a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DmChannel> {
+    return this._client.get(path`/dm_channels/${id}`, options);
+  }
+
+  /**
+   * Updates a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: DmChannelUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DmChannel> {
+    return this._client.patch(path`/dm_channels/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists DM channels for the current user
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dmChannelListResponse of client.dmChannels.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: DmChannelListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DmChannelListResponsesCursorPage, DmChannelListResponse> {
+    return this._client.getAPIList('/dm_channels', CursorPage<DmChannelListResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<DmChannelDeleteResponse> {
+    return this._client.delete(path`/dm_channels/${id}`, options);
+  }
+}
+
+export type DmChannelListResponsesCursorPage = CursorPage<DmChannelListResponse>;
+
+/**
+ * Represents a DM channel
+ */
+export interface DmChannel {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The time the entity was created (in milliseconds since Unix epoch)
+   */
+  created_at: string;
+
+  /**
+   * When the last message was sent
+   */
+  last_message_at: string | null;
+
+  /**
+   * The custom name of the DM channel, if any
+   */
+  name: string | null;
+}
+
+/**
+ * Represents a DM channel
+ */
+export interface DmChannelListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The time the entity was created (in milliseconds since Unix epoch)
+   */
+  created_at: string;
+
+  /**
+   * When the last message was sent
+   */
+  last_message_at: string | null;
+
+  /**
+   * The custom name of the DM channel, if any
+   */
+  name: string | null;
+}
+
+/**
+ * Represents `true` or `false` values.
+ */
+export type DmChannelDeleteResponse = boolean;
+
+export interface DmChannelCreateParams {
+  /**
+   * The user ids to create a DM with. Can be email, username or user_id (tag)
+   */
+  with_user_ids: Array<string>;
+
+  /**
+   * The ID of the company to scope this DM channel to.
+   */
+  company_id?: string | null;
+
+  /**
+   * The custom name for the DM channel
+   */
+  custom_name?: string | null;
+}
+
+export interface DmChannelUpdateParams {
+  /**
+   * The custom name for the DM channel
+   */
+  custom_name?: string | null;
+}
+
+export interface DmChannelListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter DM channels scoped to a specific company
+   */
+  company_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;
+}
+
+export declare namespace DmChannels {
+  export {
+    type DmChannel as DmChannel,
+    type DmChannelListResponse as DmChannelListResponse,
+    type DmChannelDeleteResponse as DmChannelDeleteResponse,
+    type DmChannelListResponsesCursorPage as DmChannelListResponsesCursorPage,
+    type DmChannelCreateParams as DmChannelCreateParams,
+    type DmChannelUpdateParams as DmChannelUpdateParams,
+    type DmChannelListParams as DmChannelListParams,
+  };
+}