com.adobe.cq.commerce.magento.graphql

Class CustomerStoreCreditQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<CustomerStoreCreditQuery>

com.adobe.cq.commerce.magento.graphql.CustomerStoreCreditQuery

public class CustomerStoreCreditQuery
extends AbstractQuery<CustomerStoreCreditQuery>

Contains store credit information with balance and history

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CustomerStoreCreditQuery.BalanceHistoryArguments
static interface	CustomerStoreCreditQuery.BalanceHistoryArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
CustomerStoreCreditQuery	addFragmentReference(Fragment<CustomerStoreCreditQuery> fragment) Adds a CustomerStoreCreditQuery fragment reference at the current position of the query.
CustomerStoreCreditQuery	balanceHistory(CustomerStoreCreditHistoryQueryDefinition queryDef) Customer Store credit balance history.
CustomerStoreCreditQuery	balanceHistory(CustomerStoreCreditQuery.BalanceHistoryArgumentsDefinition argsDef, CustomerStoreCreditHistoryQueryDefinition queryDef) Customer Store credit balance history.
static Fragment<CustomerStoreCreditQuery>	createFragment(String name, CustomerStoreCreditQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CustomerStoreCreditQuery	currentBalance(MoneyQueryDefinition queryDef) Current balance on store credit
CustomerStoreCreditQuery	enabled() Indicates whether store credits are enabled.

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

balanceHistory

public CustomerStoreCreditQuery balanceHistory(CustomerStoreCreditHistoryQueryDefinition queryDef)

Customer Store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.

balanceHistory

public CustomerStoreCreditQuery balanceHistory(CustomerStoreCreditQuery.BalanceHistoryArgumentsDefinition argsDef,
                                               CustomerStoreCreditHistoryQueryDefinition queryDef)

Customer Store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.

currentBalance

public CustomerStoreCreditQuery currentBalance(MoneyQueryDefinition queryDef)

Current balance on store credit

enabled

public CustomerStoreCreditQuery enabled()

Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned

createFragment

public static Fragment<CustomerStoreCreditQuery> createFragment(String name,
                                                                CustomerStoreCreditQueryDefinition 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 CustomerStoreCreditQuery addFragmentReference(Fragment<CustomerStoreCreditQuery> fragment)

Adds a CustomerStoreCreditQuery 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.