stripe 17.3.0-beta.1 → 17.3.0

package/types/Capital/FinancingOffersResource.d.ts

@@ -1,97 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      interface FinancingOfferRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface FinancingOfferListParams extends PaginationParams {
-        /**
-         * limit list to offers belonging to given connected account
-         */
-        connected_account?: string;
-
-        /**
-         * Only return offers that were created during the given date interval.
-         */
-        created?: Stripe.RangeQueryParam | number;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * limit list to offers with given status
-         */
-        status?: FinancingOfferListParams.Status;
-      }
-
-      namespace FinancingOfferListParams {
-        type Status =
-          | 'accepted'
-          | 'canceled'
-          | 'completed'
-          | 'delivered'
-          | 'expired'
-          | 'fully_repaid'
-          | 'paid_out'
-          | 'rejected'
-          | 'revoked'
-          | 'undelivered';
-      }
-
-      interface FinancingOfferMarkDeliveredParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class FinancingOffersResource {
-        /**
-         * Get the details of the financing offer
-         */
-        retrieve(
-          id: string,
-          params?: FinancingOfferRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-
-        /**
-         * Retrieves the financing offers available for Connected accounts that belong to your platform.
-         */
-        list(
-          params?: FinancingOfferListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
-
-        /**
-         * Acknowledges that platform has received and delivered the financing_offer to
-         * the intended merchant recipient.
-         */
-        markDelivered(
-          id: string,
-          params?: FinancingOfferMarkDeliveredParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-        markDelivered(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-      }
-    }
-  }
-}

package/types/Capital/FinancingSummary.d.ts

@@ -1,106 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      /**
-       * A financing object describes an account's current financing state. Used by Connect
-       * platforms to read the state of Capital offered to their connected accounts.
-       */
-      interface FinancingSummary {
-        /**
-         * The object type: financing_summary
-         */
-        object: 'capital.financing_summary';
-
-        /**
-         * Additional information about the financing summary. Describes currency, advance amount,
-         * fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
-         * repayment start date, and advance payout date.
-         */
-        details: FinancingSummary.Details | null;
-
-        /**
-         * The Financing Offer ID this Financing Summary corresponds to
-         */
-        financing_offer: string | null;
-
-        /**
-         * Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
-         */
-        status: FinancingSummary.Status | null;
-      }
-
-      namespace FinancingSummary {
-        interface Details {
-          /**
-           * Amount of financing offered, in minor units.
-           */
-          advance_amount: number;
-
-          /**
-           * The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
-           */
-          advance_paid_out_at: number | null;
-
-          /**
-           * Currency that the financing offer is transacted in. For example, `usd`.
-           */
-          currency: string;
-
-          /**
-           * The chronologically current repayment interval for the financing offer.
-           */
-          current_repayment_interval: Details.CurrentRepaymentInterval | null;
-
-          /**
-           * Fixed fee amount, in minor units.
-           */
-          fee_amount: number;
-
-          /**
-           * The amount the Connected account has paid toward the financing debt so far.
-           */
-          paid_amount: number;
-
-          /**
-           * The balance remaining to be paid on the financing, in minor units.
-           */
-          remaining_amount: number;
-
-          /**
-           * The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
-           */
-          repayments_begin_at: number | null;
-
-          /**
-           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
-           */
-          withhold_rate: number;
-        }
-
-        namespace Details {
-          interface CurrentRepaymentInterval {
-            /**
-             * The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
-             * Given in seconds since unix epoch.
-             */
-            due_at: number;
-
-            /**
-             * The amount that has already been paid in the current repayment interval.
-             */
-            paid_amount: number | null;
-
-            /**
-             * The amount that is yet to be paid in the current repayment interval.
-             */
-            remaining_amount: number;
-          }
-        }
-
-        type Status = 'accepted' | 'delivered' | 'none';
-      }
-    }
-  }
-}

package/types/Capital/FinancingSummaryResource.d.ts

@@ -1,27 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      interface FinancingSummaryRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class FinancingSummaryResource {
-        /**
-         * Retrieve the financing state for the account that was authenticated in the request.
-         */
-        retrieve(
-          params?: FinancingSummaryRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
-        retrieve(
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
-      }
-    }
-  }
-}

package/types/Capital/FinancingTransactions.d.ts

@@ -1,135 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      /**
-       * This is an object representing the details of a transaction on a Capital financing object.
-       */
-      interface FinancingTransaction {
-        /**
-         * A unique identifier for the financing transaction object.
-         */
-        id: string;
-
-        /**
-         * The object type: financing_transaction
-         */
-        object: 'capital.financing_transaction';
-
-        /**
-         * The ID of the merchant associated with this financing transaction.
-         */
-        account: string;
-
-        /**
-         * Time at which the financing transaction was created. Given in seconds since unix epoch.
-         */
-        created_at: number;
-
-        /**
-         * This is an object representing a transaction on a Capital financing offer.
-         */
-        details: FinancingTransaction.Details;
-
-        /**
-         * The Capital financing offer for this financing transaction.
-         */
-        financing_offer: string | null;
-
-        /**
-         * The Capital transaction object that predates the Financing Transactions API and
-         * corresponds with the balance transaction that was created as a result of this
-         * financing transaction.
-         */
-        legacy_balance_transaction_source?: string;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The type of the financing transaction.
-         */
-        type: FinancingTransaction.Type;
-
-        /**
-         * A human-friendly description of the financing transaction.
-         */
-        user_facing_description: string | null;
-      }
-
-      namespace FinancingTransaction {
-        interface Details {
-          /**
-           * The advance amount being repaid, paid out, or reversed in minor units.
-           */
-          advance_amount: number;
-
-          /**
-           * The currency of the financing transaction.
-           */
-          currency: string;
-
-          /**
-           * The fee amount being repaid, paid out, or reversed in minor units.
-           */
-          fee_amount: number;
-
-          /**
-           * The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
-           */
-          linked_payment?: string;
-
-          /**
-           * The reason for the financing transaction (if applicable).
-           */
-          reason?: Details.Reason;
-
-          /**
-           * The reversed transaction. This field only applies to financing
-           * transactions of type `reversal`.
-           */
-          reversed_transaction?: string;
-
-          /**
-           * The advance and fee amount being repaid, paid out, or reversed in minor units.
-           */
-          total_amount: number;
-
-          /**
-           * This is an object representing a linked transaction on a Capital Financing Transaction.
-           */
-          transaction?: Details.Transaction;
-        }
-
-        namespace Details {
-          type Reason =
-            | 'automatic_withholding'
-            | 'automatic_withholding_refund'
-            | 'collection'
-            | 'collection_failure'
-            | 'financing_cancellation'
-            | 'refill'
-            | 'requested_by_user'
-            | 'user_initiated';
-
-          interface Transaction {
-            /**
-             * The linked payment ID.
-             */
-            charge?: string;
-
-            /**
-             * The linked Treasury Financing Transaction ID.
-             */
-            treasury_transaction?: string;
-          }
-        }
-
-        type Type = 'payment' | 'payout' | 'reversal';
-      }
-    }
-  }
-}

package/types/Capital/FinancingTransactionsResource.d.ts

@@ -1,68 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      interface FinancingTransactionRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface FinancingTransactionListParams extends PaginationParams {
-        /**
-         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
-         */
-        charge?: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Returns transactions that were created that apply to this financing offer ID.
-         */
-        financing_offer?: string;
-
-        /**
-         * Only returns transactions that are responsible for reversing this financing transaction ID.
-         */
-        reversed_transaction?: string;
-
-        /**
-         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
-         */
-        treasury_transaction?: string;
-      }
-
-      class FinancingTransactionsResource {
-        /**
-         * Retrieves a financing transaction for a financing offer.
-         */
-        retrieve(
-          id: string,
-          params?: FinancingTransactionRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
-
-        /**
-         * Returns a list of financing transactions. The transactions are returned in sorted order,
-         * with the most recent transactions appearing first.
-         */
-        list(
-          params?: FinancingTransactionListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
-      }
-    }
-  }
-}

package/types/FinancialConnections/AccountInferredBalances.d.ts

@@ -1,38 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      /**
-       * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
-       */
-      interface AccountInferredBalance {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'financial_connections.account_inferred_balance';
-
-        /**
-         * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
-         */
-        as_of: number;
-
-        /**
-         * The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
-         *
-         * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
-         *
-         * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
-         */
-        current: {
-          [key: string]: number;
-        };
-      }
-    }
-  }
-}

package/types/FinancialConnections/Institutions.d.ts

@@ -1,93 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      /**
-       * An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
-       */
-      interface Institution {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'financial_connections.institution';
-
-        features: Institution.Features;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The name of this institution.
-         */
-        name: string;
-
-        /**
-         * A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
-         */
-        routing_numbers: Array<string>;
-
-        /**
-         * The status of this institution in the Financial Connections authentication flow.
-         */
-        status: Institution.Status;
-
-        /**
-         * A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
-         */
-        url: string | null;
-      }
-
-      namespace Institution {
-        interface Features {
-          balances: Features.Balances;
-
-          ownership: Features.Ownership;
-
-          payment_method: Features.PaymentMethod;
-
-          transactions: Features.Transactions;
-        }
-
-        namespace Features {
-          interface Balances {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface Ownership {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface PaymentMethod {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface Transactions {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-        }
-
-        type Status = 'active' | 'degraded' | 'inactive';
-      }
-    }
-  }
-}

package/types/FinancialConnections/InstitutionsResource.d.ts

@@ -1,47 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      interface InstitutionRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface InstitutionListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class InstitutionsResource {
-        /**
-         * Retrieves the details of a Financial Connections Institution.
-         */
-        retrieve(
-          id: string,
-          params?: InstitutionRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
-
-        /**
-         * Returns a list of Financial Connections Institution objects.
-         */
-        list(
-          params?: InstitutionListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
-      }
-    }
-  }
-}