Package com.commercetools.api.client
Class ByProjectKeyMeOrdersHead
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyMeOrdersHead,JsonNode>
com.commercetools.api.client.ByProjectKeyMeOrdersHead
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyMeOrdersHead>,ErrorableTrait<ByProjectKeyMeOrdersHead>,ClientRequestCommand<JsonNode>,CreateHttpRequestCommand,HttpRequestCommand<JsonNode>,RequestCommand<JsonNode>
public class ByProjectKeyMeOrdersHead
extends TypeApiMethod<ByProjectKeyMeOrdersHead,JsonNode>
implements ErrorableTrait<ByProjectKeyMeOrdersHead>, Deprecatable200Trait<ByProjectKeyMeOrdersHead>
Checks if one or more Orders exist for the provided query predicate for the authenticated Customer or anonymous user. Returns a 200 status if successful.
A Not Found error is returned in the following scenarios:
- If no Orders exist that match the provided query predicate.
- If one or more Orders exist but don't have either a
customerIdthat matches the customer:{id} scope, or ananonymousIdthat matches the anonymous_id:{id} scope.
CompletableFuture<ApiHttpResponse<com.fasterxml.jackson.databind.JsonNode>> result = apiRoot
.withProjectKey("{projectKey}")
.me()
.orders()
.head()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyMeOrdersHeadaddWhere(Collection<TValue> where) add additional where query parametersadd additional where query parameteradd additional where query parameter<TValue> ByProjectKeyMeOrdersHeadaddWhere(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) toString()<TValue> ByProjectKeyMeOrdersHeadwithWhere(Collection<TValue> where) set where with the specified valuesset where with the specified valueset where with the specified value<TValue> ByProjectKeyMeOrdersHeadwithWhere(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
-
ByProjectKeyMeOrdersHead
-
ByProjectKeyMeOrdersHead
-
-
Method Details
-
resultType
- Specified by:
resultTypein interfaceHttpRequestCommand<JsonNode>
-
executeBlocking
- Specified by:
executeBlockingin interfaceClientRequestCommand<JsonNode>- Specified by:
executeBlockingin classApiMethod<ByProjectKeyMeOrdersHead,JsonNode>
-
execute
- Specified by:
executein interfaceClientRequestCommand<JsonNode>- Specified by:
executein classApiMethod<ByProjectKeyMeOrdersHead,JsonNode>
-
getProjectKey
-
getWhere
-
setProjectKey
-
withWhere
set where with the specified value- Type Parameters:
TValue- value type- Parameters:
where- value to be set- Returns:
- ByProjectKeyMeOrdersHead
-
addWhere
add additional where query parameter- Type Parameters:
TValue- value type- Parameters:
where- value to be added- Returns:
- ByProjectKeyMeOrdersHead
-
withWhere
set where with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyMeOrdersHead
-
addWhere
add additional where query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyMeOrdersHead
-
withWhere
set where with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyMeOrdersHead
-
addWhere
add additional where query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyMeOrdersHead
-
withWhere
set where with the specified values- Type Parameters:
TValue- value type- Parameters:
where- values to be set- Returns:
- ByProjectKeyMeOrdersHead
-
addWhere
add additional where query parameters- Type Parameters:
TValue- value type- Parameters:
where- values to be added- Returns:
- ByProjectKeyMeOrdersHead
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-