CustomerQuery (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.shopify.graphql.support.AbstractQuery<CustomerQuery>
- - com.adobe.cq.commerce.magento.graphql.CustomerQuery

public class CustomerQuery
extends AbstractQuery<CustomerQuery>

Customer defines the customer name and address and other details

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`CustomerQuery.OrdersArguments`
`static interface`	`CustomerQuery.OrdersArgumentsDefinition`
`class`	`CustomerQuery.ReturnsArguments`
`static interface`	`CustomerQuery.ReturnsArgumentsDefinition`
`class`	`CustomerQuery.ReviewsArguments`
`static interface`	`CustomerQuery.ReviewsArgumentsDefinition`
`class`	`CustomerQuery.WishlistsArguments`
`static interface`	`CustomerQuery.WishlistsArgumentsDefinition`

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractQuery
  _queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CustomerQuery`	`addFragmentReference(Fragment<CustomerQuery> fragment)` Adds a `CustomerQuery` fragment reference at the current position of the query.
`CustomerQuery`	`addresses(CustomerAddressQueryDefinition queryDef)` An array containing the customer's shipping and billing addresses
`CustomerQuery`	`allowRemoteShoppingAssistance()` Indicates whether the customer has enabled remote shopping assistance
`CustomerQuery`	`compareList(CompareListQueryDefinition queryDef)` The contents of the customer's compare list
`CustomerQuery`	`createdAt()` Timestamp indicating when the account was created
`static Fragment<CustomerQuery>`	`createFragment(String name, CustomerQueryDefinition queryDef)` Creates a GraphQL "named" fragment with the specified query type definition.
`CustomerQuery`	`dateOfBirth()` The customer's date of birth
`CustomerQuery`	`defaultBilling()` The ID assigned to the billing address
`CustomerQuery`	`defaultShipping()` The ID assigned to the shipping address
`CustomerQuery`	`dob()` Deprecated. Use `date_of_birth` instead
`CustomerQuery`	`email()` The customer's email address.
`CustomerQuery`	`firstname()` The customer's first name
`CustomerQuery`	`gender()` The customer's gender (Male - 1, Female - 2)
`CustomerQuery`	`groupId()` Deprecated. Customer group should not be exposed in the storefront scenarios
`CustomerQuery`	`id()` 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.
`CustomerQuery`	`isSubscribed()` Indicates whether the customer is subscribed to the company's newsletter
`CustomerQuery`	`lastname()` The customer's family name
`CustomerQuery`	`middlename()` The customer's middle name
`CustomerQuery`	`orders(CustomerOrdersQueryDefinition queryDef)`
`CustomerQuery`	`orders(CustomerQuery.OrdersArgumentsDefinition argsDef, CustomerOrdersQueryDefinition queryDef)`
`CustomerQuery`	`prefix()` An honorific, such as Dr., Mr., or Mrs.
`CustomerQuery`	`returns(CustomerQuery.ReturnsArgumentsDefinition argsDef, ReturnsQueryDefinition queryDef)` Information about the customer's return requests.
`CustomerQuery`	`returns(ReturnsQueryDefinition queryDef)` Information about the customer's return requests.
`CustomerQuery`	`returnValue(ID uid, ReturnQueryDefinition queryDef)` Retrieves details about the specified return request from the unique ID for a `Return` object
`CustomerQuery`	`reviews(CustomerQuery.ReviewsArgumentsDefinition argsDef, ProductReviewsQueryDefinition queryDef)` Contains the customer's product reviews
`CustomerQuery`	`reviews(ProductReviewsQueryDefinition queryDef)` Contains the customer's product reviews
`CustomerQuery`	`rewardPoints(RewardPointsQueryDefinition queryDef)` Customer reward points details
`CustomerQuery`	`storeCredit(CustomerStoreCreditQueryDefinition queryDef)` Contains the store credit information applied for the logged in customer
`CustomerQuery`	`suffix()` A value such as Sr., Jr., or III
`CustomerQuery`	`taxvat()` The customer's Value-added tax (VAT) number (for corporate customers)
`CustomerQuery`	`wishlist(WishlistQueryDefinition queryDef)` Deprecated. Use `Customer.wishlists` or `Customer.wishlist_v2`
`CustomerQuery`	`wishlists(CustomerQuery.WishlistsArgumentsDefinition argsDef, WishlistQueryDefinition queryDef)` An array of wishlists.
`CustomerQuery`	`wishlists(WishlistQueryDefinition queryDef)` An array of wishlists.
`CustomerQuery`	`wishlistV2(ID id, WishlistQueryDefinition queryDef)` Retrieve the specified wish list identified by the unique ID for a `Wishlist` object

Methods inherited from class com.shopify.graphql.support.AbstractQuery
addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addresses
```
public CustomerQuery addresses(CustomerAddressQueryDefinition queryDef)
```
    An array containing the customer's shipping and billing addresses
  - allowRemoteShoppingAssistance
```
public CustomerQuery allowRemoteShoppingAssistance()
```
    Indicates whether the customer has enabled remote shopping assistance
  - compareList
```
public CustomerQuery compareList(CompareListQueryDefinition queryDef)
```
    The contents of the customer's compare list
  - createdAt
```
public CustomerQuery createdAt()
```
    Timestamp indicating when the account was created
  - dateOfBirth
```
public CustomerQuery dateOfBirth()
```
    The customer's date of birth
  - defaultBilling
```
public CustomerQuery defaultBilling()
```
    The ID assigned to the billing address
  - defaultShipping
```
public CustomerQuery defaultShipping()
```
    The ID assigned to the shipping address
  - dob
```
@Deprecated
public CustomerQuery dob()
```
    Deprecated. Use `date_of_birth` instead
    
    The customer's date of birth
  - email
```
public CustomerQuery email()
```
    The customer's email address. Required
  - firstname
```
public CustomerQuery firstname()
```
    The customer's first name
  - gender
```
public CustomerQuery gender()
```
    The customer's gender (Male - 1, Female - 2)
  - groupId
```
@Deprecated
public CustomerQuery groupId()
```
    Deprecated. Customer group should not be exposed in the storefront scenarios
  - id
```
@Deprecated
public CustomerQuery id()
```
    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
  - isSubscribed
```
public CustomerQuery isSubscribed()
```
    Indicates whether the customer is subscribed to the company's newsletter
  - lastname
```
public CustomerQuery lastname()
```
    The customer's family name
  - middlename
```
public CustomerQuery middlename()
```
    The customer's middle name
  - orders
```
public CustomerQuery orders(CustomerOrdersQueryDefinition queryDef)
```
  - orders
```
public CustomerQuery orders(CustomerQuery.OrdersArgumentsDefinition argsDef,
                            CustomerOrdersQueryDefinition queryDef)
```
  - prefix
```
public CustomerQuery prefix()
```
    An honorific, such as Dr., Mr., or Mrs.
  - returnValue
```
public CustomerQuery returnValue(ID uid,
                                 ReturnQueryDefinition queryDef)
```
    Retrieves details about the specified return request from the unique ID for a `Return` object
  - returns
```
public CustomerQuery returns(ReturnsQueryDefinition queryDef)
```
    Information about the customer's return requests.
  - returns
```
public CustomerQuery returns(CustomerQuery.ReturnsArgumentsDefinition argsDef,
                             ReturnsQueryDefinition queryDef)
```
    Information about the customer's return requests.
  - reviews
```
public CustomerQuery reviews(ProductReviewsQueryDefinition queryDef)
```
    Contains the customer's product reviews
  - reviews
```
public CustomerQuery reviews(CustomerQuery.ReviewsArgumentsDefinition argsDef,
                             ProductReviewsQueryDefinition queryDef)
```
    Contains the customer's product reviews
  - rewardPoints
```
public CustomerQuery rewardPoints(RewardPointsQueryDefinition queryDef)
```
    Customer reward points details
  - storeCredit
```
public CustomerQuery storeCredit(CustomerStoreCreditQueryDefinition queryDef)
```
    Contains the store credit information applied for the logged in customer
  - suffix
```
public CustomerQuery suffix()
```
    A value such as Sr., Jr., or III
  - taxvat
```
public CustomerQuery taxvat()
```
    The customer's Value-added tax (VAT) number (for corporate customers)
  - wishlist
```
@Deprecated
public CustomerQuery wishlist(WishlistQueryDefinition queryDef)
```
    Deprecated. Use `Customer.wishlists` or `Customer.wishlist_v2`
    
    Contains a customer's wish lists
  - wishlistV2
```
public CustomerQuery wishlistV2(ID id,
                                WishlistQueryDefinition queryDef)
```
    Retrieve the specified wish list identified by the unique ID for a `Wishlist` object
  - wishlists
```
public CustomerQuery wishlists(WishlistQueryDefinition queryDef)
```
    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
  - wishlists
```
public CustomerQuery wishlists(CustomerQuery.WishlistsArgumentsDefinition argsDef,
                               WishlistQueryDefinition queryDef)
```
    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
  - createFragment
```
public static Fragment<CustomerQuery> createFragment(String name,
                                                     CustomerQueryDefinition queryDef)
```
    Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.
    
    Parameters:
    
    name - The name of the fragment, must be unique for a given GraphQL request.
    
    queryDef - The fragment definition.
    
    Returns:
    
    The fragment of a given generics type.
  - addFragmentReference
```
public CustomerQuery addFragmentReference(Fragment<CustomerQuery> fragment)
```
    Adds a CustomerQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.
    
    Parameters:
    
    fragment - The fragment to reference.

Class CustomerQuery

Nested Class Summary

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addresses

allowRemoteShoppingAssistance

compareList

createdAt

dateOfBirth

defaultBilling

defaultShipping

dob

email

firstname

gender

groupId

id

isSubscribed

lastname

middlename

orders

orders

prefix

returnValue

returns

returns

reviews

reviews

rewardPoints

storeCredit

suffix

taxvat

wishlist

wishlistV2

wishlists

wishlists

createFragment

addFragmentReference