@whop/sdk 0.0.27 → 0.0.28

package/resources/withdrawals.d.ts

@@ -23,7 +23,7 @@ export declare class Withdrawals extends APIResource {
      */
     create(body: WithdrawalCreateParams, options?: RequestOptions): APIPromise<Withdrawal>;
     /**
-     * Retrieves a withdrawal by ID
+     * Retrieves the details of an existing withdrawal.
      *
      * Required permissions:
      *
@@ -39,7 +39,8 @@ export declare class Withdrawals extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Withdrawal>;
     /**
-     * Lists withdrawals
+     * Returns a paginated list of withdrawals for a company, with optional sorting and
+     * date filtering.
      *
      * Required permissions:
      *
@@ -59,8 +60,8 @@ export declare class Withdrawals extends APIResource {
 }
 export type WithdrawalListResponsesCursorPage = CursorPage<WithdrawalListResponse>;
 /**
- * A withdrawal represents a request to transfer funds from a company's ledger
- * account to an external payout method.
+ * A withdrawal represents a request to transfer funds from a ledger account to an
+ * external payout method.
  */
 export interface Withdrawal {
     /**
@@ -68,8 +69,8 @@ export interface Withdrawal {
      */
     id: string;
     /**
-     * The withdrawal amount. Provided as a number in the specified currency. Eg:
-     * 100.00 for $100.00 USD.
+     * The withdrawal amount as a decimal number in the specified currency (e.g.,
+     * 100.00 for $100.00 USD).
      */
     amount: number;
     /**
@@ -77,24 +78,26 @@ export interface Withdrawal {
      */
     created_at: string;
     /**
-     * The currency of the withdrawal request.
+     * The three-letter ISO currency code for this withdrawal (e.g., 'usd', 'eur').
      */
     currency: Shared.Currency;
     /**
      * The different error codes a payout can be in.
      */
-    error_code: 'account_closed' | 'account_does_not_exist' | 'account_information_invalid' | 'account_number_invalid_region' | 'account_frozen' | 'account_lookup_failed' | 'account_not_found' | 'amount_out_of_bounds' | 'attributes_not_validated' | 'b2b_payments_prohibited' | 'bank_statement_required' | 'compliance_review' | 'currency_not_supported' | 'deposit_canceled' | 'deposit_failed' | 'deposit_rejected' | 'destination_unavailable' | 'exceeded_account_limit' | 'expired_quote' | 'generic_payout_error' | 'technical_problem' | 'identification_number_invalid' | 'invalid_account_number' | 'invalid_bank_code' | 'invalid_beneficiary' | 'invalid_mailing_address' | 'invalid_branch_number' | 'invalid_branch_code' | 'invalid_phone_number' | 'invalid_routing_number' | 'invalid_swift_code' | 'invalid_company_details' | 'manual_cancelation' | 'misc_error' | 'missing_city_and_country' | 'missing_phone_number' | 'missing_remittance_info' | 'payee_name_invalid' | 'receiving_account_locked' | 'rejected_by_compliance' | 'rtp_not_supported' | 'non_transaction_account' | 'source_token_insufficient_funds' | 'ssn_invalid' | 'wallet_screenshot_required' | 'unsupported_region' | null;
+    error_code: 'account_closed' | 'account_does_not_exist' | 'account_information_invalid' | 'account_number_invalid_region' | 'account_frozen' | 'account_lookup_failed' | 'account_not_found' | 'amount_out_of_bounds' | 'attributes_not_validated' | 'b2b_payments_prohibited' | 'bank_statement_required' | 'compliance_review' | 'currency_not_supported' | 'deposit_canceled' | 'deposit_failed' | 'deposit_rejected' | 'destination_unavailable' | 'exceeded_account_limit' | 'expired_quote' | 'generic_payout_error' | 'technical_problem' | 'identification_number_invalid' | 'invalid_account_number' | 'invalid_bank_code' | 'invalid_beneficiary' | 'invalid_mailing_address' | 'invalid_branch_number' | 'invalid_branch_code' | 'invalid_phone_number' | 'invalid_routing_number' | 'invalid_swift_code' | 'invalid_company_details' | 'manual_cancelation' | 'misc_error' | 'missing_city_and_country' | 'missing_phone_number' | 'missing_remittance_info' | 'payee_name_invalid' | 'receiving_account_locked' | 'rejected_by_compliance' | 'rtp_not_supported' | 'non_transaction_account' | 'source_token_insufficient_funds' | 'ssn_invalid' | 'wallet_screenshot_required' | 'unsupported_region' | 'payout_provider_timeout' | null;
     /**
-     * The error message for the withdrawal, if any.
+     * A human-readable message describing why the payout failed. Null if no error
+     * occurred.
      */
     error_message: string | null;
     /**
-     * The estimated availability date for the withdrawal, if any.
+     * The estimated time at which the funds become available in the destination
+     * account. Null if no estimate is available. As a Unix timestamp.
      */
     estimated_availability: string | null;
     /**
-     * The fee amount that was charged for the withdrawal. This is in the same currency
-     * as the withdrawal amount.
+     * The fee charged for processing this withdrawal, in the same currency as the
+     * withdrawal amount.
      */
     fee_amount: number;
     /**
@@ -102,36 +105,37 @@ export interface Withdrawal {
      */
     fee_type: WithdrawalFeeTypes | null;
     /**
-     * The ledger account associated with the withdrawal.
+     * The ledger account from which the withdrawal funds are sourced.
      */
     ledger_account: Withdrawal.LedgerAccount;
     /**
-     * The markup fee that was charged for the withdrawal. This is in the same currency
-     * as the withdrawal amount. This only applies to platform accounts using Whop
-     * Rails.
+     * An additional markup fee charged for the withdrawal, in the same currency as the
+     * withdrawal amount. Only applies to platform accounts using Whop Rails.
      */
     markup_fee: number;
     /**
-     * The payout token used for the withdrawal, if applicable.
+     * The saved payout destination used for this withdrawal (e.g., a bank account or
+     * PayPal address). Null if no payout token was used.
      */
     payout_token: Withdrawal.PayoutToken | null;
     /**
-     * The speed of the withdrawal.
+     * The processing speed selected for this withdrawal ('standard' or 'instant').
      */
     speed: WithdrawalSpeeds;
     /**
-     * Status of the withdrawal.
+     * The computed lifecycle status of the withdrawal, accounting for the state of
+     * associated payouts (e.g., 'requested', 'in_transit', 'completed', 'failed').
      */
     status: WithdrawalStatus;
     /**
-     * The trace code for the payout, if applicable. Provided on ACH transactions when
-     * available.
+     * The ACH trace number for tracking the payout through the banking network. Null
+     * if not available or not an ACH transaction.
      */
     trace_code: string | null;
 }
 export declare namespace Withdrawal {
     /**
-     * The ledger account associated with the withdrawal.
+     * The ledger account from which the withdrawal funds are sourced.
      */
     interface LedgerAccount {
         /**
@@ -139,12 +143,17 @@ export declare namespace Withdrawal {
          */
         id: string;
         /**
-         * The ID of the company associated with this ledger account.
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         company_id: string | null;
     }
     /**
-     * The payout token used for the withdrawal, if applicable.
+     * The saved payout destination used for this withdrawal (e.g., a bank account or
+     * PayPal address). Null if no payout token was used.
      */
     interface PayoutToken {
         /**
@@ -156,17 +165,17 @@ export declare namespace Withdrawal {
          */
         created_at: string;
         /**
-         * The currency code of the payout destination. This is the currency that payouts
-         * will be made in for this token.
+         * The three-letter ISO currency code that payouts are delivered in for this
+         * destination.
          */
         destination_currency_code: string;
         /**
-         * An optional nickname for the payout token to help the user identify it. This is
-         * not used by the provider and is only for the user's reference.
+         * A user-defined label to help identify this payout destination. Not sent to the
+         * provider. Null if no nickname has been set.
          */
         nickname: string | null;
         /**
-         * The name of the payer associated with the payout token.
+         * The legal name of the account holder receiving payouts. Null if not provided.
          */
         payer_name: string | null;
     }
@@ -184,8 +193,8 @@ export type WithdrawalSpeeds = 'standard' | 'instant';
  */
 export type WithdrawalStatus = 'requested' | 'awaiting_payment' | 'in_transit' | 'completed' | 'failed' | 'canceled' | 'denied';
 /**
- * A withdrawal represents a request to transfer funds from a company's ledger
- * account to an external payout method.
+ * A withdrawal represents a request to transfer funds from a ledger account to an
+ * external payout method.
  */
 export interface WithdrawalListResponse {
     /**
@@ -193,8 +202,8 @@ export interface WithdrawalListResponse {
      */
     id: string;
     /**
-     * The withdrawal amount. Provided as a number in the specified currency. Eg:
-     * 100.00 for $100.00 USD.
+     * The withdrawal amount as a decimal number in the specified currency (e.g.,
+     * 100.00 for $100.00 USD).
      */
     amount: number;
     /**
@@ -202,12 +211,12 @@ export interface WithdrawalListResponse {
      */
     created_at: string;
     /**
-     * The currency of the withdrawal request.
+     * The three-letter ISO currency code for this withdrawal (e.g., 'usd', 'eur').
      */
     currency: Shared.Currency;
     /**
-     * The fee amount that was charged for the withdrawal. This is in the same currency
-     * as the withdrawal amount.
+     * The fee charged for processing this withdrawal, in the same currency as the
+     * withdrawal amount.
      */
     fee_amount: number;
     /**
@@ -215,17 +224,17 @@ export interface WithdrawalListResponse {
      */
     fee_type: WithdrawalFeeTypes | null;
     /**
-     * The markup fee that was charged for the withdrawal. This is in the same currency
-     * as the withdrawal amount. This only applies to platform accounts using Whop
-     * Rails.
+     * An additional markup fee charged for the withdrawal, in the same currency as the
+     * withdrawal amount. Only applies to platform accounts using Whop Rails.
      */
     markup_fee: number;
     /**
-     * The speed of the withdrawal.
+     * The processing speed selected for this withdrawal ('standard' or 'instant').
      */
     speed: WithdrawalSpeeds;
     /**
-     * Status of the withdrawal.
+     * The computed lifecycle status of the withdrawal, accounting for the state of
+     * associated payouts (e.g., 'requested', 'in_transit', 'completed', 'failed').
      */
     status: WithdrawalStatus;
 }
@@ -258,7 +267,7 @@ export interface WithdrawalCreateParams {
 }
 export interface WithdrawalListParams extends CursorPageParams {
     /**
-     * The ID of the company to list withdrawals for
+     * The unique identifier of the company to list withdrawals for.
      */
     company_id: string;
     /**
@@ -266,11 +275,11 @@ export interface WithdrawalListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return withdrawals created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return withdrawals created before this timestamp.
      */
     created_before?: string | null;
     /**

package/resources/withdrawals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withdrawals.d.ts","sourceRoot":"","sources":["../src/resources/withdrawals.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;CAG1E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;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,UAAU,EACN,gBAAgB,GAChB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,sBAAsB,GACtB,0BAA0B,GAC1B,yBAAyB,GACzB,yBAAyB,GACzB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,yBAAyB,GACzB,wBAAwB,GACxB,eAAe,GACf,sBAAsB,GACtB,mBAAmB,GACnB,+BAA+B,GAC/B,wBAAwB,GACxB,mBAAmB,GACnB,qBAAqB,GACrB,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,oBAAoB,GACpB,YAAY,GACZ,0BAA0B,GAC1B,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,wBAAwB,GACxB,mBAAmB,GACnB,yBAAyB,GACzB,iCAAiC,GACjC,aAAa,GACb,4BAA4B,GAC5B,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC,aAAa,CAAC;IAEzC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;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;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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;;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;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"withdrawals.d.ts","sourceRoot":"","sources":["../src/resources/withdrawals.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;CAG1E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;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,UAAU,EACN,gBAAgB,GAChB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,sBAAsB,GACtB,0BAA0B,GAC1B,yBAAyB,GACzB,yBAAyB,GACzB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,yBAAyB,GACzB,wBAAwB,GACxB,eAAe,GACf,sBAAsB,GACtB,mBAAmB,GACnB,+BAA+B,GAC/B,wBAAwB,GACxB,mBAAmB,GACnB,qBAAqB,GACrB,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,oBAAoB,GACpB,YAAY,GACZ,0BAA0B,GAC1B,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,wBAAwB,GACxB,mBAAmB,GACnB,yBAAyB,GACzB,iCAAiC,GACjC,aAAa,GACb,4BAA4B,GAC5B,oBAAoB,GACpB,yBAAyB,GACzB,IAAI,CAAC;IAET;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC,aAAa,CAAC;IAEzC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;;;WAMG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;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;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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;;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;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/withdrawals.js

@@ -27,7 +27,7 @@ class Withdrawals extends resource_1.APIResource {
         return this._client.post('/withdrawals', { body, ...options });
     }
     /**
-     * Retrieves a withdrawal by ID
+     * Retrieves the details of an existing withdrawal.
      *
      * Required permissions:
      *
@@ -45,7 +45,8 @@ class Withdrawals extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/withdrawals/${id}`, options);
     }
     /**
-     * Lists withdrawals
+     * Returns a paginated list of withdrawals for a company, with optional sorting and
+     * date filtering.
      *
      * Required permissions:
      *

package/resources/withdrawals.js.map

@@ -1 +1 @@
-{"version":3,"file":"withdrawals.js","sourceRoot":"","sources":["../src/resources/withdrawals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF;AAhED,kCAgEC"}
+{"version":3,"file":"withdrawals.js","sourceRoot":"","sources":["../src/resources/withdrawals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF;AAjED,kCAiEC"}

package/resources/withdrawals.mjs

@@ -24,7 +24,7 @@ export class Withdrawals extends APIResource {
         return this._client.post('/withdrawals', { body, ...options });
     }
     /**
-     * Retrieves a withdrawal by ID
+     * Retrieves the details of an existing withdrawal.
      *
      * Required permissions:
      *
@@ -42,7 +42,8 @@ export class Withdrawals extends APIResource {
         return this._client.get(path `/withdrawals/${id}`, options);
     }
     /**
-     * Lists withdrawals
+     * Returns a paginated list of withdrawals for a company, with optional sorting and
+     * date filtering.
      *
      * Required permissions:
      *

package/resources/withdrawals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"withdrawals.mjs","sourceRoot":"","sources":["../src/resources/withdrawals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF"}
+{"version":3,"file":"withdrawals.mjs","sourceRoot":"","sources":["../src/resources/withdrawals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF"}

package/src/client.ts

@@ -78,12 +78,12 @@ import {
   CompanyUpdateParams,
 } from './resources/companies';
 import {
-  BotTokenTransactionTypes,
   CompanyTokenTransaction,
   CompanyTokenTransactionCreateParams,
   CompanyTokenTransactionListParams,
   CompanyTokenTransactionListResponse,
   CompanyTokenTransactionListResponsesCursorPage,
+  CompanyTokenTransactionType,
   CompanyTokenTransactions,
 } from './resources/company-token-transactions';
 import {
@@ -302,6 +302,7 @@ import {
   Plans,
 } from './resources/plans';
 import {
+  IndustryGroups,
   ProductCreateParams,
   ProductDeleteResponse,
   ProductListParams,
@@ -879,7 +880,7 @@ export class Whop {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -1153,6 +1154,14 @@ export class Whop {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body as Record<string, unknown>),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -1310,6 +1319,7 @@ export declare namespace Whop {
 
   export {
     Products as Products,
+    type IndustryGroups as IndustryGroups,
     type ProductDeleteResponse as ProductDeleteResponse,
     type ProductCreateParams as ProductCreateParams,
     type ProductUpdateParams as ProductUpdateParams,
@@ -1735,8 +1745,8 @@ export declare namespace Whop {
 
   export {
     CompanyTokenTransactions as CompanyTokenTransactions,
-    type BotTokenTransactionTypes as BotTokenTransactionTypes,
     type CompanyTokenTransaction as CompanyTokenTransaction,
+    type CompanyTokenTransactionType as CompanyTokenTransactionType,
     type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse,
     type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage,
     type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,

package/src/resources/access-tokens.ts

@@ -6,10 +6,10 @@ import { RequestOptions } from '../internal/request-options';
 
 export class AccessTokens extends APIResource {
   /**
-   * Create a short-lived access token to authenticate API requests. When using API
-   * key authentication, provide company_id or user_id. When using OAuth
-   * authentication, the user is derived from the token. This token should be used
-   * with Whop's web and mobile embedded components.
+   * Create a short-lived access token for authenticating API requests. When using
+   * API key authentication, provide company_id or user_id. When using OAuth, the
+   * user is derived from the token. Use this token with Whop's web and mobile
+   * embedded components.
    *
    * @example
    * ```ts
@@ -25,47 +25,46 @@ export class AccessTokens extends APIResource {
 }
 
 /**
- * An object representing an access token used for authenticating API requests.
+ * A short-lived access token used to authenticate API requests on behalf of a
+ * user.
  */
 export interface AccessTokenCreateResponse {
   /**
-   * The JWT access token string.
+   * The signed JWT access token string to include in API request Authorization
+   * headers.
    */
   token: string;
 
   /**
-   * The expiration timestamp of the access token.
+   * The timestamp after which this access token is no longer valid and must be
+   * refreshed.
    */
   expires_at: string;
 }
 
 export interface AccessTokenCreateParams {
   /**
-   * The ID of the Company to generate the token for. The API key must have
-   * permission to access this Company, such as the being the company the API key
-   * belongs to or a sub-merchant of it
+   * The unique identifier of the company to generate the token for, starting with
+   * 'biz\_'. The API key must have permission to access this company.
    */
   company_id?: string | null;
 
   /**
-   * The expiration timestamp for the access token. If not provided, a default
-   * expiration time of 1 hour will be used. The expiration can be set to a maximum
-   * of 3 hours from the current time.
+   * The expiration timestamp for the access token. Defaults to 1 hour from now, with
+   * a maximum of 3 hours.
    */
   expires_at?: string | null;
 
   /**
-   * Array of desired scoped actions for the access token. If sent as an empty array
-   * or not provided, all permissions from the authenticating credential (API key or
-   * OAuth token) will be available on the token. If sending an explicit list, they
-   * must be a subset of the credential's existing permissions. Otherwise, an error
-   * will be raised.
+   * An array of permission scopes to grant to the access token. If empty or omitted,
+   * all permissions from the authenticating credential are inherited. Must be a
+   * subset of the credential's permissions.
    */
   scoped_actions?: Array<string> | null;
 
   /**
-   * The ID of the User to generate the token for. The API key must have permission
-   * to access this User.
+   * The unique identifier of the user to generate the token for, starting with
+   * 'user\_'. The API key must have permission to access this user.
    */
   user_id?: string | null;
 }

package/src/resources/account-links.ts

@@ -6,9 +6,8 @@ import { RequestOptions } from '../internal/request-options';
 
 export class AccountLinks extends APIResource {
   /**
-   * Generates a url that a user can be directed to in order to access their
-   * sub-merchant account. For example, they can visit the hosted payouts portal or
-   * the hosted KYC onboarding flow.
+   * Generate a URL that directs a sub-merchant to their account portal, such as the
+   * hosted payouts dashboard or the KYC onboarding flow.
    *
    * @example
    * ```ts
@@ -26,41 +25,44 @@ export class AccountLinks extends APIResource {
 }
 
 /**
- * An object representing a url that a user can be directed to to access their
- * account.
+ * A temporary, time-limited URL that grants a user access to an external account
+ * management page.
  */
 export interface AccountLinkCreateResponse {
   /**
-   * The expiration timestamp of the url.
+   * The timestamp after which this account link URL is no longer valid.
    */
   expires_at: string;
 
   /**
-   * The URL to navigate the user to.
+   * The temporary URL to redirect the user to for account access. Expires at the
+   * time specified by expires_at.
    */
   url: string;
 }
 
 export interface AccountLinkCreateParams {
   /**
-   * The ID of the Company to generate the url for. The company must be a
-   * sub-merchant of the API key's company.
+   * The unique identifier of the company to generate the link for, starting with
+   * 'biz\_'. Must be a sub-merchant of the API key's company.
    */
   company_id: string;
 
   /**
-   * The URL to redirect to if the session expires and needs to be re-authenticated
-   * due to the token expiring.
+   * The URL to redirect the user to if the session expires and needs to be
+   * re-authenticated, such as 'https://example.com/refresh'.
    */
   refresh_url: string;
 
   /**
-   * The URL to redirect to when the customer wants to return to your site.
+   * The URL to redirect the user to when they want to return to your site, such as
+   * 'https://example.com/return'.
    */
   return_url: string;
 
   /**
-   * The use case for which the link will be used.
+   * The purpose of the account link, such as hosted payouts portal or hosted KYC
+   * onboarding.
    */
   use_case: 'account_onboarding' | 'payouts_portal';
 }