@whop/sdk 0.0.23 → 0.0.25

package/resources/company-token-transactions.d.mts

@@ -0,0 +1,425 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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<CompanyTokenTransactionCreateResponse>;
+    /**
+     * Retrieves a token transaction by ID
+     *
+     * Required permissions:
+     *
+     * - `company_token_transaction:read`
+     * - `member:basic:read`
+     * - `company:basic:read`
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransactionRetrieveResponse>;
+    /**
+     * 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>;
+}
+export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
+/**
+ * A token transaction within a company
+ */
+export interface CompanyTokenTransactionCreateResponse {
+    /**
+     * The ID of the transaction
+     */
+    id: string;
+    /**
+     * The transaction amount (always positive)
+     */
+    amount: number;
+    /**
+     * The company
+     */
+    company: CompanyTokenTransactionCreateResponse.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: CompanyTokenTransactionCreateResponse.Member;
+    /**
+     * The type of transaction
+     */
+    transaction_type: 'add' | 'subtract' | 'transfer';
+    /**
+     * The user whose balance changed
+     */
+    user: CompanyTokenTransactionCreateResponse.User;
+}
+export declare namespace CompanyTokenTransactionCreateResponse {
+    /**
+     * The company
+     */
+    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
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The user whose balance changed
+     */
+    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 CompanyTokenTransactionRetrieveResponse {
+    /**
+     * The ID of the transaction
+     */
+    id: string;
+    /**
+     * The transaction amount (always positive)
+     */
+    amount: number;
+    /**
+     * The company
+     */
+    company: CompanyTokenTransactionRetrieveResponse.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: CompanyTokenTransactionRetrieveResponse.Member;
+    /**
+     * The type of transaction
+     */
+    transaction_type: 'add' | 'subtract' | 'transfer';
+    /**
+     * The user whose balance changed
+     */
+    user: CompanyTokenTransactionRetrieveResponse.User;
+}
+export declare namespace CompanyTokenTransactionRetrieveResponse {
+    /**
+     * The company
+     */
+    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
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The user whose balance changed
+     */
+    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: 'add' | 'subtract' | 'transfer';
+    /**
+     * The user whose balance changed
+     */
+    user: CompanyTokenTransactionListResponse.User;
+}
+export declare namespace CompanyTokenTransactionListResponse {
+    /**
+     * The company
+     */
+    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
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The user whose balance changed
+     */
+    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 {
+    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;
+    }
+    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;
+    }
+    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?: 'add' | 'subtract' | 'transfer' | null;
+    /**
+     * Filter by user ID
+     */
+    user_id?: string | null;
+}
+export declare namespace CompanyTokenTransactions {
+    export { type CompanyTokenTransactionCreateResponse as CompanyTokenTransactionCreateResponse, type CompanyTokenTransactionRetrieveResponse as CompanyTokenTransactionRetrieveResponse, type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse, type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage, type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams, type CompanyTokenTransactionListParams as CompanyTokenTransactionListParams, };
+}
+//# sourceMappingURL=company-token-transactions.d.mts.map

package/resources/company-token-transactions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"company-token-transactions.d.mts","sourceRoot":"","sources":["../src/resources/company-token-transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAIpD;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uCAAuC,CAAC;IAInG;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,mCAAmC,CAAC;CAOpG;AAED,MAAM,MAAM,8CAA8C,GAAG,UAAU,CAAC,mCAAmC,CAAC,CAAC;AAE7G;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,qCAAqC,CAAC,OAAO,CAAC;IAEvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,qCAAqC,CAAC,MAAM,CAAC;IAErD;;OAEG;IACH,gBAAgB,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,qCAAqC,CAAC,IAAI,CAAC;CAClD;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,uCAAuC,CAAC,OAAO,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,uCAAuC,CAAC,MAAM,CAAC;IAEvD;;OAEG;IACH,gBAAgB,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,uCAAuC,CAAC,IAAI,CAAC;CACpD;AAED,yBAAiB,uCAAuC,CAAC;IACvD;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,mCAAmC,CAAC,OAAO,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,mCAAmC,CAAC,MAAM,CAAC;IAEnD;;OAEG;IACH,gBAAgB,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,mCAAmC,CAAC,IAAI,CAAC;CAChD;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,MAAM,mCAAmC,GAC3C,mCAAmC,CAAC,yDAAyD,GAC7F,mCAAmC,CAAC,oDAAoD,GACxF,mCAAmC,CAAC,yDAAyD,CAAC;AAElG,MAAM,CAAC,OAAO,WAAW,mCAAmC,CAAC;IAC3D,UAAiB,yDAAyD;QACxE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B,gBAAgB,EAAE,UAAU,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,oDAAoD;QACnE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,gBAAgB,EAAE,KAAK,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,yDAAyD;QACxE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,gBAAgB,EAAE,UAAU,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}