Package com.stripe.model.issuing

Class CardDesign

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.CardDesign

All Implemented Interfaces:

HasId, MetadataStore<CardDesign>, StripeObjectInterface

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CardDesign.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

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
CardDesign()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getCardBundle()	Get ID of expandable cardBundle object.
CardBundle	getCardBundleObject()	Get expanded cardBundle.
String	getId()	Unique identifier for the object.
String	getLookupKey()	A lookup key used to retrieve card 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	getPreference()	Whether this card design is used to create cards when one is not specified.
String	getStatus()	Whether this card design can be used to create cards.
CardDesign.TestHelpers	getTestHelpers()
int	hashCode()
static CardDesignCollection	list(CardDesignListParams params)	Returns a list of card design objects.
static CardDesignCollection	list(CardDesignListParams params, RequestOptions options)	Returns a list of card design objects.
static CardDesignCollection	list(Map<String,Object> params)	Returns a list of card design objects.
static CardDesignCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of card design objects.
static CardDesign	retrieve(String cardDesign)	Retrieves a card design object.
static CardDesign	retrieve(String cardDesign, RequestOptions options)	Retrieves a card design object.
static CardDesign	retrieve(String cardDesign, CardDesignRetrieveParams params, RequestOptions options)	Retrieves a card design object.
static CardDesign	retrieve(String cardDesign, Map<String,Object> params, RequestOptions options)	Retrieves a card design object.
void	setCardBundle(String id)
void	setCardBundleObject(CardBundle expandableObject)
void	setId(String id)	Unique identifier for the object.
void	setLookupKey(String lookupKey)	A lookup key used to retrieve card 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	setPreference(String preference)	Whether this card design is used to create cards when one is not specified.
void	setStatus(String status)	Whether this card design can be used to create cards.
CardDesign	update(CardDesignUpdateParams params)	Updates a card design object.
CardDesign	update(CardDesignUpdateParams params, RequestOptions options)	Updates a card design object.
CardDesign	update(Map<String,Object> params)	Updates a card design object.
CardDesign	update(Map<String,Object> params, RequestOptions options)	Updates a card design object.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CardDesign

public CardDesign()

Method Details

getCardBundle

public String getCardBundle()

Get ID of expandable cardBundle object.

setCardBundle

public void setCardBundle(String id)

getCardBundleObject

public CardBundle getCardBundleObject()

Get expanded cardBundle.

setCardBundleObject

public void setCardBundleObject(CardBundle expandableObject)

list

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

Returns a list of card 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 CardDesignCollection list(Map<String,Object> params,
 RequestOptions options)
                                 throws StripeException

Returns a list of card 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 CardDesignCollection list(CardDesignListParams params)
                                 throws StripeException

Returns a list of card 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 CardDesignCollection list(CardDesignListParams params,
 RequestOptions options)
                                 throws StripeException

Returns a list of card 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 CardDesign retrieve(String cardDesign)
                           throws StripeException

Retrieves a card design object.

Throws:

StripeException

retrieve

public static CardDesign retrieve(String cardDesign,
 RequestOptions options)
                           throws StripeException

Retrieves a card design object.

Throws:

StripeException

retrieve

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

Retrieves a card design object.

Throws:

StripeException

retrieve

public static CardDesign retrieve(String cardDesign,
 CardDesignRetrieveParams params,
 RequestOptions options)
                           throws StripeException

Retrieves a card design object.

Throws:

StripeException

update

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

Updates a card design object.

Specified by:

update in interface MetadataStore<CardDesign>

Throws:

StripeException

update

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

Updates a card design object.

Specified by:

update in interface MetadataStore<CardDesign>

Throws:

StripeException

update

public CardDesign update(CardDesignUpdateParams params)
                  throws StripeException

Updates a card design object.

Throws:

StripeException

update

public CardDesign update(CardDesignUpdateParams params,
 RequestOptions options)
                  throws StripeException

Updates a card design object.

Throws:

StripeException

getTestHelpers

public CardDesign.TestHelpers getTestHelpers()

getLookupKey

public String getLookupKey()

A lookup key used to retrieve card 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.card_design.

getPreference

public String getPreference()

Whether this card design is used to create cards when one is not specified.

One of default, or none.

getStatus

public String getStatus()

Whether this card design can be used to create cards.

One of active, inactive, rejected, or review.

setId

public void setId(String id)

Unique identifier for the object.

setLookupKey

public void setLookupKey(String lookupKey)

A lookup key used to retrieve card 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.card_design.

setPreference

public void setPreference(String preference)

Whether this card design is used to create cards when one is not specified.

One of default, or none.

setStatus

public void setStatus(String status)

Whether this card 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<CardDesign>