@whop/sdk 0.0.27 → 0.0.28

package/resources/transfers.d.mts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Transfers extends APIResource {
     /**
-     * Creates a new transfer between ledger accounts
+     * Transfer funds between two ledger accounts, such as from a company balance to a
+     * user balance.
      *
      * Required permissions:
      *
@@ -23,7 +24,7 @@ export declare class Transfers extends APIResource {
      */
     create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer>;
     /**
-     * Retrieves a transfer by ID
+     * Retrieves the details of an existing transfer.
      *
      * Required permissions:
      *
@@ -38,7 +39,8 @@ export declare class Transfers extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer>;
     /**
-     * Lists transfers
+     * Returns a paginated list of fund transfers, filtered by origin or destination
+     * account, with optional sorting and date filtering.
      *
      * Required permissions:
      *
@@ -56,7 +58,7 @@ export declare class Transfers extends APIResource {
 }
 export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
 /**
- * Credit Transaction Transfer
+ * A transfer of credit between two ledger accounts.
  */
 export interface TransferListResponse {
     /**
@@ -64,8 +66,8 @@ export interface TransferListResponse {
      */
     id: string;
     /**
-     * The amount of the transfer. Provided as a number in the specified currency. Eg:
-     * 10.43 for $10.43 USD.
+     * The transfer amount in the currency specified by the currency field. For
+     * example, 10.43 represents $10.43 USD.
      */
     amount: number;
     /**
@@ -73,65 +75,69 @@ export interface TransferListResponse {
      */
     created_at: string;
     /**
-     * The currency of the credit transaction transfer
+     * The currency in which this transfer amount is denominated.
      */
     currency: Shared.Currency;
     /**
-     * The ID of the destination ledger account
+     * The unique identifier of the ledger account receiving the funds.
      */
     destination_ledger_account_id: string;
     /**
-     * The decimal fee of the credit transaction transfer
+     * The flat fee amount deducted from this transfer, in the transfer's currency.
+     * Null if no flat fee was applied.
      */
     fee_amount: number | null;
     /**
-     * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
-     * 5000 chars per value.
+     * Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
+     * characters per key, 5000 characters per value.
      */
     metadata: {
         [key: string]: unknown;
     } | null;
     /**
-     * The notes of the credit transaction transfer
+     * A free-text note attached to this transfer by the sender. Null if no note was
+     * provided.
      */
     notes: string | null;
     /**
-     * The ID of the origin ledger account
+     * The unique identifier of the ledger account that sent the funds.
      */
     origin_ledger_account_id: string;
 }
 export interface TransferCreateParams {
     /**
-     * The amount to transfer. Provided as a number in the specified currency. Eg:
-     * 25.00 for $25.00 USD.
+     * The amount to transfer in the specified currency. For example, 25.00 for $25.00
+     * USD.
      */
     amount: number;
     /**
-     * The currency that is being withdrawn.
+     * The currency of the transfer amount, such as 'usd'.
      */
     currency: Shared.Currency;
     /**
-     * The ID of the destination account which will receive the funds (either a User
-     * ID, Company ID, or LedgerAccount ID)
+     * The identifier of the account receiving the funds. Accepts a user ID
+     * ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
      */
     destination_id: string;
     /**
-     * The ID of the origin account which will send the funds (either a User ID,
-     * Company ID, or LedgerAccount ID)
+     * The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
+     * company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
      */
     origin_id: string;
     /**
-     * A unique key to ensure idempotence. Use a UUID or similar.
+     * A unique key to prevent duplicate transfers. Use a UUID or similar unique
+     * string.
      */
     idempotence_key?: string | null;
     /**
-     * A hash of metadata to attach to the transfer.
+     * A JSON object of custom metadata to attach to the transfer for tracking
+     * purposes.
      */
     metadata?: {
         [key: string]: unknown;
     } | null;
     /**
-     * Notes for the transfer. Maximum of 50 characters.
+     * A short note describing the transfer, up to 50 characters.
      */
     notes?: string | null;
 }
@@ -141,16 +147,16 @@ export interface TransferListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return transfers created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return transfers created before this timestamp.
      */
     created_before?: string | null;
     /**
-     * Filter transfers to only those that were sent to this destination account.
-     * (user_xxx, biz_xxx, ldgr_xxx)
+     * Filter to transfers received by this account. Accepts a user, company, or ledger
+     * account ID.
      */
     destination_id?: string | null;
     /**
@@ -170,8 +176,8 @@ export interface TransferListParams extends CursorPageParams {
      */
     order?: 'amount' | 'created_at' | null;
     /**
-     * Filter transfers to only those that were sent from this origin account.
-     * (user_xxx, biz_xxx, ldgr_xxx)
+     * Filter to transfers sent from this account. Accepts a user, company, or ledger
+     * account ID.
      */
     origin_id?: string | null;
 }

package/resources/transfers.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"transfers.d.mts","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"transfers.d.mts","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/transfers.d.ts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Transfers extends APIResource {
     /**
-     * Creates a new transfer between ledger accounts
+     * Transfer funds between two ledger accounts, such as from a company balance to a
+     * user balance.
      *
      * Required permissions:
      *
@@ -23,7 +24,7 @@ export declare class Transfers extends APIResource {
      */
     create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer>;
     /**
-     * Retrieves a transfer by ID
+     * Retrieves the details of an existing transfer.
      *
      * Required permissions:
      *
@@ -38,7 +39,8 @@ export declare class Transfers extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer>;
     /**
-     * Lists transfers
+     * Returns a paginated list of fund transfers, filtered by origin or destination
+     * account, with optional sorting and date filtering.
      *
      * Required permissions:
      *
@@ -56,7 +58,7 @@ export declare class Transfers extends APIResource {
 }
 export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
 /**
- * Credit Transaction Transfer
+ * A transfer of credit between two ledger accounts.
  */
 export interface TransferListResponse {
     /**
@@ -64,8 +66,8 @@ export interface TransferListResponse {
      */
     id: string;
     /**
-     * The amount of the transfer. Provided as a number in the specified currency. Eg:
-     * 10.43 for $10.43 USD.
+     * The transfer amount in the currency specified by the currency field. For
+     * example, 10.43 represents $10.43 USD.
      */
     amount: number;
     /**
@@ -73,65 +75,69 @@ export interface TransferListResponse {
      */
     created_at: string;
     /**
-     * The currency of the credit transaction transfer
+     * The currency in which this transfer amount is denominated.
      */
     currency: Shared.Currency;
     /**
-     * The ID of the destination ledger account
+     * The unique identifier of the ledger account receiving the funds.
      */
     destination_ledger_account_id: string;
     /**
-     * The decimal fee of the credit transaction transfer
+     * The flat fee amount deducted from this transfer, in the transfer's currency.
+     * Null if no flat fee was applied.
      */
     fee_amount: number | null;
     /**
-     * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
-     * 5000 chars per value.
+     * Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
+     * characters per key, 5000 characters per value.
      */
     metadata: {
         [key: string]: unknown;
     } | null;
     /**
-     * The notes of the credit transaction transfer
+     * A free-text note attached to this transfer by the sender. Null if no note was
+     * provided.
      */
     notes: string | null;
     /**
-     * The ID of the origin ledger account
+     * The unique identifier of the ledger account that sent the funds.
      */
     origin_ledger_account_id: string;
 }
 export interface TransferCreateParams {
     /**
-     * The amount to transfer. Provided as a number in the specified currency. Eg:
-     * 25.00 for $25.00 USD.
+     * The amount to transfer in the specified currency. For example, 25.00 for $25.00
+     * USD.
      */
     amount: number;
     /**
-     * The currency that is being withdrawn.
+     * The currency of the transfer amount, such as 'usd'.
      */
     currency: Shared.Currency;
     /**
-     * The ID of the destination account which will receive the funds (either a User
-     * ID, Company ID, or LedgerAccount ID)
+     * The identifier of the account receiving the funds. Accepts a user ID
+     * ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
      */
     destination_id: string;
     /**
-     * The ID of the origin account which will send the funds (either a User ID,
-     * Company ID, or LedgerAccount ID)
+     * The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
+     * company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
      */
     origin_id: string;
     /**
-     * A unique key to ensure idempotence. Use a UUID or similar.
+     * A unique key to prevent duplicate transfers. Use a UUID or similar unique
+     * string.
      */
     idempotence_key?: string | null;
     /**
-     * A hash of metadata to attach to the transfer.
+     * A JSON object of custom metadata to attach to the transfer for tracking
+     * purposes.
      */
     metadata?: {
         [key: string]: unknown;
     } | null;
     /**
-     * Notes for the transfer. Maximum of 50 characters.
+     * A short note describing the transfer, up to 50 characters.
      */
     notes?: string | null;
 }
@@ -141,16 +147,16 @@ export interface TransferListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return transfers created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return transfers created before this timestamp.
      */
     created_before?: string | null;
     /**
-     * Filter transfers to only those that were sent to this destination account.
-     * (user_xxx, biz_xxx, ldgr_xxx)
+     * Filter to transfers received by this account. Accepts a user, company, or ledger
+     * account ID.
      */
     destination_id?: string | null;
     /**
@@ -170,8 +176,8 @@ export interface TransferListParams extends CursorPageParams {
      */
     order?: 'amount' | 'created_at' | null;
     /**
-     * Filter transfers to only those that were sent from this origin account.
-     * (user_xxx, biz_xxx, ldgr_xxx)
+     * Filter to transfers sent from this account. Accepts a user, company, or ledger
+     * account ID.
      */
     origin_id?: string | null;
 }

package/resources/transfers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/transfers.js

@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class Transfers extends resource_1.APIResource {
     /**
-     * Creates a new transfer between ledger accounts
+     * Transfer funds between two ledger accounts, such as from a company balance to a
+     * user balance.
      *
      * Required permissions:
      *
@@ -27,7 +28,7 @@ class Transfers extends resource_1.APIResource {
         return this._client.post('/transfers', { body, ...options });
     }
     /**
-     * Retrieves a transfer by ID
+     * Retrieves the details of an existing transfer.
      *
      * Required permissions:
      *
@@ -44,7 +45,8 @@ class Transfers extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/transfers/${id}`, options);
     }
     /**
-     * Lists transfers
+     * Returns a paginated list of fund transfers, filtered by origin or destination
+     * account, with optional sorting and date filtering.
      *
      * Required permissions:
      *

package/resources/transfers.js.map

@@ -1 +1 @@
-{"version":3,"file":"transfers.js","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF;AA7DD,8BA6DC"}
+{"version":3,"file":"transfers.js","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF;AA/DD,8BA+DC"}

package/resources/transfers.mjs

@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Transfers extends APIResource {
     /**
-     * Creates a new transfer between ledger accounts
+     * Transfer funds between two ledger accounts, such as from a company balance to a
+     * user balance.
      *
      * Required permissions:
      *
@@ -24,7 +25,7 @@ export class Transfers extends APIResource {
         return this._client.post('/transfers', { body, ...options });
     }
     /**
-     * Retrieves a transfer by ID
+     * Retrieves the details of an existing transfer.
      *
      * Required permissions:
      *
@@ -41,7 +42,8 @@ export class Transfers extends APIResource {
         return this._client.get(path `/transfers/${id}`, options);
     }
     /**
-     * Lists transfers
+     * Returns a paginated list of fund transfers, filtered by origin or destination
+     * account, with optional sorting and date filtering.
      *
      * Required permissions:
      *

package/resources/transfers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"transfers.mjs","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF"}
+{"version":3,"file":"transfers.mjs","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF"}

package/resources/users.d.mts

@@ -4,15 +4,16 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Users extends APIResource {
     /**
-     * Retrieves a user by ID or username
+     * Retrieves the details of an existing user.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<User>;
     /**
-     * Check if a user has access (and their access level) to a resource
+     * Check whether a user has access to a specific resource, and return their access
+     * level.
      */
     checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
     /**
-     * Updates the current user's profile
+     * Update the currently authenticated user's profile.
      *
      * Required permissions:
      *
@@ -30,7 +31,7 @@ export interface User {
      */
     id: string;
     /**
-     * The user's bio
+     * A short biography written by the user, displayed on their public profile.
      */
     bio: string | null;
     /**
@@ -38,26 +39,28 @@ export interface User {
      */
     created_at: string;
     /**
-     * The name of the user from their Whop account.
+     * The user's display name shown on their public profile.
      */
     name: string | null;
     /**
-     * The user's profile picture
+     * The user's profile picture attachment with URL, content type, and file metadata.
+     * Null if using a legacy profile picture.
      */
     profile_picture: User.ProfilePicture | null;
     /**
-     * The username of the user from their Whop account.
+     * The user's unique username shown on their public profile.
      */
     username: string;
 }
 export declare namespace User {
     /**
-     * The user's profile picture
+     * The user's profile picture attachment with URL, content type, and file metadata.
+     * Null if using a legacy profile picture.
      */
     interface ProfilePicture {
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
@@ -77,31 +80,32 @@ export interface UserCheckAccessResponse {
 }
 export interface UserCheckAccessParams {
     /**
-     * The ID (user_xxx) or username of the user
+     * The unique identifier or username of the user.
      */
     id: string;
 }
 export interface UserUpdateProfileParams {
     /**
-     * User biography
+     * A short biography displayed on the user's public profile.
      */
     bio?: string | null;
     /**
-     * Display name
+     * The user's display name shown on their public profile. Maximum 100 characters.
      */
     name?: string | null;
     /**
-     * Profile picture
+     * The user's profile picture image attachment.
      */
     profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
     /**
-     * Username (alphanumeric and hyphens)
+     * The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
+     * characters.
      */
     username?: string | null;
 }
 export declare namespace UserUpdateProfileParams {
     /**
-     * Profile picture
+     * The user's profile picture image attachment.
      */
     interface ProfilePicture {
         /**

package/resources/users.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;OAEG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;OAMG;IACH,aAAa,CACX,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAGpB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;OAGG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;OAMG;IACH,aAAa,CACX,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAGpB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/users.d.ts

@@ -4,15 +4,16 @@ import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Users extends APIResource {
     /**
-     * Retrieves a user by ID or username
+     * Retrieves the details of an existing user.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<User>;
     /**
-     * Check if a user has access (and their access level) to a resource
+     * Check whether a user has access to a specific resource, and return their access
+     * level.
      */
     checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
     /**
-     * Updates the current user's profile
+     * Update the currently authenticated user's profile.
      *
      * Required permissions:
      *
@@ -30,7 +31,7 @@ export interface User {
      */
     id: string;
     /**
-     * The user's bio
+     * A short biography written by the user, displayed on their public profile.
      */
     bio: string | null;
     /**
@@ -38,26 +39,28 @@ export interface User {
      */
     created_at: string;
     /**
-     * The name of the user from their Whop account.
+     * The user's display name shown on their public profile.
      */
     name: string | null;
     /**
-     * The user's profile picture
+     * The user's profile picture attachment with URL, content type, and file metadata.
+     * Null if using a legacy profile picture.
      */
     profile_picture: User.ProfilePicture | null;
     /**
-     * The username of the user from their Whop account.
+     * The user's unique username shown on their public profile.
      */
     username: string;
 }
 export declare namespace User {
     /**
-     * The user's profile picture
+     * The user's profile picture attachment with URL, content type, and file metadata.
+     * Null if using a legacy profile picture.
      */
     interface ProfilePicture {
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
@@ -77,31 +80,32 @@ export interface UserCheckAccessResponse {
 }
 export interface UserCheckAccessParams {
     /**
-     * The ID (user_xxx) or username of the user
+     * The unique identifier or username of the user.
      */
     id: string;
 }
 export interface UserUpdateProfileParams {
     /**
-     * User biography
+     * A short biography displayed on the user's public profile.
      */
     bio?: string | null;
     /**
-     * Display name
+     * The user's display name shown on their public profile. Maximum 100 characters.
      */
     name?: string | null;
     /**
-     * Profile picture
+     * The user's profile picture image attachment.
      */
     profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
     /**
-     * Username (alphanumeric and hyphens)
+     * The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
+     * characters.
      */
     username?: string | null;
 }
 export declare namespace UserUpdateProfileParams {
     /**
-     * Profile picture
+     * The user's profile picture image attachment.
      */
     interface ProfilePicture {
         /**