com.adobe.cq.commerce.magento.graphql.CustomerQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of magento-graphql Show documentation
Show all versions of magento-graphql Show documentation
AEM bundle for the Magento GraphQL data models and query builders
/*******************************************************************************
*
* Copyright 2020 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*
******************************************************************************/
package com.adobe.cq.commerce.magento.graphql;
import com.shopify.graphql.support.AbstractQuery;
import com.shopify.graphql.support.Fragment;
/**
* Customer defines the customer name and address and other details
*/
public class CustomerQuery extends AbstractQuery {
CustomerQuery(StringBuilder _queryBuilder) {
super(_queryBuilder);
}
/**
* An array containing the customer's shipping and billing addresses
*/
public CustomerQuery addresses(CustomerAddressQueryDefinition queryDef) {
startField("addresses");
_queryBuilder.append('{');
queryDef.define(new CustomerAddressQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Timestamp indicating when the account was created
*/
public CustomerQuery createdAt() {
startField("created_at");
return this;
}
/**
* The customer's date of birth
*/
public CustomerQuery dateOfBirth() {
startField("date_of_birth");
return this;
}
/**
* The ID assigned to the billing address
*/
public CustomerQuery defaultBilling() {
startField("default_billing");
return this;
}
/**
* The ID assigned to the shipping address
*/
public CustomerQuery defaultShipping() {
startField("default_shipping");
return this;
}
/**
* The customer's date of birth
*
* @deprecated Use `date_of_birth` instead
*/
@Deprecated
public CustomerQuery dob() {
startField("dob");
return this;
}
/**
* The customer's email address. Required
*/
public CustomerQuery email() {
startField("email");
return this;
}
/**
* The customer's first name
*/
public CustomerQuery firstname() {
startField("firstname");
return this;
}
/**
* The customer's gender (Male - 1, Female - 2)
*/
public CustomerQuery gender() {
startField("gender");
return this;
}
/**
* @deprecated Customer group should not be exposed in the storefront scenarios
*/
@Deprecated
public CustomerQuery groupId() {
startField("group_id");
return this;
}
/**
* The ID assigned to the customer
*
* @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.
*/
@Deprecated
public CustomerQuery id() {
startField("id");
return this;
}
/**
* Indicates whether the customer is subscribed to the company's newsletter
*/
public CustomerQuery isSubscribed() {
startField("is_subscribed");
return this;
}
/**
* The customer's family name
*/
public CustomerQuery lastname() {
startField("lastname");
return this;
}
/**
* The customer's middle name
*/
public CustomerQuery middlename() {
startField("middlename");
return this;
}
/**
* An honorific, such as Dr., Mr., or Mrs.
*/
public CustomerQuery prefix() {
startField("prefix");
return this;
}
/**
* A value such as Sr., Jr., or III
*/
public CustomerQuery suffix() {
startField("suffix");
return this;
}
/**
* The customer's Value-added tax (VAT) number (for corporate customers)
*/
public CustomerQuery taxvat() {
startField("taxvat");
return this;
}
/**
* The wishlist query returns the contents of a customer's wish lists
*/
public CustomerQuery wishlist(WishlistQueryDefinition queryDef) {
startField("wishlist");
_queryBuilder.append('{');
queryDef.define(new WishlistQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* 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.
*
* @param name The name of the fragment, must be unique for a given GraphQL request.
* @param queryDef The fragment definition.
* @return The fragment of a given generics type.
*/
public static Fragment createFragment(String name, CustomerQueryDefinition queryDef) {
StringBuilder sb = new StringBuilder();
queryDef.define(new CustomerQuery(sb));
return new Fragment<>(name, "Customer", sb.toString());
}
/**
* 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.
*
* @param fragment The fragment to reference.
*/
public CustomerQuery addFragmentReference(Fragment fragment) {
startField("..." + fragment.getName());
return this;
}
}