Package com.stripe.model

Class FrMealVouchersOnboarding

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.FrMealVouchersOnboarding

All Implemented Interfaces:

HasId, MetadataStore<FrMealVouchersOnboarding>, StripeActiveObject, StripeObjectInterface

public class FrMealVouchersOnboarding
extends ApiResource
implements HasId, MetadataStore<FrMealVouchersOnboarding>

The French Meal Vouchers Onboarding resource encapsulates the onboarding status and other related information for a single restaurant (SIRET number) in the context of the French Meal Vouchers program.

To onboard a restaurant for the French Meal Vouchers program, you create a French Meal Vouchers Onboarding object. You can retrieve individual objects, list all such objects, or update objects to correct the postal code of the restaurant. We identify French Meal Vouchers Onboarding objects with a unique, random ID.

Related guide: Set up a restaurant for titres-restaurant payments

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FrMealVouchersOnboarding.Providers	This represents the onboarding state of the restaurant on different providers.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
FrMealVouchersOnboarding()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static FrMealVouchersOnboarding	create(FrMealVouchersOnboardingCreateParams params)	Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.
static FrMealVouchersOnboarding	create(FrMealVouchersOnboardingCreateParams params, RequestOptions options)	Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.
static FrMealVouchersOnboarding	create(Map<String,Object> params)	Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.
static FrMealVouchersOnboarding	create(Map<String,Object> params, RequestOptions options)	Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.
boolean	equals(Object o)
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	Name of the restaurant.
String	getObject()	String representing the object's type.
String	getPostalCode()	Postal code of the restaurant.
FrMealVouchersOnboarding.Providers	getProviders()	This represents the onboarding state of the restaurant on different providers.
String	getSiret()	SIRET number associated with the restaurant.
int	hashCode()
static FrMealVouchersOnboardingCollection	list(FrMealVouchersOnboardingListParams params)	Lists French Meal Vouchers Onboarding objects.
static FrMealVouchersOnboardingCollection	list(FrMealVouchersOnboardingListParams params, RequestOptions options)	Lists French Meal Vouchers Onboarding objects.
static FrMealVouchersOnboardingCollection	list(Map<String,Object> params)	Lists French Meal Vouchers Onboarding objects.
static FrMealVouchersOnboardingCollection	list(Map<String,Object> params, RequestOptions options)	Lists French Meal Vouchers Onboarding objects.
static FrMealVouchersOnboarding	retrieve(String id)	Retrieves the details of a previously created French Meal Vouchers Onboarding object.
static FrMealVouchersOnboarding	retrieve(String id, RequestOptions options)	Retrieves the details of a previously created French Meal Vouchers Onboarding object.
static FrMealVouchersOnboarding	retrieve(String id, FrMealVouchersOnboardingRetrieveParams params, RequestOptions options)	Retrieves the details of a previously created French Meal Vouchers Onboarding object.
static FrMealVouchersOnboarding	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves the details of a previously created French Meal Vouchers Onboarding object.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	Name of the restaurant.
void	setObject(String object)	String representing the object's type.
void	setPostalCode(String postalCode)	Postal code of the restaurant.
void	setProviders(FrMealVouchersOnboarding.Providers providers)	This represents the onboarding state of the restaurant on different providers.
void	setResponseGetter(StripeResponseGetter responseGetter)	The specific onboarding requirement field (in the requirements hash) that needs to be resolved.
void	setSiret(String siret)	SIRET number associated with the restaurant.
FrMealVouchersOnboarding	update(FrMealVouchersOnboardingUpdateParams params)	Updates the details of a restaurant’s French Meal Vouchers Onboarding object by setting the values of the parameters passed.
FrMealVouchersOnboarding	update(FrMealVouchersOnboardingUpdateParams params, RequestOptions options)	Updates the details of a restaurant’s French Meal Vouchers Onboarding object by setting the values of the parameters passed.
FrMealVouchersOnboarding	update(Map<String,Object> params)	Updates the details of a restaurant’s French Meal Vouchers Onboarding object by setting the values of the parameters passed.
FrMealVouchersOnboarding	update(Map<String,Object> params, RequestOptions options)	Updates the details of a restaurant’s French Meal Vouchers Onboarding object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

FrMealVouchersOnboarding

public FrMealVouchersOnboarding()

Method Details

create

public static FrMealVouchersOnboarding create(Map<String,Object> params)
                                       throws StripeException

Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.

Throws:

StripeException

create

public static FrMealVouchersOnboarding create(Map<String,Object> params,
 RequestOptions options)
                                       throws StripeException

Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.

Throws:

StripeException

create

public static FrMealVouchersOnboarding create(FrMealVouchersOnboardingCreateParams params)
                                       throws StripeException

Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.

Throws:

StripeException

create

public static FrMealVouchersOnboarding create(FrMealVouchersOnboardingCreateParams params,
 RequestOptions options)
                                       throws StripeException

Creates a French Meal Vouchers Onboarding object that represents a restaurant’s onboarding status and starts the onboarding process.

Throws:

StripeException

list

public static FrMealVouchersOnboardingCollection list(Map<String,Object> params)
                                               throws StripeException

Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.

Throws:

StripeException

list

public static FrMealVouchersOnboardingCollection list(Map<String,Object> params,
 RequestOptions options)
                                               throws StripeException

Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.

Throws:

StripeException

list

public static FrMealVouchersOnboardingCollection list(FrMealVouchersOnboardingListParams params)
                                               throws StripeException

Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.

Throws:

StripeException

list

public static FrMealVouchersOnboardingCollection list(FrMealVouchersOnboardingListParams params,
 RequestOptions options)
                                               throws StripeException

Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.

Throws:

StripeException

retrieve

public static FrMealVouchersOnboarding retrieve(String id)
                                         throws StripeException

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.

Throws:

StripeException

retrieve

public static FrMealVouchersOnboarding retrieve(String id,
 RequestOptions options)
                                         throws StripeException

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.

Throws:

StripeException

retrieve

public static FrMealVouchersOnboarding retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                                         throws StripeException

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.

Throws:

StripeException

retrieve

public static FrMealVouchersOnboarding retrieve(String id,
 FrMealVouchersOnboardingRetrieveParams params,
 RequestOptions options)
                                         throws StripeException

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.

Throws:

StripeException

update

public FrMealVouchersOnboarding update(Map<String,Object> params)
                                throws StripeException

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.

Specified by:

update in interface MetadataStore<FrMealVouchersOnboarding>

Throws:

StripeException

update

public FrMealVouchersOnboarding update(Map<String,Object> params,
 RequestOptions options)
                                throws StripeException

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.

Specified by:

update in interface MetadataStore<FrMealVouchersOnboarding>

Throws:

StripeException

update

public FrMealVouchersOnboarding update(FrMealVouchersOnboardingUpdateParams params)
                                throws StripeException

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.

Throws:

StripeException

update

public FrMealVouchersOnboarding update(FrMealVouchersOnboardingUpdateParams params,
 RequestOptions options)
                                throws StripeException

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.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

The specific onboarding requirement field (in the requirements hash) that needs to be resolved.

One of postal_code, or siret.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getName

public String getName()

Name of the restaurant.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to fr_meal_vouchers_onboarding.

getPostalCode

public String getPostalCode()

Postal code of the restaurant.

getProviders

public FrMealVouchersOnboarding.Providers getProviders()

This represents the onboarding state of the restaurant on different providers.

getSiret

public String getSiret()

SIRET number associated with the restaurant.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setName

public void setName(String name)

Name of the restaurant.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to fr_meal_vouchers_onboarding.

setPostalCode

public void setPostalCode(String postalCode)

Postal code of the restaurant.

setProviders

public void setProviders(FrMealVouchersOnboarding.Providers providers)

This represents the onboarding state of the restaurant on different providers.

setSiret

public void setSiret(String siret)

SIRET number associated with the restaurant.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<FrMealVouchersOnboarding>