stripe 22.3.0 → 22.4.0-alpha.2

package/cjs/resources/FinancialConnections/Institutions.d.ts

@@ -0,0 +1,99 @@
+import { StripeResource } from '../../StripeResource.js';
+import { PaginationParams } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
+export declare class InstitutionResource extends StripeResource {
+    /**
+     * Returns a list of Financial Connections Institution objects.
+     */
+    list(params?: FinancialConnections.InstitutionListParams, options?: RequestOptions): ApiListPromise<Institution>;
+    /**
+     * Retrieves the details of a Financial Connections Institution.
+     */
+    retrieve(id: string, params?: FinancialConnections.InstitutionRetrieveParams, options?: RequestOptions): Promise<Response<Institution>>;
+}
+export 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';
+    /**
+     * The list of countries supported by this institution, formatted as ISO country codes.
+     */
+    countries: Array<string>;
+    features: Institution.Features;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    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;
+}
+export declare namespace Institution {
+    interface Features {
+        balances: Features.Balances;
+        ownership: Features.Ownership;
+        payment_method: Features.PaymentMethod;
+        transactions: Features.Transactions;
+    }
+    type Status = 'active' | 'degraded' | 'inactive';
+    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;
+        }
+    }
+}
+export declare namespace FinancialConnections {
+    interface InstitutionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace FinancialConnections {
+    interface InstitutionListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/cjs/resources/FinancialConnections/Institutions.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstitutionResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class InstitutionResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of Financial Connections Institution objects.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/financial_connections/institutions', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieves the details of a Financial Connections Institution.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/financial_connections/institutions/${encodeURIComponent(id)}`, params, options);
+    }
+}
+exports.InstitutionResource = InstitutionResource;
+//# sourceMappingURL=Institutions.js.map

package/cjs/resources/FinancialConnections/Institutions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Institutions.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Institutions.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,IAAI,CACF,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,wCAAwC,EACxC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,0CAA0C,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAClE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,kDAiCC"}

package/cjs/resources/FinancialConnections/Sessions.d.ts

@@ -1,6 +1,7 @@
 import { StripeResource } from '../../StripeResource.js';
 import { Account } from './Accounts.js';
 import { Customer } from './../Customers.js';
+import { Emptyable } from '../../shared.js';
 import { RequestOptions, Response, ApiList } from '../../lib.js';
 export declare class SessionResource extends StripeResource {
     /**
@@ -34,10 +35,16 @@ export interface Session {
      */
     client_secret: string | null;
     filters?: Session.Filters;
+    /**
+     * Settings for the Hosted UI mode.
+     */
+    hosted?: Session.Hosted | null;
+    limits?: Session.Limits;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
     livemode: boolean;
+    manual_entry?: Session.ManualEntry;
     /**
      * Permissions requested for accounts collected during this session.
      */
@@ -46,10 +53,25 @@ export interface Session {
      * Data features requested to be retrieved upon account creation.
      */
     prefetch: Array<Session.Prefetch> | null;
+    relink_options?: Session.RelinkOptions;
+    relink_result?: Session.RelinkResult;
     /**
      * 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;
+    /**
+     * The UI mode for this session.
+     */
+    ui_mode?: Session.UiMode;
+    /**
+     * The hosted URL for this Session. Redirect customers to this URL to take them to the hosted authentication flow. This value is only present when the Session is active and the `ui_mode` is `hosted`.
+     */
+    url?: string | null;
 }
 export declare namespace Session {
     interface AccountHolder {
@@ -76,28 +98,96 @@ export declare namespace Session {
          * 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;
+    }
+    interface Hosted {
+        /**
+         * How the user enters the hosted flow. You can only use the values `email` and `url` if you provide `relink_options`.
+         */
+        delivery_method?: Hosted.DeliveryMethod;
+        /**
+         * The URL to redirect your customer back to after they link their accounts or cancel this Session. This parameter is required if `ui_mode` is `hosted`.
+         */
+        return_url: string | null;
+    }
+    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';
+    interface RelinkOptions {
+        /**
+         * Requires the end user to repair this specific account during the authentication flow instead of connecting a different one.
+         */
+        account?: string | null;
+        /**
+         * The authorization to relink in the Session.
+         */
+        authorization: string;
+    }
+    interface RelinkResult {
+        /**
+         * The account relinked in the Session. Only present if `relink_options[account]` is set and relink is successful.
+         */
+        account: string | null;
+        /**
+         * The authorization relinked in the Session. Only present if relink is successful.
+         */
+        authorization: string | null;
+        /**
+         * Reason for why relink failed. One of `no_authorization`, `no_account`, or `other`.
+         */
+        failure_reason: RelinkResult.FailureReason | null;
+    }
+    type Status = 'cancelled' | 'failed' | 'pending' | 'succeeded';
+    interface StatusDetails {
+        cancelled?: StatusDetails.Cancelled;
+    }
+    type UiMode = 'hosted' | 'modal';
     namespace AccountHolder {
         type Type = 'account' | 'customer';
     }
     namespace Filters {
         type AccountSubcategory = 'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'savings';
     }
+    namespace Hosted {
+        type DeliveryMethod = 'email' | 'url';
+    }
+    namespace RelinkResult {
+        type FailureReason = 'no_account' | 'no_authorization' | 'other';
+    }
+    namespace StatusDetails {
+        interface Cancelled {
+            /**
+             * The reason for the Session being cancelled.
+             */
+            reason: Cancelled.Reason;
+        }
+        namespace Cancelled {
+            type Reason = 'custom_manual_entry' | 'other';
+        }
+    }
 }
 export declare namespace FinancialConnections {
     interface SessionCreateParams {
-        /**
-         * The account holder to link accounts for.
-         */
-        account_holder: SessionCreateParams.AccountHolder;
         /**
          * List of data features that you would like to request access to.
          *
          * Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
          */
         permissions: Array<SessionCreateParams.Permission>;
+        /**
+         * The account holder to link accounts for.
+         */
+        account_holder?: SessionCreateParams.AccountHolder;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -106,16 +196,37 @@ export declare namespace FinancialConnections {
          * Filters to restrict the kinds of accounts to collect.
          */
         filters?: SessionCreateParams.Filters;
+        /**
+         * Settings for hosted Sessions. Required if `ui_mode` is `hosted`.
+         */
+        hosted?: SessionCreateParams.Hosted;
+        /**
+         * 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.
          */
         prefetch?: Array<SessionCreateParams.Prefetch>;
+        /**
+         * Options for specifying a Session targeted to relinking an authorization.
+         */
+        relink_options?: SessionCreateParams.RelinkOptions;
         /**
          * 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 UI mode of the Session. Defaults to `modal`.
+         */
+        ui_mode?: SessionCreateParams.UiMode;
     }
     namespace SessionCreateParams {
+        type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
         interface AccountHolder {
             /**
              * The ID of the Stripe account whose accounts you will retrieve. Only available when `type` is `account`.
@@ -134,7 +245,6 @@ export declare namespace FinancialConnections {
              */
             type: AccountHolder.Type;
         }
-        type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
         interface Filters {
             /**
              * Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
@@ -144,14 +254,53 @@ export declare namespace FinancialConnections {
              * 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;
+        }
+        interface Hosted {
+            /**
+             * How the user should enter the hosted flow. The values `email` and `url` can only be used if `relink_options` is provided.
+             */
+            delivery_method?: Hosted.DeliveryMethod;
         }
-        type Prefetch = 'balances' | 'ownership' | 'transactions';
+        interface Limits {
+            /**
+             * The number of accounts that can be linked in this Session. Pass an empty value to allow any number of accounts.
+             */
+            accounts: Emptyable<number>;
+        }
+        interface ManualEntry {
+            /**
+             * How manual entry should be handled.
+             */
+            mode?: ManualEntry.Mode;
+        }
+        type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
+        interface RelinkOptions {
+            /**
+             * The account to relink. Must belong to the authorization specified in `authorization`.
+             */
+            account?: string;
+            /**
+             * The authorization to relink.
+             */
+            authorization: string;
+        }
+        type UiMode = 'hosted' | 'modal';
         namespace AccountHolder {
             type Type = 'account' | 'customer';
         }
         namespace Filters {
             type AccountSubcategory = 'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'savings';
         }
+        namespace Hosted {
+            type DeliveryMethod = 'email' | 'url';
+        }
+        namespace ManualEntry {
+            type Mode = 'automatic' | 'custom';
+        }
     }
 }
 export declare namespace FinancialConnections {

package/cjs/resources/FinancialConnections/Sessions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Sessions.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Sessions.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAKvD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oCAAoC,EACpC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA9BD,0CA8BC"}
+{"version":3,"file":"Sessions.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Sessions.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAMvD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oCAAoC,EACpC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA9BD,0CA8BC"}

package/cjs/resources/FinancialConnections/index.d.ts

@@ -1,17 +1,25 @@
 import { Stripe } from '../../stripe.core.js';
 import { FinancialConnections as FinancialConnectionsNamespace0, Account, AccountResource } from './Accounts.js';
-import { FinancialConnections as FinancialConnectionsNamespace1, Session, SessionResource } from './Sessions.js';
-import { FinancialConnections as FinancialConnectionsNamespace2, Transaction, TransactionResource } from './Transactions.js';
+import { FinancialConnections as FinancialConnectionsNamespace1, Authorization, AuthorizationResource } from './Authorizations.js';
+import { FinancialConnections as FinancialConnectionsNamespace2, Institution, InstitutionResource } from './Institutions.js';
+import { FinancialConnections as FinancialConnectionsNamespace3, Session, SessionResource } from './Sessions.js';
+import { FinancialConnections as FinancialConnectionsNamespace4, Transaction, TransactionResource } from './Transactions.js';
 import { AccountOwner } from './AccountOwners.js';
 import { AccountOwnership } from './AccountOwnerships.js';
+import { AccountInferredBalance } from './AccountInferredBalances.js';
 export { Account } from './Accounts.js';
+export { Authorization } from './Authorizations.js';
+export { Institution } from './Institutions.js';
 export { Session } from './Sessions.js';
 export { Transaction } from './Transactions.js';
 export { AccountOwner } from './AccountOwners.js';
 export { AccountOwnership } from './AccountOwnerships.js';
+export { AccountInferredBalance } from './AccountInferredBalances.js';
 export declare class FinancialConnections {
     private readonly stripe;
     accounts: AccountResource;
+    authorizations: AuthorizationResource;
+    institutions: InstitutionResource;
     sessions: SessionResource;
     transactions: TransactionResource;
     constructor(stripe: Stripe);
@@ -23,14 +31,21 @@ export declare namespace FinancialConnections {
     export import AccountRefreshParams = FinancialConnectionsNamespace0.AccountRefreshParams;
     export import AccountSubscribeParams = FinancialConnectionsNamespace0.AccountSubscribeParams;
     export import AccountUnsubscribeParams = FinancialConnectionsNamespace0.AccountUnsubscribeParams;
+    export import AccountListInferredBalancesParams = FinancialConnectionsNamespace0.AccountListInferredBalancesParams;
     export import AccountListOwnersParams = FinancialConnectionsNamespace0.AccountListOwnersParams;
     export { Account, AccountResource };
-    export import SessionRetrieveParams = FinancialConnectionsNamespace1.SessionRetrieveParams;
-    export import SessionCreateParams = FinancialConnectionsNamespace1.SessionCreateParams;
+    export import AuthorizationRetrieveParams = FinancialConnectionsNamespace1.AuthorizationRetrieveParams;
+    export { Authorization, AuthorizationResource };
+    export import InstitutionListParams = FinancialConnectionsNamespace2.InstitutionListParams;
+    export import InstitutionRetrieveParams = FinancialConnectionsNamespace2.InstitutionRetrieveParams;
+    export { Institution, InstitutionResource };
+    export import SessionRetrieveParams = FinancialConnectionsNamespace3.SessionRetrieveParams;
+    export import SessionCreateParams = FinancialConnectionsNamespace3.SessionCreateParams;
     export { Session, SessionResource };
-    export import TransactionListParams = FinancialConnectionsNamespace2.TransactionListParams;
-    export import TransactionRetrieveParams = FinancialConnectionsNamespace2.TransactionRetrieveParams;
+    export import TransactionListParams = FinancialConnectionsNamespace4.TransactionListParams;
+    export import TransactionRetrieveParams = FinancialConnectionsNamespace4.TransactionRetrieveParams;
     export { Transaction, TransactionResource };
     export { AccountOwner };
     export { AccountOwnership };
+    export { AccountInferredBalance };
 }

package/cjs/resources/FinancialConnections/index.js

@@ -3,12 +3,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FinancialConnections = void 0;
 const Accounts_js_1 = require("./Accounts.js");
+const Authorizations_js_1 = require("./Authorizations.js");
+const Institutions_js_1 = require("./Institutions.js");
 const Sessions_js_1 = require("./Sessions.js");
 const Transactions_js_1 = require("./Transactions.js");
 class FinancialConnections {
     constructor(stripe) {
         this.stripe = stripe;
         this.accounts = new Accounts_js_1.AccountResource(stripe);
+        this.authorizations = new Authorizations_js_1.AuthorizationResource(stripe);
+        this.institutions = new Institutions_js_1.InstitutionResource(stripe);
         this.sessions = new Sessions_js_1.SessionResource(stripe);
         this.transactions = new Transactions_js_1.TransactionResource(stripe);
     }

package/cjs/resources/FinancialConnections/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,+CAIuB;AACvB,+CAIuB;AACvB,uDAI2B;AAU3B,MAAa,oBAAoB;IAK/B,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;CACF;AAVD,oDAUC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,+CAIuB;AACvB,2DAI6B;AAC7B,uDAI2B;AAC3B,+CAIuB;AACvB,uDAI2B;AAc3B,MAAa,oBAAoB;IAO/B,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;CACF;AAdD,oDAcC"}

package/cjs/resources/FrMealVouchersOnboardings.d.ts

@@ -0,0 +1,173 @@
+import { StripeResource } from '../StripeResource.js';
+import { MetadataParam, PaginationParams, Metadata } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+export declare class FrMealVouchersOnboardingResource extends StripeResource {
+    /**
+     * Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.
+     */
+    list(params?: FrMealVouchersOnboardingListParams, options?: RequestOptions): ApiListPromise<FrMealVouchersOnboarding>;
+    /**
+     * Creates a French Meal Vouchers Onboarding object that represents a restaurant's onboarding status and starts the onboarding process.
+     */
+    create(params: FrMealVouchersOnboardingCreateParams, options?: RequestOptions): Promise<Response<FrMealVouchersOnboarding>>;
+    /**
+     * Retrieves the details of a previously created French Meal Vouchers Onboarding object.
+     *
+     * Supply the unique French Meal Vouchers Onboarding ID that was returned from your previous request,
+     * and Stripe returns the corresponding onboarding information.
+     */
+    retrieve(id: string, params?: FrMealVouchersOnboardingRetrieveParams, options?: RequestOptions): Promise<Response<FrMealVouchersOnboarding>>;
+    /**
+     * Updates the details of a restaurant's French Meal Vouchers Onboarding object by
+     * setting the values of the parameters passed. Any parameters not provided are left unchanged.
+     * After you update the object, the onboarding process automatically restarts.
+     *
+     * You can only update French Meal Vouchers Onboarding objects with the postal_code field requirement in past_due.
+     */
+    update(id: string, params: FrMealVouchersOnboardingUpdateParams, options?: RequestOptions): Promise<Response<FrMealVouchersOnboarding>>;
+}
+export interface FrMealVouchersOnboarding {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'fr_meal_vouchers_onboarding';
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/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: Metadata | null;
+    /**
+     * Name of the restaurant.
+     */
+    name: string;
+    /**
+     * Postal code of the restaurant.
+     */
+    postal_code: string;
+    /**
+     * This represents the onboarding state of the restaurant on different providers.
+     */
+    providers: FrMealVouchersOnboarding.Providers;
+    /**
+     * SIRET number associated with the restaurant.
+     */
+    siret: string;
+}
+export declare namespace FrMealVouchersOnboarding {
+    interface Providers {
+        /**
+         * This represents the onboarding state of the restaurant on Conecs.
+         */
+        conecs: Providers.Conecs;
+    }
+    namespace Providers {
+        interface Conecs {
+            /**
+             * This represents information which issuers are available to this restaurant via Conecs
+             */
+            issuers: Conecs.Issuers;
+            /**
+             * This represents information about outstanding requirements for this restaurant to onboard to Conecs
+             */
+            requirements: Conecs.Requirements;
+            /**
+             * Status of the restaurant's onboarding to Conecs
+             */
+            status: Conecs.Status;
+        }
+        namespace Conecs {
+            interface Issuers {
+                /**
+                 * Issuers are available to this restaurant via Conecs, will be blank if the onboarding to Conecs is not complete or unsuccessful
+                 */
+                available: Array<Issuers.Available>;
+            }
+            interface Requirements {
+                /**
+                 * Information any errors that are preventing the onboarding to Conecs from being completed.
+                 */
+                errors: Array<Requirements.Error>;
+                /**
+                 * Fields that need to be provided to complete the onboarding to Conecs.
+                 */
+                past_due: Array<Requirements.PastDue>;
+            }
+            type Status = 'action_required' | 'active' | 'disentitled' | 'pending';
+            namespace Issuers {
+                type Available = 'bimpli' | 'edenred' | 'pluxee' | 'up';
+            }
+            namespace Requirements {
+                interface Error {
+                    /**
+                     * The code for the type of error.
+                     */
+                    code: Error.Code;
+                    /**
+                     * An informative message that provides additional details about the error.
+                     */
+                    message: string;
+                    /**
+                     * The specific onboarding requirement field (in the requirements hash) that needs to be resolved.
+                     */
+                    requirement: Error.Requirement | null;
+                }
+                type PastDue = 'postal_code' | 'siret';
+                namespace Error {
+                    type Code = 'postal_code_invalid' | 'siret_invalid';
+                    type Requirement = 'postal_code' | 'siret';
+                }
+            }
+        }
+    }
+}
+export interface FrMealVouchersOnboardingCreateParams {
+    /**
+     * Name of the restaurant. This cannot be changed after creation of this object.
+     */
+    name: string;
+    /**
+     * Postal code of the restaurant.
+     */
+    postal_code: string;
+    /**
+     * SIRET number associated with the restaurant. This cannot be changed after creation of this object.
+     */
+    siret: string;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/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`. This cannot be changed after creation of this object.
+     */
+    metadata?: MetadataParam;
+}
+export interface FrMealVouchersOnboardingRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface FrMealVouchersOnboardingUpdateParams {
+    /**
+     * Corrected Postal code of the restaurant.
+     */
+    postal_code: string;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface FrMealVouchersOnboardingListParams extends PaginationParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}