Package com.stripe.model.issuing

Class PersonalizationDesign

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.PersonalizationDesign

All Implemented Interfaces:

HasId, MetadataStore<PersonalizationDesign>, StripeActiveObject, StripeObjectInterface

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

A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersonalizationDesign.CarrierText	For more details about CarrierText, please refer to the API Reference.
static class	PersonalizationDesign.Preferences	For more details about Preferences, please refer to the API Reference.
static class	PersonalizationDesign.RejectionReasons	For more details about RejectionReasons, please refer to the API Reference.
static class	PersonalizationDesign.TestHelpers

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
PersonalizationDesign()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static PersonalizationDesign	create(PersonalizationDesignCreateParams params)	Creates a personalization design object.
static PersonalizationDesign	create(PersonalizationDesignCreateParams params, RequestOptions options)	Creates a personalization design object.
static PersonalizationDesign	create(Map<String,Object> params)	Creates a personalization design object.
static PersonalizationDesign	create(Map<String,Object> params, RequestOptions options)	Creates a personalization design object.
boolean	equals(Object o)
String	getCardLogo()	Get ID of expandable cardLogo object.
File	getCardLogoObject()	Get expanded cardLogo.
PersonalizationDesign.CarrierText	getCarrierText()	Hash containing carrier text, for use with physical bundles that support carrier text.
Long	getCreated()	Time at which the object was created.
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.
String	getLookupKey()	A lookup key used to retrieve personalization designs dynamically from a static string.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	Friendly display name.
String	getObject()	String representing the object's type.
String	getPhysicalBundle()	Get ID of expandable physicalBundle object.
PhysicalBundle	getPhysicalBundleObject()	Get expanded physicalBundle.
PersonalizationDesign.Preferences	getPreferences()
PersonalizationDesign.RejectionReasons	getRejectionReasons()
String	getStatus()	Whether this personalization design can be used to create cards.
PersonalizationDesign.TestHelpers	getTestHelpers()
int	hashCode()
static PersonalizationDesignCollection	list(PersonalizationDesignListParams params)	Returns a list of personalization design objects.
static PersonalizationDesignCollection	list(PersonalizationDesignListParams params, RequestOptions options)	Returns a list of personalization design objects.
static PersonalizationDesignCollection	list(Map<String,Object> params)	Returns a list of personalization design objects.
static PersonalizationDesignCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of personalization design objects.
static PersonalizationDesign	retrieve(String personalizationDesign)	Retrieves a personalization design object.
static PersonalizationDesign	retrieve(String personalizationDesign, RequestOptions options)	Retrieves a personalization design object.
static PersonalizationDesign	retrieve(String personalizationDesign, PersonalizationDesignRetrieveParams params, RequestOptions options)	Retrieves a personalization design object.
static PersonalizationDesign	retrieve(String personalizationDesign, Map<String,Object> params, RequestOptions options)	Retrieves a personalization design object.
void	setCardLogo(String id)
void	setCardLogoObject(File expandableObject)
void	setCarrierText(PersonalizationDesign.CarrierText carrierText)	Hash containing carrier text, for use with physical bundles that support carrier text.
void	setCreated(Long created)	Time at which the object was created.
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	setLookupKey(String lookupKey)	A lookup key used to retrieve personalization designs dynamically from a static string.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	Friendly display name.
void	setObject(String object)	String representing the object's type.
void	setPhysicalBundle(String id)
void	setPhysicalBundleObject(PhysicalBundle expandableObject)
void	setPreferences(PersonalizationDesign.Preferences preferences)
void	setRejectionReasons(PersonalizationDesign.RejectionReasons rejectionReasons)
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	Whether this personalization design can be used to create cards.
PersonalizationDesign	update(PersonalizationDesignUpdateParams params)	Updates a card personalization object.
PersonalizationDesign	update(PersonalizationDesignUpdateParams params, RequestOptions options)	Updates a card personalization object.
PersonalizationDesign	update(Map<String,Object> params)	Updates a card personalization object.
PersonalizationDesign	update(Map<String,Object> params, RequestOptions options)	Updates a card personalization object.

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

PersonalizationDesign

public PersonalizationDesign()

Method Details

getCardLogo

public String getCardLogo()

Get ID of expandable cardLogo object.

setCardLogo

public void setCardLogo(String id)

getCardLogoObject

public File getCardLogoObject()

Get expanded cardLogo.

setCardLogoObject

public void setCardLogoObject(File expandableObject)

getPhysicalBundle

public String getPhysicalBundle()

Get ID of expandable physicalBundle object.

setPhysicalBundle

public void setPhysicalBundle(String id)

getPhysicalBundleObject

public PhysicalBundle getPhysicalBundleObject()

Get expanded physicalBundle.

setPhysicalBundleObject

public void setPhysicalBundleObject(PhysicalBundle expandableObject)

create

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

Creates a personalization design object.

Throws:

StripeException

create

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

Creates a personalization design object.

Throws:

StripeException

create

public static PersonalizationDesign create(PersonalizationDesignCreateParams params)
                                    throws StripeException

Creates a personalization design object.

Throws:

StripeException

create

public static PersonalizationDesign create(PersonalizationDesignCreateParams params,
 RequestOptions options)
                                    throws StripeException

Creates a personalization design object.

Throws:

StripeException

list

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

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

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

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static PersonalizationDesignCollection list(PersonalizationDesignListParams params)
                                            throws StripeException

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static PersonalizationDesignCollection list(PersonalizationDesignListParams params,
 RequestOptions options)
                                            throws StripeException

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

retrieve

public static PersonalizationDesign retrieve(String personalizationDesign)
                                      throws StripeException

Retrieves a personalization design object.

Throws:

StripeException

retrieve

public static PersonalizationDesign retrieve(String personalizationDesign,
 RequestOptions options)
                                      throws StripeException

Retrieves a personalization design object.

Throws:

StripeException

retrieve

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

Retrieves a personalization design object.

Throws:

StripeException

retrieve

public static PersonalizationDesign retrieve(String personalizationDesign,
 PersonalizationDesignRetrieveParams params,
 RequestOptions options)
                                      throws StripeException

Retrieves a personalization design object.

Throws:

StripeException

update

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

Updates a card personalization object.

Specified by:

update in interface MetadataStore<PersonalizationDesign>

Throws:

StripeException

update

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

Updates a card personalization object.

Specified by:

update in interface MetadataStore<PersonalizationDesign>

Throws:

StripeException

update

public PersonalizationDesign update(PersonalizationDesignUpdateParams params)
                             throws StripeException

Updates a card personalization object.

Throws:

StripeException

update

public PersonalizationDesign update(PersonalizationDesignUpdateParams params,
 RequestOptions options)
                             throws StripeException

Updates a card personalization object.

Throws:

StripeException

getTestHelpers

public PersonalizationDesign.TestHelpers getTestHelpers()

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getCarrierText

public PersonalizationDesign.CarrierText getCarrierText()

Hash containing carrier text, for use with physical bundles that support carrier text.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

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.

getLookupKey

public String getLookupKey()

A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.

getName

public String getName()

Friendly display name.

getObject

public String getObject()

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

Equal to issuing.personalization_design.

getPreferences

public PersonalizationDesign.Preferences getPreferences()

getRejectionReasons

public PersonalizationDesign.RejectionReasons getRejectionReasons()

getStatus

public String getStatus()

Whether this personalization design can be used to create cards.

One of active, inactive, rejected, or review.

setCarrierText

public void setCarrierText(PersonalizationDesign.CarrierText carrierText)

Hash containing carrier text, for use with physical bundles that support carrier text.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

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.

setLookupKey

public void setLookupKey(String lookupKey)

A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.

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)

Friendly display name.

setObject

public void setObject(String object)

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

Equal to issuing.personalization_design.

setPreferences

public void setPreferences(PersonalizationDesign.Preferences preferences)

setRejectionReasons

public void setRejectionReasons(PersonalizationDesign.RejectionReasons rejectionReasons)

setStatus

public void setStatus(String status)

Whether this personalization design can be used to create cards.

One of active, inactive, rejected, or review.

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<PersonalizationDesign>