2020import lombok .Setter ;
2121
2222/**
23- * The French Meal Vouchers Onboarding resource encapsulates the onboarding status and other related
24- * information for a single restaurant (SIRET number) in the context of the French Meal Vouchers
25- * program.
23+ * The {@code French Meal Vouchers Onboarding} resource encapsulates the onboarding status and other
24+ * related information for a single restaurant (SIRET number) in the context of the French Meal
25+ * Vouchers program.
26+ *
27+ * <p>To onboard a restaurant for the French Meal Vouchers program, you create a {@code French Meal
28+ * Vouchers Onboarding} object. You can retrieve individual objects, list all such objects, or
29+ * update objects to correct the postal code of the restaurant. We identify {@code French Meal
30+ * Vouchers Onboarding} objects with a unique, random ID.
31+ *
32+ * <p>Related guide: <a
33+ * href="https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers/set-up-restaurant">Set up a
34+ * restaurant for titres-restaurant payments</a>
2635 */
2736@ Getter
2837@ Setter
@@ -75,16 +84,16 @@ public class FrMealVouchersOnboarding extends ApiResource
7584 String siret ;
7685
7786 /**
78- * Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding
79- * status and starts the onboarding process.
87+ * Creates a {@code French Meal Vouchers Onboarding} object that represents a restaurant’s
88+ * onboarding status and starts the onboarding process.
8089 */
8190 public static FrMealVouchersOnboarding create (Map <String , Object > params ) throws StripeException {
8291 return create (params , (RequestOptions ) null );
8392 }
8493
8594 /**
86- * Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding
87- * status and starts the onboarding process.
95+ * Creates a {@code French Meal Vouchers Onboarding} object that represents a restaurant’s
96+ * onboarding status and starts the onboarding process.
8897 */
8998 public static FrMealVouchersOnboarding create (Map <String , Object > params , RequestOptions options )
9099 throws StripeException {
@@ -95,17 +104,17 @@ public static FrMealVouchersOnboarding create(Map<String, Object> params, Reques
95104 }
96105
97106 /**
98- * Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding
99- * status and starts the onboarding process.
107+ * Creates a {@code French Meal Vouchers Onboarding} object that represents a restaurant’s
108+ * onboarding status and starts the onboarding process.
100109 */
101110 public static FrMealVouchersOnboarding create (FrMealVouchersOnboardingCreateParams params )
102111 throws StripeException {
103112 return create (params , (RequestOptions ) null );
104113 }
105114
106115 /**
107- * Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding
108- * status and starts the onboarding process.
116+ * Creates a {@code French Meal Vouchers Onboarding} object that represents a restaurant’s
117+ * onboarding status and starts the onboarding process.
109118 */
110119 public static FrMealVouchersOnboarding create (
111120 FrMealVouchersOnboardingCreateParams params , RequestOptions options ) throws StripeException {
@@ -121,13 +130,19 @@ public static FrMealVouchersOnboarding create(
121130 return getGlobalResponseGetter ().request (request , FrMealVouchersOnboarding .class );
122131 }
123132
124- /** Lists French Meal Vouchers Onboarding objects. */
133+ /**
134+ * Lists {@code French Meal Vouchers Onboarding} objects. The objects are returned in sorted
135+ * order, with the most recently created objects appearing first.
136+ */
125137 public static FrMealVouchersOnboardingCollection list (Map <String , Object > params )
126138 throws StripeException {
127139 return list (params , (RequestOptions ) null );
128140 }
129141
130- /** Lists French Meal Vouchers Onboarding objects. */
142+ /**
143+ * Lists {@code French Meal Vouchers Onboarding} objects. The objects are returned in sorted
144+ * order, with the most recently created objects appearing first.
145+ */
131146 public static FrMealVouchersOnboardingCollection list (
132147 Map <String , Object > params , RequestOptions options ) throws StripeException {
133148 String path = "/v1/fr_meal_vouchers_onboardings" ;
@@ -136,13 +151,19 @@ public static FrMealVouchersOnboardingCollection list(
136151 return getGlobalResponseGetter ().request (request , FrMealVouchersOnboardingCollection .class );
137152 }
138153
139- /** Lists French Meal Vouchers Onboarding objects. */
154+ /**
155+ * Lists {@code French Meal Vouchers Onboarding} objects. The objects are returned in sorted
156+ * order, with the most recently created objects appearing first.
157+ */
140158 public static FrMealVouchersOnboardingCollection list (FrMealVouchersOnboardingListParams params )
141159 throws StripeException {
142160 return list (params , (RequestOptions ) null );
143161 }
144162
145- /** Lists French Meal Vouchers Onboarding objects. */
163+ /**
164+ * Lists {@code French Meal Vouchers Onboarding} objects. The objects are returned in sorted
165+ * order, with the most recently created objects appearing first.
166+ */
146167 public static FrMealVouchersOnboardingCollection list (
147168 FrMealVouchersOnboardingListParams params , RequestOptions options ) throws StripeException {
148169 String path = "/v1/fr_meal_vouchers_onboardings" ;
@@ -157,18 +178,33 @@ public static FrMealVouchersOnboardingCollection list(
157178 return getGlobalResponseGetter ().request (request , FrMealVouchersOnboardingCollection .class );
158179 }
159180
160- /** Retrieves the details of a French Meal Vouchers Onboarding object. */
181+ /**
182+ * Retrieves the details of a previously created {@code French Meal Vouchers Onboarding} object.
183+ *
184+ * <p>Supply the unique {@code French Meal Vouchers Onboarding} ID that was returned from your
185+ * previous request, and Stripe returns the corresponding onboarding information.
186+ */
161187 public static FrMealVouchersOnboarding retrieve (String id ) throws StripeException {
162188 return retrieve (id , (Map <String , Object >) null , (RequestOptions ) null );
163189 }
164190
165- /** Retrieves the details of a French Meal Vouchers Onboarding object. */
191+ /**
192+ * Retrieves the details of a previously created {@code French Meal Vouchers Onboarding} object.
193+ *
194+ * <p>Supply the unique {@code French Meal Vouchers Onboarding} ID that was returned from your
195+ * previous request, and Stripe returns the corresponding onboarding information.
196+ */
166197 public static FrMealVouchersOnboarding retrieve (String id , RequestOptions options )
167198 throws StripeException {
168199 return retrieve (id , (Map <String , Object >) null , options );
169200 }
170201
171- /** Retrieves the details of a French Meal Vouchers Onboarding object. */
202+ /**
203+ * Retrieves the details of a previously created {@code French Meal Vouchers Onboarding} object.
204+ *
205+ * <p>Supply the unique {@code French Meal Vouchers Onboarding} ID that was returned from your
206+ * previous request, and Stripe returns the corresponding onboarding information.
207+ */
172208 public static FrMealVouchersOnboarding retrieve (
173209 String id , Map <String , Object > params , RequestOptions options ) throws StripeException {
174210 String path = String .format ("/v1/fr_meal_vouchers_onboardings/%s" , ApiResource .urlEncodeId (id ));
@@ -177,7 +213,12 @@ public static FrMealVouchersOnboarding retrieve(
177213 return getGlobalResponseGetter ().request (request , FrMealVouchersOnboarding .class );
178214 }
179215
180- /** Retrieves the details of a French Meal Vouchers Onboarding object. */
216+ /**
217+ * Retrieves the details of a previously created {@code French Meal Vouchers Onboarding} object.
218+ *
219+ * <p>Supply the unique {@code French Meal Vouchers Onboarding} ID that was returned from your
220+ * previous request, and Stripe returns the corresponding onboarding information.
221+ */
181222 public static FrMealVouchersOnboarding retrieve (
182223 String id , FrMealVouchersOnboardingRetrieveParams params , RequestOptions options )
183224 throws StripeException {
@@ -193,13 +234,27 @@ public static FrMealVouchersOnboarding retrieve(
193234 return getGlobalResponseGetter ().request (request , FrMealVouchersOnboarding .class );
194235 }
195236
196- /** Updates the details of a restaurant’s French Meal Vouchers Onboarding object. */
237+ /**
238+ * Updates the details of a restaurant’s {@code French Meal Vouchers Onboarding} object by setting
239+ * the values of the parameters passed. Any parameters not provided are left unchanged. After you
240+ * update the object, the onboarding process automatically restarts.
241+ *
242+ * <p>You can only update {@code French Meal Vouchers Onboarding} objects with the {@code
243+ * postal_code} field requirement in {@code past_due}.
244+ */
197245 @ Override
198246 public FrMealVouchersOnboarding update (Map <String , Object > params ) throws StripeException {
199247 return update (params , (RequestOptions ) null );
200248 }
201249
202- /** Updates the details of a restaurant’s French Meal Vouchers Onboarding object. */
250+ /**
251+ * Updates the details of a restaurant’s {@code French Meal Vouchers Onboarding} object by setting
252+ * the values of the parameters passed. Any parameters not provided are left unchanged. After you
253+ * update the object, the onboarding process automatically restarts.
254+ *
255+ * <p>You can only update {@code French Meal Vouchers Onboarding} objects with the {@code
256+ * postal_code} field requirement in {@code past_due}.
257+ */
203258 @ Override
204259 public FrMealVouchersOnboarding update (Map <String , Object > params , RequestOptions options )
205260 throws StripeException {
@@ -210,13 +265,27 @@ public FrMealVouchersOnboarding update(Map<String, Object> params, RequestOption
210265 return getResponseGetter ().request (request , FrMealVouchersOnboarding .class );
211266 }
212267
213- /** Updates the details of a restaurant’s French Meal Vouchers Onboarding object. */
268+ /**
269+ * Updates the details of a restaurant’s {@code French Meal Vouchers Onboarding} object by setting
270+ * the values of the parameters passed. Any parameters not provided are left unchanged. After you
271+ * update the object, the onboarding process automatically restarts.
272+ *
273+ * <p>You can only update {@code French Meal Vouchers Onboarding} objects with the {@code
274+ * postal_code} field requirement in {@code past_due}.
275+ */
214276 public FrMealVouchersOnboarding update (FrMealVouchersOnboardingUpdateParams params )
215277 throws StripeException {
216278 return update (params , (RequestOptions ) null );
217279 }
218280
219- /** Updates the details of a restaurant’s French Meal Vouchers Onboarding object. */
281+ /**
282+ * Updates the details of a restaurant’s {@code French Meal Vouchers Onboarding} object by setting
283+ * the values of the parameters passed. Any parameters not provided are left unchanged. After you
284+ * update the object, the onboarding process automatically restarts.
285+ *
286+ * <p>You can only update {@code French Meal Vouchers Onboarding} objects with the {@code
287+ * postal_code} field requirement in {@code past_due}.
288+ */
220289 public FrMealVouchersOnboarding update (
221290 FrMealVouchersOnboardingUpdateParams params , RequestOptions options ) throws StripeException {
222291 String path =
0 commit comments