Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete,ShoppingList>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
- All Implemented Interfaces:
ConflictingTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,DataerasureTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,VersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
,ClientRequestCommand<ShoppingList>
,CreateHttpRequestCommand
,HttpRequestCommand<ShoppingList>
,RequestCommand<ShoppingList>
public class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete,ShoppingList>
implements DataerasureTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>, VersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>, ConflictingTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
Deletes the ShoppingList for a given id
in a Store. Returns a 200 OK
status if successful.
A ResourceNotFound error is returned in the following scenarios:
- If no ShoppingList matches the given
id
in a Store. - If a ShoppingList matches the given
id
but does not have astore
specified, or thestore
field references a different Store. - If a ShoppingList matches the given
id
in a Store but does not contain either ananonymousId
that matches the anonymous_id:{id} scope, or acustomer
withid
value that matches the customer:{id} scope.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingList>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.me()
.shoppingLists()
.withId("{ID}")
.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
ConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete t) ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String ID) -
Method Summary
Modifier and TypeMethodDescriptionaddDataErasure
(Collection<TValue> dataErasure) add additional dataErasure query parametersadd additional dataErasure query parameteraddDataErasure
(Supplier<Boolean> supplier) add additional dataErasure query parameteraddDataErasure
(TValue dataErasure) add additional dataErasure query parameteraddExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameteraddExpand
(TValue expand) add additional expand query parameteraddVersion
(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 parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getID()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<ShoppingList>
void
void
setProjectKey
(String projectKey) void
setStoreKey
(String storeKey) toString()
withDataErasure
(Collection<TValue> dataErasure) set dataErasure with the specified valuesset dataErasure with the specified valuewithDataErasure
(Supplier<Boolean> supplier) set dataErasure with the specified valuewithDataErasure
(TValue dataErasure) set dataErasure with the specified valuewithExpand
(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand
(Supplier<String> supplier) set expand with the specified valuewithExpand
(TValue expand) set expand with the specified valuewithVersion
(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, withQueryParams
Methods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlocking
Methods inherited from interface com.commercetools.api.client.ConflictingTrait
asConflictingTrait, asConflictingTraitToBaseType
Methods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequest
Methods inherited from interface com.commercetools.api.client.DataerasureTrait
asDataerasureTrait, asDataerasureTraitToBaseType
Methods inherited from interface com.commercetools.api.client.Deprecatable200Trait
asDeprecatable200Trait, asDeprecatable200TraitToBaseType
Methods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseType
Methods inherited from interface com.commercetools.api.client.ExpandableTrait
asExpandableTrait, asExpandableTraitToBaseType
Methods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlocking
Methods inherited from interface com.commercetools.api.client.VersionedTrait
asVersionedTrait, asVersionedTraitToBaseType
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String ID) -
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete t)
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<ShoppingList>
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<ShoppingList>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete,
ShoppingList>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<ShoppingList>
- Specified by:
execute
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete,
ShoppingList>
-
getProjectKey
-
getStoreKey
-
getID
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
-
getDataErasure
- Specified by:
getDataErasure
in interfaceDataerasureTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
-
getVersion
- Specified by:
getVersion
in interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
-
setProjectKey
-
setStoreKey
-
setID
-
withExpand
set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withExpand(Supplier<String> supplier) set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addExpand(Supplier<String> supplier) add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withExpand(Function<StringBuilder, StringBuilder> op) set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addExpand(Function<StringBuilder, StringBuilder> op) add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withExpand(Collection<TValue> expand) set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addExpand(Collection<TValue> expand) add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withDataErasure
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withDataErasure(TValue dataErasure) set dataErasure with the specified value- Specified by:
withDataErasure
in interfaceDataerasureTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
dataErasure
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addDataErasure
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addDataErasure(TValue dataErasure) add additional dataErasure query parameter- Specified by:
addDataErasure
in interfaceDataerasureTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
dataErasure
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withDataErasure
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withDataErasure(Supplier<Boolean> supplier) set dataErasure with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addDataErasure
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addDataErasure(Supplier<Boolean> supplier) add additional dataErasure query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withDataErasure
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withDataErasure(Function<StringBuilder, StringBuilder> op) set dataErasure with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addDataErasure
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addDataErasure(Function<StringBuilder, StringBuilder> op) add additional dataErasure query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withDataErasure
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withDataErasure(Collection<TValue> dataErasure) set dataErasure with the specified values- Type Parameters:
TValue
- value type- Parameters:
dataErasure
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addDataErasure
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addDataErasure(Collection<TValue> dataErasure) add additional dataErasure query parameters- Type Parameters:
TValue
- value type- Parameters:
dataErasure
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withVersion
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withVersion(TValue version) set version with the specified value- Specified by:
withVersion
in interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
version
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addVersion
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addVersion(TValue version) add additional version query parameter- Specified by:
addVersion
in interfaceVersionedTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete>
- Type Parameters:
TValue
- value type- Parameters:
version
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withVersion
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withVersion(Supplier<Long> supplier) set version with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addVersion
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addVersion(Supplier<Long> supplier) add additional version query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withVersion
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withVersion(Function<StringBuilder, StringBuilder> op) set version with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addVersion
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addVersion(Function<StringBuilder, StringBuilder> op) add additional version query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
withVersion
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete withVersion(Collection<TValue> version) set version with the specified values- Type Parameters:
TValue
- value type- Parameters:
version
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
addVersion
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete addVersion(Collection<TValue> version) add additional version query parameters- Type Parameters:
TValue
- value type- Parameters:
version
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-