com.adobe.cq.commerce.magento.graphql.QueryQuery 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 java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.shopify.graphql.support.AbstractQuery;
import com.shopify.graphql.support.Arguments;
import com.shopify.graphql.support.Fragment;
public class QueryQuery extends AbstractQuery {
QueryQuery(StringBuilder _queryBuilder) {
super(_queryBuilder);
}
/**
* Returns information about shopping cart
*/
public QueryQuery cart(String cartId, CartQueryDefinition queryDef) {
startField("cart");
_queryBuilder.append("(cart_id:");
AbstractQuery.appendQuotedString(_queryBuilder, cartId.toString());
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new CartQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CategoriesArguments extends Arguments {
CategoriesArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Identifies which Category filter inputs to search for and return.
*/
public CategoriesArguments filters(CategoryFilterInput value) {
if (value != null) {
startArgument("filters");
value.appendTo(_queryBuilder);
}
return this;
}
/**
* Specifies the maximum number of results to return at once. This attribute is optional.
*/
public CategoriesArguments pageSize(Integer value) {
if (value != null) {
startArgument("pageSize");
_queryBuilder.append(value);
}
return this;
}
/**
* Specifies which page of results to return. The default value is 1.
*/
public CategoriesArguments currentPage(Integer value) {
if (value != null) {
startArgument("currentPage");
_queryBuilder.append(value);
}
return this;
}
}
public interface CategoriesArgumentsDefinition {
void define(CategoriesArguments args);
}
public QueryQuery categories(CategoryResultQueryDefinition queryDef) {
return categories(args -> {}, queryDef);
}
public QueryQuery categories(CategoriesArgumentsDefinition argsDef, CategoryResultQueryDefinition queryDef) {
startField("categories");
CategoriesArguments args = new CategoriesArguments(_queryBuilder);
argsDef.define(args);
CategoriesArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CategoryResultQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CategoryArguments extends Arguments {
CategoryArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Id of the category.
*/
public CategoryArguments id(Integer value) {
if (value != null) {
startArgument("id");
_queryBuilder.append(value);
}
return this;
}
}
public interface CategoryArgumentsDefinition {
void define(CategoryArguments args);
}
/**
* The category query searches for categories that match the criteria specified in the search and
* filter attributes.
*
* @deprecated Use 'categoryList' query instead of 'category' query
*/
public QueryQuery category(CategoryTreeQueryDefinition queryDef) {
return category(args -> {}, queryDef);
}
/**
* The category query searches for categories that match the criteria specified in the search and
* filter attributes.
*
* @deprecated Use 'categoryList' query instead of 'category' query
*/
@Deprecated
public QueryQuery category(CategoryArgumentsDefinition argsDef, CategoryTreeQueryDefinition queryDef) {
startField("category");
CategoryArguments args = new CategoryArguments(_queryBuilder);
argsDef.define(args);
CategoryArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CategoryTreeQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CategoryListArguments extends Arguments {
CategoryListArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Identifies which Category filter inputs to search for and return.
*/
public CategoryListArguments filters(CategoryFilterInput value) {
if (value != null) {
startArgument("filters");
value.appendTo(_queryBuilder);
}
return this;
}
}
public interface CategoryListArgumentsDefinition {
void define(CategoryListArguments args);
}
/**
* Returns an array of categories based on the specified filters.
*/
public QueryQuery categoryList(CategoryTreeQueryDefinition queryDef) {
return categoryList(args -> {}, queryDef);
}
/**
* Returns an array of categories based on the specified filters.
*/
public QueryQuery categoryList(CategoryListArgumentsDefinition argsDef, CategoryTreeQueryDefinition queryDef) {
startField("categoryList");
CategoryListArguments args = new CategoryListArguments(_queryBuilder);
argsDef.define(args);
CategoryListArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CategoryTreeQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The Checkout Agreements information
*/
public QueryQuery checkoutAgreements(CheckoutAgreementQueryDefinition queryDef) {
startField("checkoutAgreements");
_queryBuilder.append('{');
queryDef.define(new CheckoutAgreementQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CmsBlocksArguments extends Arguments {
CmsBlocksArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Identifiers of the CMS blocks
*/
public CmsBlocksArguments identifiers(List value) {
if (value != null) {
startArgument("identifiers");
_queryBuilder.append('[');
{
String listSeperator1 = "";
for (String item1 : value) {
_queryBuilder.append(listSeperator1);
listSeperator1 = ",";
AbstractQuery.appendQuotedString(_queryBuilder, item1.toString());
}
}
_queryBuilder.append(']');
}
return this;
}
}
public interface CmsBlocksArgumentsDefinition {
void define(CmsBlocksArguments args);
}
/**
* The CMS block query returns information about CMS blocks
*/
public QueryQuery cmsBlocks(CmsBlocksQueryDefinition queryDef) {
return cmsBlocks(args -> {}, queryDef);
}
/**
* The CMS block query returns information about CMS blocks
*/
public QueryQuery cmsBlocks(CmsBlocksArgumentsDefinition argsDef, CmsBlocksQueryDefinition queryDef) {
startField("cmsBlocks");
CmsBlocksArguments args = new CmsBlocksArguments(_queryBuilder);
argsDef.define(args);
CmsBlocksArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CmsBlocksQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CmsPageArguments extends Arguments {
CmsPageArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Id of the CMS page
*/
public CmsPageArguments id(Integer value) {
if (value != null) {
startArgument("id");
_queryBuilder.append(value);
}
return this;
}
/**
* Identifier of the CMS page
*/
public CmsPageArguments identifier(String value) {
if (value != null) {
startArgument("identifier");
AbstractQuery.appendQuotedString(_queryBuilder, value.toString());
}
return this;
}
}
public interface CmsPageArgumentsDefinition {
void define(CmsPageArguments args);
}
/**
* The CMS page query returns information about a CMS page
*/
public QueryQuery cmsPage(CmsPageQueryDefinition queryDef) {
return cmsPage(args -> {}, queryDef);
}
/**
* The CMS page query returns information about a CMS page
*/
public QueryQuery cmsPage(CmsPageArgumentsDefinition argsDef, CmsPageQueryDefinition queryDef) {
startField("cmsPage");
CmsPageArguments args = new CmsPageArguments(_queryBuilder);
argsDef.define(args);
CmsPageArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CmsPageQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The countries query provides information for all countries.
*/
public QueryQuery countries(CountryQueryDefinition queryDef) {
startField("countries");
_queryBuilder.append('{');
queryDef.define(new CountryQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class CountryArguments extends Arguments {
CountryArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
public CountryArguments id(String value) {
if (value != null) {
startArgument("id");
AbstractQuery.appendQuotedString(_queryBuilder, value.toString());
}
return this;
}
}
public interface CountryArgumentsDefinition {
void define(CountryArguments args);
}
/**
* The countries query provides information for a single country.
*/
public QueryQuery country(CountryQueryDefinition queryDef) {
return country(args -> {}, queryDef);
}
/**
* The countries query provides information for a single country.
*/
public QueryQuery country(CountryArgumentsDefinition argsDef, CountryQueryDefinition queryDef) {
startField("country");
CountryArguments args = new CountryArguments(_queryBuilder);
argsDef.define(args);
CountryArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new CountryQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The currency query returns information about store currency.
*/
public QueryQuery currency(CurrencyQueryDefinition queryDef) {
startField("currency");
_queryBuilder.append('{');
queryDef.define(new CurrencyQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The customAttributeMetadata query returns the attribute type, given an attribute code and entity
* type
*/
public QueryQuery customAttributeMetadata(List attributes, CustomAttributeMetadataQueryDefinition queryDef) {
startField("customAttributeMetadata");
_queryBuilder.append("(attributes:");
_queryBuilder.append('[');
{
String listSeperator1 = "";
for (AttributeInput item1 : attributes) {
_queryBuilder.append(listSeperator1);
listSeperator1 = ",";
item1.appendTo(_queryBuilder);
}
}
_queryBuilder.append(']');
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new CustomAttributeMetadataQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The customer query returns information about a customer account
*/
public QueryQuery customer(CustomerQueryDefinition queryDef) {
startField("customer");
_queryBuilder.append('{');
queryDef.define(new CustomerQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Returns information about the customer shopping cart
*/
public QueryQuery customerCart(CartQueryDefinition queryDef) {
startField("customerCart");
_queryBuilder.append('{');
queryDef.define(new CartQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The query returns the contents of a customer's downloadable products
*/
public QueryQuery customerDownloadableProducts(CustomerDownloadableProductsQueryDefinition queryDef) {
startField("customerDownloadableProducts");
_queryBuilder.append('{');
queryDef.define(new CustomerDownloadableProductsQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* List of customer orders
*/
public QueryQuery customerOrders(CustomerOrdersQueryDefinition queryDef) {
startField("customerOrders");
_queryBuilder.append('{');
queryDef.define(new CustomerOrdersQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Return a list of customer payment tokens
*/
public QueryQuery customerPaymentTokens(CustomerPaymentTokensQueryDefinition queryDef) {
startField("customerPaymentTokens");
_queryBuilder.append('{');
queryDef.define(new CustomerPaymentTokensQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Retrieve secure PayPal url for Payments Pro Hosted Solution transaction.
*/
public QueryQuery getHostedProUrl(HostedProUrlInput input, HostedProUrlQueryDefinition queryDef) {
startField("getHostedProUrl");
_queryBuilder.append("(input:");
input.appendTo(_queryBuilder);
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new HostedProUrlQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Retrieve payment credentials for transaction. Use this query for Payflow Link and Payments Advanced
* payment methods.
*/
public QueryQuery getPayflowLinkToken(PayflowLinkTokenInput input, PayflowLinkTokenQueryDefinition queryDef) {
startField("getPayflowLinkToken");
_queryBuilder.append("(input:");
input.appendTo(_queryBuilder);
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new PayflowLinkTokenQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public QueryQuery isEmailAvailable(String email, IsEmailAvailableOutputQueryDefinition queryDef) {
startField("isEmailAvailable");
_queryBuilder.append("(email:");
AbstractQuery.appendQuotedString(_queryBuilder, email.toString());
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new IsEmailAvailableOutputQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class PickupLocationsArguments extends Arguments {
PickupLocationsArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Perform search by location using radius and search term.
*/
public PickupLocationsArguments area(AreaInput value) {
if (value != null) {
startArgument("area");
value.appendTo(_queryBuilder);
}
return this;
}
/**
* Apply filters by attributes.
*/
public PickupLocationsArguments filters(PickupLocationFilterInput value) {
if (value != null) {
startArgument("filters");
value.appendTo(_queryBuilder);
}
return this;
}
/**
* Specifies which attribute to sort on, and whether to return the results in ascending or descending
* order.
*/
public PickupLocationsArguments sort(PickupLocationSortInput value) {
if (value != null) {
startArgument("sort");
value.appendTo(_queryBuilder);
}
return this;
}
/**
* The maximum number of pickup locations to return at once. The attribute is optional.
*/
public PickupLocationsArguments pageSize(Integer value) {
if (value != null) {
startArgument("pageSize");
_queryBuilder.append(value);
}
return this;
}
/**
* Specifies which page of results to return. The default value is 1.
*/
public PickupLocationsArguments currentPage(Integer value) {
if (value != null) {
startArgument("currentPage");
_queryBuilder.append(value);
}
return this;
}
}
public interface PickupLocationsArgumentsDefinition {
void define(PickupLocationsArguments args);
}
/**
* The pickup locations query searches for locations that match the search request requirements.
*/
public QueryQuery pickupLocations(PickupLocationsQueryDefinition queryDef) {
return pickupLocations(args -> {}, queryDef);
}
/**
* The pickup locations query searches for locations that match the search request requirements.
*/
public QueryQuery pickupLocations(PickupLocationsArgumentsDefinition argsDef, PickupLocationsQueryDefinition queryDef) {
startField("pickupLocations");
PickupLocationsArguments args = new PickupLocationsArguments(_queryBuilder);
argsDef.define(args);
PickupLocationsArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new PickupLocationsQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public class ProductsArguments extends Arguments {
ProductsArguments(StringBuilder _queryBuilder) {
super(_queryBuilder, true);
}
/**
* Performs a full-text search using the specified key words.
*/
public ProductsArguments search(String value) {
if (value != null) {
startArgument("search");
AbstractQuery.appendQuotedString(_queryBuilder, value.toString());
}
return this;
}
/**
* Identifies which product attributes to search for and return.
*/
public ProductsArguments filter(ProductAttributeFilterInput value) {
if (value != null) {
startArgument("filter");
value.appendTo(_queryBuilder);
}
return this;
}
/**
* Specifies the maximum number of results to return at once. This attribute is optional.
*/
public ProductsArguments pageSize(Integer value) {
if (value != null) {
startArgument("pageSize");
_queryBuilder.append(value);
}
return this;
}
/**
* Specifies which page of results to return. The default value is 1.
*/
public ProductsArguments currentPage(Integer value) {
if (value != null) {
startArgument("currentPage");
_queryBuilder.append(value);
}
return this;
}
/**
* Specifies which attributes to sort on, and whether to return the results in ascending or descending
* order.
*/
public ProductsArguments sort(ProductAttributeSortInput value) {
if (value != null) {
startArgument("sort");
value.appendTo(_queryBuilder);
}
return this;
}
}
public interface ProductsArgumentsDefinition {
void define(ProductsArguments args);
}
/**
* The products query searches for products that match the criteria specified in the search and filter
* attributes.
*/
public QueryQuery products(ProductsQueryDefinition queryDef) {
return products(args -> {}, queryDef);
}
/**
* The products query searches for products that match the criteria specified in the search and filter
* attributes.
*/
public QueryQuery products(ProductsArgumentsDefinition argsDef, ProductsQueryDefinition queryDef) {
startField("products");
ProductsArguments args = new ProductsArguments(_queryBuilder);
argsDef.define(args);
ProductsArguments.end(args);
_queryBuilder.append('{');
queryDef.define(new ProductsQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The store config query
*/
public QueryQuery storeConfig(StoreConfigQueryDefinition queryDef) {
startField("storeConfig");
_queryBuilder.append('{');
queryDef.define(new StoreConfigQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The urlResolver query returns the relative URL for a specified product, category or CMS page, using
* as input a url_key appended by the url_suffix, if one exists
*/
public QueryQuery urlResolver(String url, EntityUrlQueryDefinition queryDef) {
startField("urlResolver");
_queryBuilder.append("(url:");
AbstractQuery.appendQuotedString(_queryBuilder, url.toString());
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new EntityUrlQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The wishlist query returns the contents of a customer's wish list
*
* @deprecated Moved under `Customer` `wishlist`
*/
@Deprecated
public QueryQuery wishlist(WishlistOutputQueryDefinition queryDef) {
startField("wishlist");
_queryBuilder.append('{');
queryDef.define(new WishlistOutputQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
public String toString() {
if (fragments != null) {
for (Fragment fragment : fragments.values()) {
_queryBuilder.append(fragment.toString());
}
}
return _queryBuilder.toString();
}
private Map fragments;
/**
* Adds a GraphQL "named" fragment to the query. If a fragment with the same name is already added,
* calling this method will replace the existing fragment.
*
* @param fragment The fragment to add.
*/
public QueryQuery addFragment(Fragment fragment) {
if (fragments == null) {
fragments = new LinkedHashMap<>();
}
fragments.put(fragment.getName(), fragment);
return this;
}
/**
* The root __schema field for introspection queries.
*/
public QueryQuery __schema(__SchemaQueryDefinition queryDef) {
startField("__schema");
_queryBuilder.append('{');
queryDef.define(new __SchemaQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* The root __type field for introspection queries.
*/
public QueryQuery __type(String name, __TypeQueryDefinition queryDef) {
startField("__type");
_queryBuilder.append("(name:");
AbstractQuery.appendQuotedString(_queryBuilder, name);
_queryBuilder.append(')');
_queryBuilder.append('{');
queryDef.define(new __TypeQuery(_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, QueryQueryDefinition queryDef) {
StringBuilder sb = new StringBuilder();
queryDef.define(new QueryQuery(sb));
return new Fragment<>(name, "Query", sb.toString());
}
/**
* Adds a QueryQuery 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 QueryQuery addFragmentReference(Fragment fragment) {
startField("..." + fragment.getName());
return this;
}
}