Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead,JsonNode>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead>,ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead>,ClientRequestCommand<JsonNode>,CreateHttpRequestCommand,HttpRequestCommand<JsonNode>,RequestCommand<JsonNode>
public class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead,JsonNode>
implements ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead>
Checks if one or more ShoppingLists exist for the provided query predicate for the authenticated Customer or anonymous user in a Store. Returns 200 OK status if successful.
A Not Found error is returned in the following scenarios:
- If no ShoppingLists exist for the provided query predicate in a Store.
- If a ShoppingList matches the query predicate but does not have a
storespecified, or thestorefield references a different Store. - If a ShoppingList exists in a Store but does not contain either an
anonymousIdthat matches the anonymous_id:{id} scope, or acustomerwithidvalue that matches the customer:{id} scope.
CompletableFuture<ApiHttpResponse<com.fasterxml.jackson.databind.JsonNode>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.me()
.shoppingLists()
.head()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,V> -
Constructor Summary
ConstructorsConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead t) ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
Method Summary
Modifier and TypeMethodDescriptionaddWhere(Collection<TValue> where) add additional where query parametersadd additional where query parameteradd additional where query parameteraddWhere(TValue where) add additional where query parameterbooleanexecute(ApiHttpClient client) executeBlocking(ApiHttpClient client, Duration timeout) getWhere()inthashCode()intcom.fasterxml.jackson.core.type.TypeReference<JsonNode>voidsetProjectKey(String projectKey) voidsetStoreKey(String storeKey) toString()withWhere(Collection<TValue> where) set where with the specified valuesset where with the specified valueset where with the specified valuewithWhere(TValue where) set where with the specified valueMethods inherited from class io.vrap.rmf.base.client.ApiMethod
addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParamsMethods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlockingMethods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequestMethods inherited from interface com.commercetools.api.client.Deprecatable200Trait
asDeprecatable200Trait, asDeprecatable200TraitToBaseTypeMethods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseTypeMethods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlocking
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead t)
-
-
Method Details
-
resultType
- Specified by:
resultTypein interfaceHttpRequestCommand<JsonNode>
-
executeBlocking
- Specified by:
executeBlockingin interfaceClientRequestCommand<JsonNode>- Specified by:
executeBlockingin classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead,JsonNode>
-
execute
- Specified by:
executein interfaceClientRequestCommand<JsonNode>- Specified by:
executein classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead,JsonNode>
-
getProjectKey
-
getStoreKey
-
getWhere
-
setProjectKey
-
setStoreKey
-
withWhere
set where with the specified value- Type Parameters:
TValue- value type- Parameters:
where- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
addWhere
add additional where query parameter- Type Parameters:
TValue- value type- Parameters:
where- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
withWhere
set where with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
addWhere
add additional where query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
withWhere
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead withWhere(Function<StringBuilder, StringBuilder> op) set where with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
addWhere
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead addWhere(Function<StringBuilder, StringBuilder> op) add additional where query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
withWhere
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead withWhere(Collection<TValue> where) set where with the specified values- Type Parameters:
TValue- value type- Parameters:
where- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
addWhere
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead addWhere(Collection<TValue> where) add additional where query parameters- Type Parameters:
TValue- value type- Parameters:
where- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-