@whop/sdk 0.0.6 → 0.0.8

package/src/resources/withdrawals.ts

@@ -0,0 +1,361 @@
+// 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 Withdrawals extends APIResource {
+  /**
+   * Retrieves a withdrawal by ID
+   *
+   * Required permissions:
+   *
+   * - `payout:withdrawal:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<WithdrawalRetrieveResponse> {
+    return this._client.get(path`/withdrawals/${id}`, options);
+  }
+
+  /**
+   * Lists withdrawals
+   *
+   * Required permissions:
+   *
+   * - `payout:withdrawal:read`
+   */
+  list(
+    query: WithdrawalListParams,
+    options?: RequestOptions,
+  ): PagePromise<WithdrawalListResponsesCursorPage, WithdrawalListResponse> {
+    return this._client.getAPIList('/withdrawals', CursorPage<WithdrawalListResponse>, { query, ...options });
+  }
+}
+
+export type WithdrawalListResponsesCursorPage = CursorPage<WithdrawalListResponse>;
+
+/**
+ * The different fee types for a withdrawal.
+ */
+export type WithdrawalFeeTypes = 'exclusive' | 'inclusive';
+
+/**
+ * The different speeds of withdrawals
+ */
+export type WithdrawalSpeeds = 'standard' | 'instant';
+
+/**
+ * The status of a withdrawal request
+ */
+export type WithdrawalStatus =
+  | 'requested'
+  | 'awaiting_payment'
+  | 'in_transit'
+  | 'completed'
+  | 'failed'
+  | 'canceled'
+  | 'denied';
+
+/**
+ * The types of withdrawals
+ */
+export type WithdrawalTypes = 'regular' | 'clawback';
+
+/**
+ * A withdrawal request.
+ */
+export interface WithdrawalRetrieveResponse {
+  /**
+   * Internal ID of the withdrawal request.
+   */
+  id: string;
+
+  /**
+   * How much money was attempted to be withdrawn, in a float type.
+   */
+  amount: number;
+
+  /**
+   * When the withdrawal request was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency of the withdrawal request.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The fee amount that was charged for the withdrawal. This is in the same currency
+   * as the withdrawal amount.
+   */
+  fee_amount: number;
+
+  /**
+   * The different fee types for a withdrawal.
+   */
+  fee_type: WithdrawalFeeTypes | null;
+
+  /**
+   * The latest payout associated with this withdrawal, if any.
+   */
+  latest_payout: WithdrawalRetrieveResponse.LatestPayout | null;
+
+  /**
+   * The payout token used for the withdrawal, if applicable.
+   */
+  payout_token: WithdrawalRetrieveResponse.PayoutToken | null;
+
+  /**
+   * The speed of the withdrawal.
+   */
+  speed: WithdrawalSpeeds;
+
+  /**
+   * Status of the withdrawal.
+   */
+  status: WithdrawalStatus;
+
+  /**
+   * The type of withdrawal.
+   */
+  withdrawal_type: WithdrawalTypes;
+}
+
+export namespace WithdrawalRetrieveResponse {
+  /**
+   * The latest payout associated with this withdrawal, if any.
+   */
+  export interface LatestPayout {
+    /**
+     * The internal ID of the payout.
+     */
+    id: string;
+
+    /**
+     * The date and time the payout was created.
+     */
+    created_at: string;
+
+    /**
+     * 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_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;
+
+    /**
+     * The error message for the payout.
+     */
+    error_message: string | null;
+
+    /**
+     * The estimated availability date of the payout.
+     */
+    estimated_availability: string | null;
+
+    /**
+     * The name of the payer for the payout.
+     */
+    payer_name: string | null;
+
+    /**
+     * The status of the payout.
+     */
+    status:
+      | 'scheduled'
+      | 'pending'
+      | 'processing'
+      | 'completed'
+      | 'canceled'
+      | 'ready_for_pickup'
+      | 'hold'
+      | 'error'
+      | 'expired';
+
+    /**
+     * The trace code for the payout, if applicable. Provided on ACH transactions when
+     * available.
+     */
+    trace_code: string | null;
+  }
+
+  /**
+   * The payout token used for the withdrawal, if applicable.
+   */
+  export interface PayoutToken {
+    /**
+     * The ID of the payout token
+     */
+    id: string;
+
+    /**
+     * The date and time the payout token was created
+     */
+    created_at: string;
+
+    /**
+     * The currency code of the payout destination. This is the currency that payouts
+     * will be made in for this token.
+     */
+    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.
+     */
+    nickname: string | null;
+
+    /**
+     * The status of the payout token.
+     */
+    status: 'created' | 'active' | 'broken';
+  }
+}
+
+/**
+ * A withdrawal request.
+ */
+export interface WithdrawalListResponse {
+  /**
+   * Internal ID of the withdrawal request.
+   */
+  id: string;
+
+  /**
+   * How much money was attempted to be withdrawn, in a float type.
+   */
+  amount: number;
+
+  /**
+   * When the withdrawal request was created.
+   */
+  created_at: string;
+
+  /**
+   * The currency of the withdrawal request.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The fee amount that was charged for the withdrawal. This is in the same currency
+   * as the withdrawal amount.
+   */
+  fee_amount: number;
+
+  /**
+   * The different fee types for a withdrawal.
+   */
+  fee_type: WithdrawalFeeTypes | null;
+
+  /**
+   * The speed of the withdrawal.
+   */
+  speed: WithdrawalSpeeds;
+
+  /**
+   * Status of the withdrawal.
+   */
+  status: WithdrawalStatus;
+
+  /**
+   * The type of withdrawal.
+   */
+  withdrawal_type: WithdrawalTypes;
+}
+
+export interface WithdrawalListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list withdrawals for
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * The minimum creation date to filter by
+   */
+  created_after?: string | null;
+
+  /**
+   * The maximum creation date to filter by
+   */
+  created_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;
+}
+
+export declare namespace Withdrawals {
+  export {
+    type WithdrawalFeeTypes as WithdrawalFeeTypes,
+    type WithdrawalSpeeds as WithdrawalSpeeds,
+    type WithdrawalStatus as WithdrawalStatus,
+    type WithdrawalTypes as WithdrawalTypes,
+    type WithdrawalRetrieveResponse as WithdrawalRetrieveResponse,
+    type WithdrawalListResponse as WithdrawalListResponse,
+    type WithdrawalListResponsesCursorPage as WithdrawalListResponsesCursorPage,
+    type WithdrawalListParams as WithdrawalListParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.6'; // x-release-please-version
+export const VERSION = '0.0.8'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.6";
+export declare const VERSION = "0.0.8";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.6";
+export declare const VERSION = "0.0.8";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.6'; // x-release-please-version
+exports.VERSION = '0.0.8'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.6'; // x-release-please-version
+export const VERSION = '0.0.8'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map