@whop/sdk 0.0.1-canary.0

package/src/resources/shipments.ts

@@ -0,0 +1,200 @@
+// 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 Shipments extends APIResource {
+  /**
+   * Creates a new shipment
+   *
+   * Required permissions:
+   *
+   * - `shipment:create`
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * const shipment = await client.shipments.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   payment_id: 'pay_xxxxxxxxxxxxxx',
+   *   tracking_code: 'tracking_code',
+   * });
+   * ```
+   */
+  create(body: ShipmentCreateParams, options?: RequestOptions): APIPromise<Shared.Shipment> {
+    return this._client.post('/shipments', { body, ...options });
+  }
+
+  /**
+   * Retrieves a shipment by ID
+   *
+   * Required permissions:
+   *
+   * - `shipment:basic:read`
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * const shipment = await client.shipments.retrieve(
+   *   'ship_xxxxxxxxxxxxx',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Shipment> {
+    return this._client.get(path`/shipments/${id}`, options);
+  }
+
+  /**
+   * Lists shipments for a payment
+   *
+   * Required permissions:
+   *
+   * - `shipment:basic:read`
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const shipmentListResponse of client.shipments.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ShipmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ShipmentListResponsesCursorPage, ShipmentListResponse> {
+    return this._client.getAPIList('/shipments', CursorPage<ShipmentListResponse>, { query, ...options });
+  }
+}
+
+export type ShipmentListResponsesCursorPage = CursorPage<ShipmentListResponse>;
+
+/**
+ * A shipment
+ */
+export interface ShipmentListResponse {
+  /**
+   * The ID of the shipment
+   */
+  id: string;
+
+  /**
+   * The carrier of the shipment
+   */
+  carrier: Shared.ShipmentCarrier;
+
+  /**
+   * The date and time the shipment was created
+   */
+  created_at: string;
+
+  /**
+   * The delivery estimate of the shipment
+   */
+  delivery_estimate: string | null;
+
+  /**
+   * The payment of the shipment
+   */
+  payment: ShipmentListResponse.Payment;
+
+  /**
+   * The service of the shipment
+   */
+  service: string | null;
+
+  /**
+   * The status of the shipment
+   */
+  status: Shared.ShipmentStatus;
+
+  /**
+   * The substatus of a shipment
+   */
+  substatus: Shared.ShipmentSubstatus | null;
+
+  /**
+   * The tracking code of the shipment
+   */
+  tracking_code: string;
+
+  /**
+   * The date and time the shipment was last updated
+   */
+  updated_at: string;
+}
+
+export namespace ShipmentListResponse {
+  /**
+   * The payment of the shipment
+   */
+  export interface Payment {
+    /**
+     * The payment ID
+     */
+    id: string;
+  }
+}
+
+export interface ShipmentCreateParams {
+  /**
+   * The ID of the company to create the shipment for
+   */
+  company_id: string;
+
+  /**
+   * The ID of the payment to create the shipment for
+   */
+  payment_id: string;
+
+  /**
+   * The tracking code for the shipment
+   */
+  tracking_code: string;
+}
+
+export interface ShipmentListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * The ID of the 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;
+
+  /**
+   * The ID of the payment
+   */
+  payment_id?: string | null;
+
+  /**
+   * The ID of the user
+   */
+  user_id?: string | null;
+}
+
+export declare namespace Shipments {
+  export {
+    type ShipmentListResponse as ShipmentListResponse,
+    type ShipmentListResponsesCursorPage as ShipmentListResponsesCursorPage,
+    type ShipmentCreateParams as ShipmentCreateParams,
+    type ShipmentListParams as ShipmentListParams,
+  };
+}

package/src/resources/support-channels.ts

@@ -0,0 +1,193 @@
+// 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 SupportChannels extends APIResource {
+  /**
+   * Create a new support channel for a user in a company. If one already exists, it
+   * will return the existing one.
+   *
+   * Required permissions:
+   *
+   * - `support_chat:create`
+   *
+   * @example
+   * ```ts
+   * const supportChannel = await client.supportChannels.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   user_id: 'user_xxxxxxxxxxxxx',
+   * });
+   * ```
+   */
+  create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel> {
+    return this._client.post('/support_channels', { body, ...options });
+  }
+
+  /**
+   * Retrieves a support channel
+   *
+   * Required permissions:
+   *
+   * - `support_chat:read`
+   *
+   * @example
+   * ```ts
+   * const supportChannel =
+   *   await client.supportChannels.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.SupportChannel> {
+    return this._client.get(path`/support_channels/${id}`, options);
+  }
+
+  /**
+   * Lists chat channels inside a company
+   *
+   * Required permissions:
+   *
+   * - `support_chat:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const supportChannelListResponse of client.supportChannels.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SupportChannelListParams,
+    options?: RequestOptions,
+  ): PagePromise<SupportChannelListResponsesCursorPage, SupportChannelListResponse> {
+    return this._client.getAPIList('/support_channels', CursorPage<SupportChannelListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
+
+/**
+ * Represents a DM channel
+ */
+export interface SupportChannelListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The bot ID if this is a support chat
+   */
+  company_id: string | null;
+
+  /**
+   * The custom name of the DM channel, if any
+   */
+  custom_name: string | null;
+
+  /**
+   * The customer user if this is a support chat
+   */
+  customer_user: SupportChannelListResponse.CustomerUser | null;
+
+  /**
+   * When the last message was sent
+   */
+  last_message_at: string | null;
+
+  /**
+   * When the support ticket was resolved (null if unresolved)
+   */
+  resolved_at: string | null;
+}
+
+export namespace SupportChannelListResponse {
+  /**
+   * The customer user if this is a support chat
+   */
+  export interface CustomerUser {
+    /**
+     * 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 interface SupportChannelCreateParams {
+  /**
+   * The ID of the company to create the support chat in
+   */
+  company_id: string;
+
+  /**
+   * The ID of the user to create the support chat for
+   */
+  user_id: string;
+}
+
+export interface SupportChannelListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list chat channels for
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  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;
+
+  /**
+   * Filter for tickets where customer sent the last message (needs response) AND not
+   * resolved. Set to true to only return open channels, false to only return
+   * resolved channels.
+   */
+  open?: boolean | null;
+
+  /**
+   * Sort options for message channels
+   */
+  order?: 'created_at' | 'last_post_sent_at' | null;
+}
+
+export declare namespace SupportChannels {
+  export {
+    type SupportChannelListResponse as SupportChannelListResponse,
+    type SupportChannelListResponsesCursorPage as SupportChannelListResponsesCursorPage,
+    type SupportChannelCreateParams as SupportChannelCreateParams,
+    type SupportChannelListParams as SupportChannelListParams,
+  };
+}

package/src/resources/transfers.ts

@@ -0,0 +1,200 @@
+// 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 Transfers extends APIResource {
+  /**
+   * Creates a new transfer between ledger accounts
+   *
+   * Required permissions:
+   *
+   * - `payout:transfer_funds`
+   *
+   * @example
+   * ```ts
+   * const transfer = await client.transfers.create({
+   *   amount: 6.9,
+   *   currency: 'usd',
+   *   destination_id: 'destination_id',
+   *   origin_id: 'origin_id',
+   * });
+   * ```
+   */
+  create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer> {
+    return this._client.post('/transfers', { body, ...options });
+  }
+
+  /**
+   * Retrieves a transfer by ID
+   *
+   * Required permissions:
+   *
+   * - `payout:transfer:read`
+   *
+   * @example
+   * ```ts
+   * const transfer = await client.transfers.retrieve(
+   *   'ctt_xxxxxxxxxxxxxx',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer> {
+    return this._client.get(path`/transfers/${id}`, options);
+  }
+
+  /**
+   * Lists transfers
+   *
+   * Required permissions:
+   *
+   * - `payout:transfer:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const transferListResponse of client.transfers.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: TransferListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TransferListResponsesCursorPage, TransferListResponse> {
+    return this._client.getAPIList('/transfers', CursorPage<TransferListResponse>, { query, ...options });
+  }
+}
+
+export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
+
+/**
+ * Credit Transaction Transfer
+ */
+export interface TransferListResponse {
+  /**
+   * The unique identifier of the credit transaction transfer
+   */
+  id: string;
+
+  /**
+   * The amount of the credit transaction transfer
+   */
+  amount: number;
+
+  /**
+   * The timestamp when the credit transaction transfer was created
+   */
+  created_at: string;
+
+  /**
+   * The currency of the credit transaction transfer
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The ID of the destination ledger account
+   */
+  destination_ledger_account_id: string;
+
+  /**
+   * The decimal fee of the credit transaction transfer
+   */
+  fee_amount: number | null;
+
+  /**
+   * The notes of the credit transaction transfer
+   */
+  notes: string | null;
+
+  /**
+   * The ID of the origin ledger account
+   */
+  origin_ledger_account_id: string;
+}
+
+export interface TransferCreateParams {
+  /**
+   * The amount to withdraw
+   */
+  amount: number;
+
+  /**
+   * The currency that is being withdrawn.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The ID of the destination account which will receive the funds (either a User
+   * ID, Company ID, or LedgerAccount ID)
+   */
+  destination_id: string;
+
+  /**
+   * The ID of the origin account which will send the funds (either a User ID,
+   * Company ID, or LedgerAccount ID)
+   */
+  origin_id: string;
+
+  /**
+   * A unique key to ensure idempotence. Use a UUID or similar.
+   */
+  idempotence_key?: string | null;
+
+  /**
+   * Notes for the transfer. Maximum of 50 characters.
+   */
+  notes?: string | null;
+}
+
+export interface TransferListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter transfers to only those that were sent to this destination account.
+   * (user_xxx, biz_xxx, ldgr_xxx)
+   */
+  destination_id?: 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;
+
+  /**
+   * Which columns can be used to sort.
+   */
+  order?: 'amount' | 'created_at' | null;
+
+  /**
+   * Filter transfers to only those that were sent from this origin account.
+   * (user_xxx, biz_xxx, ldgr_xxx)
+   */
+  origin_id?: string | null;
+}
+
+export declare namespace Transfers {
+  export {
+    type TransferListResponse as TransferListResponse,
+    type TransferListResponsesCursorPage as TransferListResponsesCursorPage,
+    type TransferCreateParams as TransferCreateParams,
+    type TransferListParams as TransferListParams,
+  };
+}

package/src/resources/users.ts

@@ -0,0 +1,84 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Users extends APIResource {
+  /**
+   * Retrieves a user by ID or username
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
+    return this._client.get(path`/users/${id}`, options);
+  }
+
+  /**
+   * Check if a user has access (and their access level) to a resource
+   */
+  checkAccess(
+    resourceID: string,
+    params: UserCheckAccessParams,
+    options?: RequestOptions,
+  ): APIPromise<UserCheckAccessResponse> {
+    const { id } = params;
+    return this._client.get(path`/users/${id}/access/${resourceID}`, options);
+  }
+}
+
+/**
+ * An object representing a (sanitized) user of the site.
+ */
+export interface UserRetrieveResponse {
+  /**
+   * The internal ID of the user.
+   */
+  id: string;
+
+  /**
+   * The user's bio
+   */
+  bio: string | null;
+
+  /**
+   * When the user was created.
+   */
+  created_at: string;
+
+  /**
+   * The name of the user from their Whop account.
+   */
+  name: string | null;
+
+  /**
+   * The username of the user from their Whop account.
+   */
+  username: string;
+}
+
+/**
+ * The result of a has access check for the developer API
+ */
+export interface UserCheckAccessResponse {
+  /**
+   * The permission level of the user
+   */
+  access_level: 'no_access' | 'admin' | 'customer';
+
+  /**
+   * Whether the user has access to the resource
+   */
+  has_access: boolean;
+}
+
+export interface UserCheckAccessParams {
+  id: string;
+}
+
+export declare namespace Users {
+  export {
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UserCheckAccessResponse as UserCheckAccessResponse,
+    type UserCheckAccessParams as UserCheckAccessParams,
+  };
+}