@depup/stripe 21.0.0-depup.0

package/types/BalanceSettingsResource.d.ts

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface BalanceSettingsRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface BalanceSettingsUpdateParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).
+       */
+      payments?: BalanceSettingsUpdateParams.Payments;
+    }
+
+    namespace BalanceSettingsUpdateParams {
+      interface Payments {
+        /**
+         * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).
+         */
+        debit_negative_balances?: boolean;
+
+        /**
+         * Settings specific to the account's payouts.
+         */
+        payouts?: Payments.Payouts;
+
+        /**
+         * Settings related to the account's balance settlement timing.
+         */
+        settlement_timing?: Payments.SettlementTiming;
+      }
+
+      namespace Payments {
+        interface Payouts {
+          /**
+           * The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](https://docs.stripe.com/payouts/minimum-balances-for-automatic-payouts).
+           */
+          minimum_balance_by_currency?: Stripe.Emptyable<{
+            [key: string]: Stripe.Emptyable<number>;
+          }>;
+
+          /**
+           * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.
+           */
+          schedule?: Payouts.Schedule;
+
+          /**
+           * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace Payouts {
+          interface Schedule {
+            /**
+             * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
+             */
+            interval?: Schedule.Interval;
+
+            /**
+             * The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
+             */
+            monthly_payout_days?: Array<number>;
+
+            /**
+             * The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
+             */
+            weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          }
+
+          namespace Schedule {
+            type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+            type WeeklyPayoutDay =
+              | 'friday'
+              | 'monday'
+              | 'thursday'
+              | 'tuesday'
+              | 'wednesday';
+          }
+        }
+
+        interface SettlementTiming {
+          /**
+           * Change `delay_days` for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 31. Passing an empty string to `delay_days_override` will return `delay_days` to the default, which is the lowest available value for the account. [Learn more about controlling delay days](https://docs.stripe.com/connect/manage-payout-schedule).
+           */
+          delay_days_override?: Stripe.Emptyable<number>;
+        }
+      }
+    }
+
+    class BalanceSettingsResource {
+      /**
+       * Retrieves balance settings for a given connected account.
+       *  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
+       */
+      retrieve(
+        params?: BalanceSettingsRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+      retrieve(
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+
+      /**
+       * Updates balance settings for a given connected account.
+       *  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
+       */
+      update(
+        params?: BalanceSettingsUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+    }
+  }
+}

package/types/BalanceTransactionSources.d.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    type BalanceTransactionSource =
+      | ApplicationFee
+      | Charge
+      | ConnectCollectionTransfer
+      | CustomerCashBalanceTransaction
+      | Dispute
+      | FeeRefund
+      | Issuing.Authorization
+      | Issuing.Dispute
+      | Issuing.Transaction
+      | Payout
+      | Refund
+      | ReserveTransaction
+      | TaxDeductedAtSource
+      | Topup
+      | Transfer
+      | TransferReversal;
+  }
+}

package/types/BalanceTransactions.d.ts

@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Balance transactions represent funds moving through your Stripe account.
+     * Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
+     *
+     * Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)
+     */
+    interface BalanceTransaction {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'balance_transaction';
+
+      /**
+       * Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
+       */
+      amount: number;
+
+      /**
+       * The date that the transaction's net funds become available in the Stripe balance.
+       */
+      available_on: number;
+
+      /**
+       * The balance that this transaction impacts.
+       */
+      balance_type: BalanceTransaction.BalanceType;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
+       */
+      exchange_rate: number | null;
+
+      /**
+       * Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
+       */
+      fee: number;
+
+      /**
+       * Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
+       */
+      fee_details: Array<BalanceTransaction.FeeDetail>;
+
+      /**
+       * Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`
+       */
+      net: number;
+
+      /**
+       * Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
+       */
+      reporting_category: string;
+
+      /**
+       * This transaction relates to the Stripe object.
+       */
+      source: string | Stripe.BalanceTransactionSource | null;
+
+      /**
+       * The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
+       */
+      status: string;
+
+      /**
+       * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
+       */
+      type: BalanceTransaction.Type;
+    }
+
+    namespace BalanceTransaction {
+      type BalanceType =
+        | 'issuing'
+        | 'payments'
+        | 'refund_and_dispute_prefunding'
+        | 'risk_reserved';
+
+      interface FeeDetail {
+        /**
+         * Amount of the fee, in cents.
+         */
+        amount: number;
+
+        /**
+         * ID of the Connect application that earned the fee.
+         */
+        application: string | null;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description: string | null;
+
+        /**
+         * Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.
+         */
+        type: string;
+      }
+
+      type Type =
+        | 'adjustment'
+        | 'advance'
+        | 'advance_funding'
+        | 'anticipation_repayment'
+        | 'application_fee'
+        | 'application_fee_refund'
+        | 'charge'
+        | 'climate_order_purchase'
+        | 'climate_order_refund'
+        | 'connect_collection_transfer'
+        | 'contribution'
+        | 'issuing_authorization_hold'
+        | 'issuing_authorization_release'
+        | 'issuing_dispute'
+        | 'issuing_transaction'
+        | 'obligation_outbound'
+        | 'obligation_reversal_inbound'
+        | 'payment'
+        | 'payment_failure_refund'
+        | 'payment_network_reserve_hold'
+        | 'payment_network_reserve_release'
+        | 'payment_refund'
+        | 'payment_reversal'
+        | 'payment_unreconciled'
+        | 'payout'
+        | 'payout_cancel'
+        | 'payout_failure'
+        | 'payout_minimum_balance_hold'
+        | 'payout_minimum_balance_release'
+        | 'refund'
+        | 'refund_failure'
+        | 'reserve_hold'
+        | 'reserve_release'
+        | 'reserve_transaction'
+        | 'reserved_funds'
+        | 'stripe_balance_payment_debit'
+        | 'stripe_balance_payment_debit_reversal'
+        | 'stripe_fee'
+        | 'stripe_fx_fee'
+        | 'tax_fee'
+        | 'topup'
+        | 'topup_reversal'
+        | 'transfer'
+        | 'transfer_cancel'
+        | 'transfer_failure'
+        | 'transfer_refund';
+    }
+  }
+}

package/types/BalanceTransactionsResource.d.ts

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface BalanceTransactionRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface BalanceTransactionListParams extends PaginationParams {
+      /**
+       * Only return transactions that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
+       */
+      payout?: string;
+
+      /**
+       * Only returns transactions associated with the given object.
+       */
+      source?: string;
+
+      /**
+       * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
+       */
+      type?: string;
+    }
+
+    class BalanceTransactionsResource {
+      /**
+       * Retrieves the balance transaction with the given ID.
+       *
+       * Note that this endpoint previously used the path /v1/balance/history/:id.
+       */
+      retrieve(
+        id: string,
+        params?: BalanceTransactionRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceTransaction>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceTransaction>>;
+
+      /**
+       * Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+       *
+       * Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+       */
+      list(
+        params?: BalanceTransactionListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.BalanceTransaction>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.BalanceTransaction>;
+    }
+  }
+}