stripe 17.7.0-beta.1 → 17.7.0

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>;
-      }
-    }
-  }
-}

package/types/GiftCards/Cards.d.ts

@@ -1,118 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      /**
-       * A gift card represents a single gift card owned by a customer, including the
-       * remaining balance, gift card code, and whether or not it is active.
-       */
-      interface Card {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'gift_cards.card';
-
-        /**
-         * Whether this gift card can be used or not.
-         */
-        active: boolean;
-
-        /**
-         * The amount of funds available for new transactions.
-         */
-        amount_available: number;
-
-        /**
-         * The amount of funds marked as held.
-         */
-        amount_held: number;
-
-        /**
-         * Code used to redeem this gift card.
-         */
-        code?: string | null;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * The related Stripe objects that created this gift card.
-         */
-        created_by: Card.CreatedBy | 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;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-         */
-        metadata: Stripe.Metadata | null;
-
-        /**
-         * Transactions on this gift card.
-         */
-        transactions?: ApiList<Stripe.GiftCards.Transaction>;
-      }
-
-      namespace Card {
-        interface CreatedBy {
-          checkout?: CreatedBy.Checkout;
-
-          order?: CreatedBy.Order;
-
-          payment?: CreatedBy.Payment;
-
-          /**
-           * The type of event that created this object.
-           */
-          type: CreatedBy.Type;
-        }
-
-        namespace CreatedBy {
-          interface Checkout {
-            /**
-             * The Stripe CheckoutSession that created this object.
-             */
-            checkout_session: string;
-
-            /**
-             * The Stripe CheckoutSession LineItem that created this object.
-             */
-            line_item: string | null;
-          }
-
-          interface Order {
-            /**
-             * The Stripe Order LineItem that created this object.
-             */
-            line_item: string | null;
-
-            /**
-             * The Stripe Order that created this object.
-             */
-            order: string;
-          }
-
-          interface Payment {
-            /**
-             * The PaymentIntent that created this object.
-             */
-            payment_intent: string;
-          }
-
-          type Type = 'checkout' | 'order' | 'payment';
-        }
-      }
-    }
-  }
-}

package/types/GiftCards/CardsResource.d.ts

@@ -1,159 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      interface CardCreateParams {
-        /**
-         * 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;
-
-        /**
-         * The active state for the new gift card, defaults to false. The active state can be updated after creation.
-         */
-        active?: boolean;
-
-        /**
-         * Related objects which created this gift card.
-         */
-        created_by?: CardCreateParams.CreatedBy;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * The initial amount to load onto the new gift card, defaults to 0.
-         */
-        initial_amount?: number;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-         */
-        metadata?: Stripe.MetadataParam;
-      }
-
-      namespace CardCreateParams {
-        interface CreatedBy {
-          /**
-           * The details for the payment that created this object.
-           */
-          payment: CreatedBy.Payment;
-
-          /**
-           * The type of event that created this object.
-           */
-          type: 'payment';
-        }
-
-        namespace CreatedBy {
-          interface Payment {
-            /**
-             * The PaymentIntent used to collect payment for this object.
-             */
-            payment_intent: string;
-          }
-        }
-      }
-
-      interface CardRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface CardUpdateParams {
-        /**
-         * The new active state for the gift card.
-         */
-        active?: boolean;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-         */
-        metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
-      }
-
-      interface CardListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface CardValidateParams {
-        /**
-         * The gift card code to be validated.
-         */
-        code: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * The pin associated with the gift card. Not all gift cards have pins.
-         */
-        giftcard_pin?: string;
-      }
-
-      class CardsResource {
-        /**
-         * Creates a new gift card object.
-         */
-        create(
-          params: CardCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * Retrieve a gift card by id
-         */
-        retrieve(
-          id: string,
-          params?: CardRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * Update a gift card
-         */
-        update(
-          id: string,
-          params?: CardUpdateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * List gift cards for an account
-         */
-        list(
-          params?: CardListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.GiftCards.Card>;
-        list(options?: RequestOptions): ApiListPromise<Stripe.GiftCards.Card>;
-
-        /**
-         * Validates a gift card code, returning the matching gift card object if it exists.
-         */
-        validate(
-          params: CardValidateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-      }
-    }
-  }
-}