Package com.stripe.model

Class Product

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Product

All Implemented Interfaces:

HasId, MetadataStore<Product>

public class Product
extends APIResource
implements HasId, MetadataStore<Product>

Nested Class Summary

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

APIResource.RequestMethod, APIResource.RequestType

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

Method Summary

Modifier and Type	Method	Description
static ProductCollection	all(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static ProductCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Product	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a product.
static Product	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a product.
DeletedProduct	delete()	Delete a product.
DeletedProduct	delete(RequestOptions options)	Delete a product.
boolean	equals(java.lang.Object o)
java.lang.Boolean	getActive()
java.util.List<java.lang.String>	getAttributes()
java.lang.String	getCaption()
java.lang.Long	getCreated()
java.util.List<java.lang.String>	getDeactivateOn()
java.lang.String	getDescription()
java.lang.String	getId()
java.util.List<java.lang.String>	getImages()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getName()
java.lang.String	getObject()
PackageDimensions	getPackageDimensions()
java.lang.Boolean	getShippable()
SKUCollection	getSkus()
java.lang.String	getStatementDescriptor()
java.lang.String	getType()
java.lang.Long	getUpdated()
java.lang.String	getURL()
int	hashCode()
static ProductCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List all products.
static ProductCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List all products.
static Product	retrieve(java.lang.String id)	Retrieve a product.
static Product	retrieve(java.lang.String id, RequestOptions options)	Retrieve a product.
void	setActive(java.lang.Boolean active)
void	setAttributes(java.util.List<java.lang.String> attributes)
void	setCaption(java.lang.String caption)
void	setCreated(java.lang.Long created)
void	setDeactivateOn(java.util.List<java.lang.String> deactivateOn)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setImages(java.util.List<java.lang.String> images)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setName(java.lang.String name)
void	setObject(java.lang.String object)
void	setPackageDimensions(PackageDimensions packageDimensions)
void	setShippable(java.lang.Boolean shippable)
void	setSkus(SKUCollection skus)
void	setStatementDescriptor(java.lang.String statementDescriptor)
void	setType(java.lang.String type)
void	setUpdated(java.lang.Long updated)
void	setURL(java.lang.String url)
Product	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a product.
Product	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a product.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class java.lang.Object

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

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Constructor Detail

Product

public Product()

Method Detail

getURL

public java.lang.String getURL()

setURL

public void setURL(java.lang.String url)

all

@Deprecated
public static ProductCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all products.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static ProductCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all products.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Product create(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Create a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Product create(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Create a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedProduct delete()
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Delete a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedProduct delete(RequestOptions options)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Delete a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static ProductCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

List all products.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static ProductCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                     RequestOptions options)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

List all products.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Product retrieve(java.lang.String id)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Product retrieve(java.lang.String id,
                               RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve a product.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Product update(java.util.Map<java.lang.String,java.lang.Object> params)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Update a product.

Specified by:

update in interface MetadataStore<Product>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Product update(java.util.Map<java.lang.String,java.lang.Object> params,
                      RequestOptions options)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Update a product.

Specified by:

update in interface MetadataStore<Product>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getActive

public java.lang.Boolean getActive()

getAttributes

public java.util.List<java.lang.String> getAttributes()

getCaption

public java.lang.String getCaption()

getCreated

public java.lang.Long getCreated()

getDeactivateOn

public java.util.List<java.lang.String> getDeactivateOn()

getDescription

public java.lang.String getDescription()

getImages

public java.util.List<java.lang.String> getImages()

getLivemode

public java.lang.Boolean getLivemode()

getName

public java.lang.String getName()

getPackageDimensions

public PackageDimensions getPackageDimensions()

getShippable

public java.lang.Boolean getShippable()

getSkus

public SKUCollection getSkus()

getStatementDescriptor

public java.lang.String getStatementDescriptor()

getType

public java.lang.String getType()

getUpdated

public java.lang.Long getUpdated()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setActive

public void setActive(java.lang.Boolean active)

setAttributes

public void setAttributes(java.util.List<java.lang.String> attributes)

setCaption

public void setCaption(java.lang.String caption)

setCreated

public void setCreated(java.lang.Long created)

setDeactivateOn

public void setDeactivateOn(java.util.List<java.lang.String> deactivateOn)

setDescription

public void setDescription(java.lang.String description)

setImages

public void setImages(java.util.List<java.lang.String> images)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setName

public void setName(java.lang.String name)

setPackageDimensions

public void setPackageDimensions(PackageDimensions packageDimensions)

setShippable

public void setShippable(java.lang.Boolean shippable)

setSkus

public void setSkus(SKUCollection skus)

setStatementDescriptor

public void setStatementDescriptor(java.lang.String statementDescriptor)

setType

public void setType(java.lang.String type)

setUpdated

public void setUpdated(java.lang.Long updated)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Product>