com.adobe.cq.commerce.magento.graphql

Class Customer

java.lang.Object

com.shopify.graphql.support.AbstractResponse<Customer>

com.adobe.cq.commerce.magento.graphql.Customer

All Implemented Interfaces:

Serializable

public class Customer
extends AbstractResponse<Customer>

Customer defines the customer name and address and other details

See Also:

Serialized Form

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Customer()
Customer(com.google.gson.JsonObject fields)

Method Summary

Modifier and Type	Method and Description
List<CustomerAddress>	getAddresses() An array containing the customer's shipping and billing addresses
Boolean	getAllowRemoteShoppingAssistance() Indicates whether the customer has enabled remote shopping assistance
CompareList	getCompareList() The contents of the customer's compare list
String	getCreatedAt() Timestamp indicating when the account was created
String	getDateOfBirth() The customer's date of birth
String	getDefaultBilling() The ID assigned to the billing address
String	getDefaultShipping() The ID assigned to the shipping address
String	getDob() Deprecated. Use `date_of_birth` instead
String	getEmail() The customer's email address.
String	getFirstname() The customer's first name
Integer	getGender() The customer's gender (Male - 1, Female - 2)
String	getGraphQlTypeName()
Integer	getGroupId() Deprecated. Customer group should not be exposed in the storefront scenarios
Integer	getId() Deprecated. id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.
Boolean	getIsSubscribed() Indicates whether the customer is subscribed to the company's newsletter
String	getLastname() The customer's family name
String	getMiddlename() The customer's middle name
CustomerOrders	getOrders()
String	getPrefix() An honorific, such as Dr., Mr., or Mrs.
Return	getReturn() Retrieves details about the specified return request from the unique ID for a `Return` object
Returns	getReturns() Information about the customer's return requests.
ProductReviews	getReviews() Contains the customer's product reviews
RewardPoints	getRewardPoints() Customer reward points details
CustomerStoreCredit	getStoreCredit() Contains the store credit information applied for the logged in customer
String	getSuffix() A value such as Sr., Jr., or III
String	getTaxvat() The customer's Value-added tax (VAT) number (for corporate customers)
Wishlist	getWishlist() Deprecated. Use `Customer.wishlists` or `Customer.wishlist_v2`
List<Wishlist>	getWishlists() An array of wishlists.
Wishlist	getWishlistV2() Retrieve the specified wish list identified by the unique ID for a `Wishlist` object
Customer	setAddresses(List<CustomerAddress> arg)
Customer	setAllowRemoteShoppingAssistance(Boolean arg)
Customer	setCompareList(CompareList arg)
Customer	setCreatedAt(String arg)
Customer	setDateOfBirth(String arg)
Customer	setDefaultBilling(String arg)
Customer	setDefaultShipping(String arg)
Customer	setDob(String arg)
Customer	setEmail(String arg)
Customer	setFirstname(String arg)
Customer	setGender(Integer arg)
Customer	setGroupId(Integer arg)
Customer	setId(Integer arg)
Customer	setIsSubscribed(Boolean arg)
Customer	setLastname(String arg)
Customer	setMiddlename(String arg)
Customer	setOrders(CustomerOrders arg)
Customer	setPrefix(String arg)
Customer	setReturn(Return arg)
Customer	setReturns(Returns arg)
Customer	setReviews(ProductReviews arg)
Customer	setRewardPoints(RewardPoints arg)
Customer	setStoreCredit(CustomerStoreCredit arg)
Customer	setSuffix(String arg)
Customer	setTaxvat(String arg)
Customer	setWishlist(Wishlist arg)
Customer	setWishlists(List<Wishlist> arg)
Customer	setWishlistV2(Wishlist arg)
boolean	unwrapsToObject(String key)

Methods inherited from class com.shopify.graphql.support.AbstractResponse

collectNodes, get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, readCustomField, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Customer

public Customer()

Customer

public Customer(com.google.gson.JsonObject fields)
         throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public String getGraphQlTypeName()

getAddresses

public List<CustomerAddress> getAddresses()

An array containing the customer's shipping and billing addresses

setAddresses

public Customer setAddresses(List<CustomerAddress> arg)

getAllowRemoteShoppingAssistance

public Boolean getAllowRemoteShoppingAssistance()

Indicates whether the customer has enabled remote shopping assistance

setAllowRemoteShoppingAssistance

public Customer setAllowRemoteShoppingAssistance(Boolean arg)

getCompareList

public CompareList getCompareList()

The contents of the customer's compare list

setCompareList

public Customer setCompareList(CompareList arg)

getCreatedAt

public String getCreatedAt()

Timestamp indicating when the account was created

setCreatedAt

public Customer setCreatedAt(String arg)

getDateOfBirth

public String getDateOfBirth()

The customer's date of birth

setDateOfBirth

public Customer setDateOfBirth(String arg)

getDefaultBilling

public String getDefaultBilling()

The ID assigned to the billing address

setDefaultBilling

public Customer setDefaultBilling(String arg)

getDefaultShipping

public String getDefaultShipping()

The ID assigned to the shipping address

setDefaultShipping

public Customer setDefaultShipping(String arg)

getDob

@Deprecated
public String getDob()

Deprecated. Use `date_of_birth` instead

The customer's date of birth

setDob

public Customer setDob(String arg)

getEmail

public String getEmail()

The customer's email address. Required

setEmail

public Customer setEmail(String arg)

getFirstname

public String getFirstname()

The customer's first name

setFirstname

public Customer setFirstname(String arg)

getGender

public Integer getGender()

The customer's gender (Male - 1, Female - 2)

setGender

public Customer setGender(Integer arg)

getGroupId

@Deprecated
public Integer getGroupId()

Deprecated. Customer group should not be exposed in the storefront scenarios

setGroupId

public Customer setGroupId(Integer arg)

getId

@Deprecated
public Integer getId()

Deprecated. id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.

The ID assigned to the customer

setId

public Customer setId(Integer arg)

getIsSubscribed

public Boolean getIsSubscribed()

Indicates whether the customer is subscribed to the company's newsletter

setIsSubscribed

public Customer setIsSubscribed(Boolean arg)

getLastname

public String getLastname()

The customer's family name

setLastname

public Customer setLastname(String arg)

getMiddlename

public String getMiddlename()

The customer's middle name

setMiddlename

public Customer setMiddlename(String arg)

getOrders

public CustomerOrders getOrders()

setOrders

public Customer setOrders(CustomerOrders arg)

getPrefix

public String getPrefix()

An honorific, such as Dr., Mr., or Mrs.

setPrefix

public Customer setPrefix(String arg)

getReturn

public Return getReturn()

Retrieves details about the specified return request from the unique ID for a `Return` object

setReturn

public Customer setReturn(Return arg)

getReturns

public Returns getReturns()

Information about the customer's return requests.

setReturns

public Customer setReturns(Returns arg)

getReviews

public ProductReviews getReviews()

Contains the customer's product reviews

setReviews

public Customer setReviews(ProductReviews arg)

getRewardPoints

public RewardPoints getRewardPoints()

Customer reward points details

setRewardPoints

public Customer setRewardPoints(RewardPoints arg)

getStoreCredit

public CustomerStoreCredit getStoreCredit()

Contains the store credit information applied for the logged in customer

setStoreCredit

public Customer setStoreCredit(CustomerStoreCredit arg)

getSuffix

public String getSuffix()

A value such as Sr., Jr., or III

setSuffix

public Customer setSuffix(String arg)

getTaxvat

public String getTaxvat()

The customer's Value-added tax (VAT) number (for corporate customers)

setTaxvat

public Customer setTaxvat(String arg)

getWishlist

@Deprecated
public Wishlist getWishlist()

Deprecated. Use `Customer.wishlists` or `Customer.wishlist_v2`

Contains a customer's wish lists

setWishlist

public Customer setWishlist(Wishlist arg)

getWishlistV2

public Wishlist getWishlistV2()

Retrieve the specified wish list identified by the unique ID for a `Wishlist` object

setWishlistV2

public Customer setWishlistV2(Wishlist arg)

getWishlists

public List<Wishlist> getWishlists()

An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Magento Commerce

setWishlists

public Customer setWishlists(List<Wishlist> arg)

unwrapsToObject

public boolean unwrapsToObject(String key)

Specified by:

unwrapsToObject in class AbstractResponse<Customer>