stripe 18.0.0 → 18.1.0-beta.2

package/types/FinancialConnections/AccountsResource.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
            * The ID of the Stripe customer whose accounts will be retrieved.
            */
           customer?: string;
+
+          /**
+           * The Account ID of the Stripe customer whose accounts will be retrieved.
+           */
+          customer_account?: string;
         }
       }
 
@@ -48,6 +53,13 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface AccountListInferredBalancesParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
       interface AccountListOwnersParams extends PaginationParams {
         /**
          * The ID of the ownership object to fetch owners from.
@@ -73,14 +85,18 @@ declare module 'stripe' {
       }
 
       namespace AccountRefreshParams {
-        type Feature = 'balance' | 'ownership' | 'transactions';
+        type Feature =
+          | 'balance'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
       }
 
       interface AccountSubscribeParams {
         /**
          * The list of account features to which you would like to subscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountSubscribeParams.Feature>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -88,11 +104,15 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      namespace AccountSubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+      }
+
       interface AccountUnsubscribeParams {
         /**
          * The list of account features from which you would like to unsubscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountUnsubscribeParams.Feature>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -100,6 +120,10 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      namespace AccountUnsubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+      }
+
       class AccountsResource {
         /**
          * Retrieves the details of an Financial Connections Account.
@@ -138,6 +162,19 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
 
+        /**
+         * Lists the recorded inferred balances for a Financial Connections Account.
+         */
+        listInferredBalances(
+          id: string,
+          params?: AccountListInferredBalancesParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
+        listInferredBalances(
+          id: string,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
+
         /**
          * Lists all owners for a given Account
          */

package/types/FinancialConnections/Institutions.d.ts

@@ -0,0 +1,93 @@
+// 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

@@ -0,0 +1,47 @@
+// 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/FinancialConnections/Sessions.d.ts

@@ -34,11 +34,15 @@ declare module 'stripe' {
 
         filters?: Session.Filters;
 
+        limits?: Session.Limits;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
         livemode: boolean;
 
+        manual_entry?: Session.ManualEntry;
+
         /**
          * Permissions requested for accounts collected during this session.
          */
@@ -53,6 +57,13 @@ declare module 'stripe' {
          * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          */
         return_url?: string;
+
+        /**
+         * The current state of the session.
+         */
+        status?: Session.Status;
+
+        status_details?: Session.StatusDetails;
       }
 
       namespace Session {
@@ -67,6 +78,8 @@ declare module 'stripe' {
            */
           customer?: string | Stripe.Customer;
 
+          customer_account?: string;
+
           /**
            * Type of account holder that this account belongs to.
            */
@@ -87,6 +100,11 @@ declare module 'stripe' {
            * List of countries from which to filter accounts.
            */
           countries: Array<string> | null;
+
+          /**
+           * Stripe ID of the institution with which the customer should be directed to log in.
+           */
+          institution?: string;
         }
 
         namespace Filters {
@@ -98,13 +116,45 @@ declare module 'stripe' {
             | 'savings';
         }
 
+        interface Limits {
+          /**
+           * The number of accounts that can be linked in this Session.
+           */
+          accounts: number;
+        }
+
+        interface ManualEntry {}
+
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch = 'balances' | 'ownership' | 'transactions';
+        type Prefetch =
+          | 'balances'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
+
+        type Status = 'cancelled' | 'failed' | 'pending' | 'succeeded';
+
+        interface StatusDetails {
+          cancelled?: StatusDetails.Cancelled;
+        }
+
+        namespace StatusDetails {
+          interface Cancelled {
+            /**
+             * The reason for the Session being cancelled.
+             */
+            reason: Cancelled.Reason;
+          }
+
+          namespace Cancelled {
+            type Reason = 'custom_manual_entry' | 'other';
+          }
+        }
       }
     }
   }

package/types/FinancialConnections/SessionsResource.d.ts

@@ -26,6 +26,16 @@ declare module 'stripe' {
          */
         filters?: SessionCreateParams.Filters;
 
+        /**
+         * Settings for configuring Session-specific limits.
+         */
+        limits?: SessionCreateParams.Limits;
+
+        /**
+         * Customize manual entry behavior
+         */
+        manual_entry?: SessionCreateParams.ManualEntry;
+
         /**
          * List of data features that you would like to retrieve upon account creation.
          */
@@ -49,6 +59,11 @@ declare module 'stripe' {
            */
           customer?: string;
 
+          /**
+           * The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
+           */
+          customer_account?: string;
+
           /**
            * Type of account holder to collect accounts for.
            */
@@ -69,6 +84,11 @@ declare module 'stripe' {
            * List of countries from which to collect accounts.
            */
           countries?: Array<string>;
+
+          /**
+           * Stripe ID of the institution with which the customer should be directed to log in.
+           */
+          institution?: string;
         }
 
         namespace Filters {
@@ -80,13 +100,35 @@ declare module 'stripe' {
             | 'savings';
         }
 
+        interface Limits {
+          /**
+           * The number of accounts that can be linked in this Session.
+           */
+          accounts: number;
+        }
+
+        interface ManualEntry {
+          /**
+           * Whether manual entry will be handled by Stripe during the Session.
+           */
+          mode?: ManualEntry.Mode;
+        }
+
+        namespace ManualEntry {
+          type Mode = 'automatic' | 'custom';
+        }
+
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch = 'balances' | 'ownership' | 'transactions';
+        type Prefetch =
+          | 'balances'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
       }
 
       interface SessionRetrieveParams {

package/types/GiftCards/Cards.d.ts

@@ -0,0 +1,118 @@
+// 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

@@ -0,0 +1,159 @@
+// 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>>;
+      }
+    }
+  }
+}