Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyMeDelete
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeDelete,Customer>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeDelete
- All Implemented Interfaces:
ConflictingTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>,VersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>,ClientRequestCommand<Customer>,CreateHttpRequestCommand,HttpRequestCommand<Customer>,RequestCommand<Customer>
public class ByProjectKeyInStoreKeyByStoreKeyMeDelete
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeDelete,Customer>
implements VersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>, ConflictingTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>
Deletes the Customer in a Store. Returns a 200 status if successful.
A ResourceNotFound error is returned in the following scenarios:
- If no Customer exists with the
idspecified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}scope.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.customer.Customer>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.me()
.delete()
.withVersion(version)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,V> -
Constructor Summary
ConstructorsConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyMeDelete(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
Method Summary
Modifier and TypeMethodDescriptionaddVersion(Collection<TValue> version) add additional version query parametersadd additional version query parameteraddVersion(Supplier<Long> supplier) add additional version query parameteraddVersion(TValue version) add additional version query parameterbooleanexecute(ApiHttpClient client) executeBlocking(ApiHttpClient client, Duration timeout) inthashCode()intcom.fasterxml.jackson.core.type.TypeReference<Customer>voidsetProjectKey(String projectKey) voidsetStoreKey(String storeKey) toString()withVersion(Collection<TValue> version) set version with the specified valuesset version with the specified valuewithVersion(Supplier<Long> supplier) set version with the specified valuewithVersion(TValue version) set version 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 com.commercetools.api.client.ConflictingTrait
asConflictingTrait, asConflictingTraitToBaseTypeMethods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequestMethods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlockingMethods inherited from interface com.commercetools.api.client.VersionedTrait
asVersionedTrait, asVersionedTraitToBaseType
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyMeDelete
public ByProjectKeyInStoreKeyByStoreKeyMeDelete(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
-
Method Details
-
resultType
- Specified by:
resultTypein interfaceHttpRequestCommand<Customer>
-
executeBlocking
- Specified by:
executeBlockingin interfaceClientRequestCommand<Customer>- Specified by:
executeBlockingin classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeDelete,Customer>
-
execute
- Specified by:
executein interfaceClientRequestCommand<Customer>- Specified by:
executein classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeDelete,Customer>
-
getProjectKey
-
getStoreKey
-
getVersion
- Specified by:
getVersionin interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>
-
setProjectKey
-
setStoreKey
-
withVersion
set version with the specified value- Specified by:
withVersionin interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>- Type Parameters:
TValue- value type- Parameters:
version- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
addVersion
add additional version query parameter- Specified by:
addVersionin interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeDelete>- Type Parameters:
TValue- value type- Parameters:
version- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
withVersion
set version with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
addVersion
add additional version query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
withVersion
public ByProjectKeyInStoreKeyByStoreKeyMeDelete withVersion(Function<StringBuilder, StringBuilder> op) set version with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
addVersion
public ByProjectKeyInStoreKeyByStoreKeyMeDelete addVersion(Function<StringBuilder, StringBuilder> op) add additional version query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
withVersion
set version with the specified values- Type Parameters:
TValue- value type- Parameters:
version- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
addVersion
add additional version query parameters- Type Parameters:
TValue- value type- Parameters:
version- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeDelete
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-