• Home
• io.sphere.sdk.jvm
• sphere-jvm-sdk
• 1.0.0-M26
• source code
• ReleaseNotes.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.sphere.sdk.meta.ReleaseNotes Maven / Gradle / Ivy

package io.sphere.sdk.meta;

import io.sphere.sdk.carts.CartLike;
import io.sphere.sdk.carts.CustomLineItem;
import io.sphere.sdk.carts.LineItem;
import io.sphere.sdk.carts.commands.updateactions.SetShippingMethod;
import io.sphere.sdk.carts.expansion.CartExpansionModel;
import io.sphere.sdk.carts.queries.CartByIdGet;
import io.sphere.sdk.categories.Category;
import io.sphere.sdk.channels.queries.ChannelByIdGet;
import io.sphere.sdk.client.SphereApiConfig;
import io.sphere.sdk.client.SphereClient;
import io.sphere.sdk.client.SphereRequest;
import io.sphere.sdk.commands.UpdateActionImpl;
import io.sphere.sdk.commands.UpdateCommand;
import io.sphere.sdk.customobjects.CustomObject;
import io.sphere.sdk.customobjects.commands.CustomObjectDeleteCommand;
import io.sphere.sdk.customobjects.queries.CustomObjectByKeyGet;
import io.sphere.sdk.customobjects.queries.CustomObjectQuery;
import io.sphere.sdk.expansion.ExpansionPath;
import io.sphere.sdk.http.*;
import io.sphere.sdk.models.*;
import io.sphere.sdk.orders.Order;
import io.sphere.sdk.orders.expansion.OrderExpansionModel;
import io.sphere.sdk.payments.Transaction;
import io.sphere.sdk.productdiscounts.queries.ProductDiscountByIdGet;
import io.sphere.sdk.products.*;
import io.sphere.sdk.products.attributes.Attribute;
import io.sphere.sdk.products.attributes.AttributeAccess;
import io.sphere.sdk.products.attributes.AttributeDefinition;
import io.sphere.sdk.products.attributes.LocalizedToStringProductAttributeConverter;
import io.sphere.sdk.products.commands.updateactions.SetMetaDescription;
import io.sphere.sdk.products.commands.updateactions.SetMetaKeywords;
import io.sphere.sdk.products.commands.updateactions.SetMetaTitle;
import io.sphere.sdk.products.expansion.ProductProjectionExpansionModel;
import io.sphere.sdk.products.queries.ProductByIdGet;
import io.sphere.sdk.products.queries.ProductProjectionByIdGet;
import io.sphere.sdk.products.queries.ProductProjectionQuery;
import io.sphere.sdk.products.queries.ProductProjectionQueryModel;
import io.sphere.sdk.producttypes.ProductType;
import io.sphere.sdk.projects.Project;
import io.sphere.sdk.queries.Get;
import io.sphere.sdk.queries.QueryDsl;
import io.sphere.sdk.queries.QueryPredicate;
import io.sphere.sdk.search.SearchKeywords;
import io.sphere.sdk.taxcategories.TaxRate;
import io.sphere.sdk.types.CustomFields;
import io.sphere.sdk.types.CustomFieldsDraft;
import io.sphere.sdk.types.FieldType;

import javax.money.CurrencyUnit;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.TimeUnit;
import java.util.function.BiFunction;
import java.util.function.Function;

/**
 

 
Legend
 

 
removed functionality
 
added functionality
 
breaking change
 
bugfix, can include a breaking change
 

 

 
1.0.0-M26 (20.01.2016)
 Expand all

 

 

 

 
Added {@link io.sphere.sdk.reviews.Review}s.

 
Builders for query and search requests. So for example
 {@link io.sphere.sdk.products.queries.ProductProjectionQueryBuilder}
 to build {@link io.sphere.sdk.products.queries.ProductProjectionQuery} and
 {@link io.sphere.sdk.products.search.ProductProjectionSearchBuilder}
 to build {@link io.sphere.sdk.products.search.ProductProjectionSearch}.


 

 
The new way with builders (code with side effects)
 {@include.example io.sphere.sdk.meta.M26Demo#createSearchQueryWithBuilder}
 
The classic way (immutable objects, reassigning)
 {@include.example io.sphere.sdk.meta.M26Demo#createSearchQueryClassicWay()}
 

 

 
Added customer update actions
 {@link io.sphere.sdk.customers.commands.updateactions.SetTitle},
 {@link io.sphere.sdk.customers.commands.updateactions.SetFirstName},
 {@link io.sphere.sdk.customers.commands.updateactions.SetMiddleName} and
 {@link io.sphere.sdk.customers.commands.updateactions.SetLastName}.
 
{@link CustomObjectQuery} supports now predicates containing key.
 

 {@include.example io.sphere.sdk.meta.M26Demo#queryCustomObjectsByKeyExample()}
 
 
 
Added {@link Project#getCurrencies()} and {@link Project#getCurrencyUnits()} so you can get your enabled currencies for the commercetools project.

 
Added some short hand methods for the work with product attributes like {@link Attribute#getValueAsLong()} and {@link Attribute#getValueAsString()}. For all see {@link Attribute}.
 
Added {@link LocalizedToStringProductAttributeConverter} which provides some defaults to present product attribute (including monetary amounts and date) values as String. The behaviour can be changed through subclasses.
 


 
1.0.0-M25 (08.01.2016)
 

 
Support full locales for search endpoint. See #922
 

 
1.0.0-M24 (05.01.2016)

 

 
Commercetools responses are gzipped which should result in less traffic and faster responses. {@link HttpResponse#getResponseBody()} returns the unpacked body.
 
Added {@link io.sphere.sdk.client.BlockingSphereClient} which does not execute asynchronous: {@include.example io.sphere.sdk.meta.BlockingClientValueGetDemo}
 
Added {@link ProductProjectionExpansionModel#allVariants()} for expanding objects in masterVariant and the other variants with one code expression. {@include.example io.sphere.sdk.products.expansion.ProductProjectionExpansionModelTest#allVariants()}
 
{@link io.sphere.sdk.meta.GraphQLDocumentation GraphQL Example}
 
InputHint for types is optional, so added {@link io.sphere.sdk.types.FieldDefinition#of(FieldType, String, LocalizedString, Boolean)}.
 
Ease initialising clients which need a bearer token instead of the client secret:
 {@link io.sphere.sdk.client.SphereClientFactory#createClientOfApiConfigAndAccessToken(SphereApiConfig, String)} and
 {@link io.sphere.sdk.client.SphereClientFactory#createClientOfApiConfigAndAccessToken(SphereApiConfig, String, HttpClient)}
 
 
{@link ProductDraftBuilder#plusVariants(List)} and {@link ProductDraftBuilder#plusVariants(ProductVariantDraft)}
 
Improve error reporting for failed attempts fetching OAuth tokens.
 
Added missing transaction query fields.
 
{@link io.sphere.sdk.client.SphereClientUtils#blockingWait(CompletionStage, long, TimeUnit)} for waiting for sphere requests
 
{@link CartLike#getCurrency()} which gets the currency for a cart or an order
 
Added category order hints to search model.
 
Added {@link io.sphere.sdk.types.ResourceTypeIdsSetBuilder} which helps to find the resource type ids for creation {@link io.sphere.sdk.types.Type}s.
 
{@link ResourceIdentifier}, for example for creating products with the product type key: {@link ProductDraftBuilder#of(ResourceIdentifiable, LocalizedString, LocalizedString, ProductVariantDraft)} 
 
Added {@link ProductVariant#isMatchingVariant()}.
 
Several documentation improvements.
 
Renamed methods like "ofLocalizable*" to "ofLocalized*". (the old methods are deprecated)
 
Renamed duplicated classes like "*Type" to "*AttributeType" and "*FieldType". (direct change, no deprecation possible)
 
Use {@link io.sphere.sdk.client.TestDoubleSphereClientFactory#createHttpTestDouble(Function)}
 and {@link io.sphere.sdk.client.TestDoubleSphereClientFactory#createObjectTestDouble(Function)} instead of methods from {@link io.sphere.sdk.client.SphereClientFactory} for test doubles.
 
In the properties config the default auth url is wrong. See 889.
 
The review classes are removed.
 

 
1.0.0-M23 (09.12.2015)

 

 
Create a cart including shipping and billing address as well as with items. See {@link io.sphere.sdk.carts.CartDraftBuilder}
 
Improved Order Query, query by (custom) line items, billing and shipping address, discount codes and custom fields.
 
Query {@link io.sphere.sdk.types.Type}s by resourceTypeIds and fieldDefinitions.
 
Query {@link Order} by empty or not empty syncInfo.
 
Added {@link QueryDsl#plusSort(List)}.
 
Added query predicates for createdAt and lastModifiedAt.
 
Added isIn() query for enum constants like {@link io.sphere.sdk.states.StateType}.
 
Added {@link ProductProjectionQuery#bySku(List)}.
 
Added {@link io.sphere.sdk.taxcategories.queries.TaxCategoryByIdGet}.
 
{@link io.sphere.sdk.client.SphereClientFactory} also auto discovers the Apache HTTP client SDK module if this is in the classpath and not the Async HTTP Client module.
 
Added {@link CustomFields#getFieldsJsonMap()}.
 
Primitive scalar values are now as wrapper classes defined (int to Long, long to Long)
 
{@link io.sphere.sdk.cartdiscounts.DiscountedLineItemPriceForQuantity} and {@link io.sphere.sdk.carts.commands.updateactions.RemoveLineItem} uses long for quantity. 
 
{@link Versioned#getVersion()} is of type {@link Long} instead of long.
 
Http core: {@link io.sphere.sdk.http.FormUrlEncodedHttpRequestBody} did not respect the order of elements and possible duplicates.
 Use  {@link io.sphere.sdk.http.FormUrlEncodedHttpRequestBody#of(List)} for construction and {@link FormUrlEncodedHttpRequestBody#getParameters()} for getting the data.
 {@link FormUrlEncodedHttpRequestBody#getData()} is deprecated.
 
Added {@link io.sphere.sdk.client.SphereClientConfig#ofProperties(Properties, String)} to get the commercetools credentials form a properties file.
 
For SDK contributors: integration test credentials can be set via a properties file
 

 
1.0.0-M22 (01.12.2015)
 

 
{@link AttributeDefinition#getIsRequired()} and {@link AttributeDefinition#getIsSearchable()} ()} have been
 deprecated in favor of {@link AttributeDefinition#isRequired()} and {@link AttributeDefinition#isSearchable}.
 
 
Added new Payment actions:
 {@link io.sphere.sdk.payments.commands.updateactions.ChangeTransactionTimestamp},
 {@link io.sphere.sdk.payments.commands.updateactions.ChangeTransactionInteractionId} and
 {@link io.sphere.sdk.payments.commands.updateactions.ChangeTransactionState}
 
 
Added {@link Transaction#getId()} and {@link Transaction#getState()}
 
{@link Transaction} has been split to {@link io.sphere.sdk.payments.TransactionDraft} as input object
 and {@link Transaction} as output object of the API.
 
Fixed method typo {@link ProductProjection#findVariantBySky(String)}, use {@link ProductProjection#findVariantBySku(String)}
 

 
1.0.0-M21 (25.11.2015)
 

 
Introduced the possibility to perform faceted search on products, for more information see the {@link io.sphere.sdk.meta.SearchDocumentation search documentation}, section Faceted Search.
 
Added getters {@link io.sphere.sdk.search.SearchExpression#value()} and {@link io.sphere.sdk.search.FacetExpression#alias()} for the Search API.
 
Added helper method {@link io.sphere.sdk.search.model.RangeTermFacetSearchModel#allRanges()} to request a range facet for all values.
 
Validates the provided parameters in filter and facet expressions in order to avoid generating wrong requests.
 
Deprecated {@code io.sphere.sdk.search.model.RangeFacetBaseSearchModel#onlyRangeAsString(java.lang.String, java.lang.String)} in favour of a more generic {@code io.sphere.sdk.search.model.RangeFacetBaseSearchModel#onlyRangeAsString(FacetRange)}.
 
Added static constructors to all facet/filter/sort search model classes, to easily build customized search expressions.
 
Since {@link io.sphere.sdk.search.model.SortSearchModel} implementation classes have now static factory constructors, these class constructors have been removed from the public API.
 
Renamed {@code Range} filter/facet search models to {@code RangeTerm} to emphasize that you can build both range and term oriented search expressions with them.
 
ExpansionPath for shippingInfo fields: {@link CartExpansionModel#shippingInfo()} and {@link OrderExpansionModel#shippingInfo()}
 
{@link ProductType#getKey()}
 
{@link io.sphere.sdk.producttypes.ProductTypeDraft#of(String, String, List)} has been deprecated in favor of {@link io.sphere.sdk.producttypes.ProductTypeDraft#of(String, String, String, List)} since it is a very good practice to create a {@link ProductType} with a key.
 
{@link SetShippingMethod#ofRemove()} to be able to remove a {@link io.sphere.sdk.shippingmethods.ShippingMethod} from a {@link io.sphere.sdk.carts.Cart}
 
{@link io.sphere.sdk.orders.commands.OrderFromCartCreateCommand} contains an example
 
Support for currencies like Yen.
 
create {@link javax.money.MonetaryAmount} with centAmount: {@link io.sphere.sdk.utils.MoneyImpl#ofCents(long, CurrencyUnit)}
 
Add {@code state} field to QueryModel for Products, Reviews and Orders.
 
Custom fields for prices: {@link Price#getCustom()}
 
For custom fields in prices the HTTP API and hence the SDK differentiate now between {@link Price} and {@link io.sphere.sdk.products.PriceDraft}.
 
Places where {@link io.sphere.sdk.products.PriceDraft} has to be used:
 

   
{@link io.sphere.sdk.products.commands.updateactions.AddPrice}
   
{@link io.sphere.sdk.products.commands.updateactions.ChangePrice}
   
{@link io.sphere.sdk.products.ProductVariantDraftBuilder#price(PriceDraft)}
   
{@link io.sphere.sdk.products.ProductVariantDraftBuilder#prices(List)}
   
{@link io.sphere.sdk.products.commands.updateactions.AddVariant}
 
 
To roughly compare a {@link Price} with a {@link io.sphere.sdk.products.PriceDraft}, use {@link PriceDraft#of(Price)} to create a draft out of the price and then compare the drafts.
 
 


 
1.0.0-M20 (02.11.2015)
 

  
{@code query.withSort(m -> m.createdAt().sort(DESC));} is deprecated, use it with {@code query.withSort(m -> m.createdAt().sort().desc());}
  
Duplicates with {@link io.sphere.sdk.queries.ExperimentalReactiveStreamUtils#publisherOf(QueryDsl, SphereClient)} on multiple parallel request(n) calls. See 809.
  
Logger name shows query string. See 802.
  
Missing Content-Length header in Async HTTP Client. See 799.
  
variantIdentifier in {@link LineItem} is null. See 771.
 


 
1.0.0-M19 (16.10.2015)

 Expand all
 

 

 

 
The Search API now allows multi-sort by accepting a list of {@link io.sphere.sdk.search.SortExpression} instead of a single value.
 
Introduced explicit Set product custom attribute models to build search expressions (i.e. facets, filters and sort expressions).
 
Introduced methods {@link io.sphere.sdk.search.PagedSearchResult#getTermFacetResult}, {@link io.sphere.sdk.search.PagedSearchResult#getRangeFacetResult} and {@link io.sphere.sdk.search.PagedSearchResult#getFilteredFacetResult} that accept the facet path.
 
Introduced search filter methods {@link io.sphere.sdk.search.model.TermFilterSearchModel#byAny} and {@link io.sphere.sdk.search.model.TermFilterSearchModel#byAll} (OR and AND semantics, respectively), along with the counterpart for range filters{@link io.sphere.sdk.search.model.RangeTermFilterSearchModel#byAnyRange} and {@link io.sphere.sdk.search.model.RangeTermFilterSearchModel#byAllRanges}), change that affected the signature of all filter methods which now return a list of {@link io.sphere.sdk.search.FilterExpression} instead of a single value.
 
The Search Sort Model offers now the methods {@link io.sphere.sdk.search.model.SortSearchModel#byAsc} and {@link io.sphere.sdk.search.model.SortSearchModel#byDesc}, as well as {@link io.sphere.sdk.search.model.MultiValueSortSearchModel#byAscWithMax} and {@link io.sphere.sdk.search.model.MultiValueSortSearchModel#byDescWithMin} for multi-valued attributes.
 
Removed {@code io.sphere.sdk.search.UntypedSearchModel} class and instead provide methods to give filter and facet parameters as simple strings.
 

 {@include.example io.sphere.sdk.products.search.ProductProjectionSearchFiltersIntegrationTest#filterByValueAsString}
 
 
 
While before the Search Model was built using the structure {@code attribute + action + parameters}, now it changed to {@code action + attribute + parameters}, in order to split the model into 3 independent models: Search Filter Model, Search Facet Model and Search Sort Model.
 

 Before it looked like:
 
{@code
 ProductProjectionSearch search = ProductProjectionSearch.ofStaged()
 .plusQueryFilters(product -> product.name().locale(ENGLISH).filtered().by("shoes"));
 PagedSearchResult result = client.execute(search);
 }

 Now it is built as follows:
 
{@code
 ProductProjectionSearch search = ProductProjectionSearch.ofStaged()
 .plusQueryFilters(filter -> filter.name().locale(ENGLISH).by("shoes"));
 PagedSearchResult result = client.execute(search);
 }
 
 
 
Renamed {@code SearchSort} to {@link io.sphere.sdk.search.SortExpression}, which now shares the same properties as {@link io.sphere.sdk.search.FacetExpression} and {@link io.sphere.sdk.search.FilterExpression} under the {@link io.sphere.sdk.search.SearchExpression} interface.
 
The static factory method to directly build unsafe {@link io.sphere.sdk.search.FacetExpression} is now located in {@link io.sphere.sdk.search.TermFacetExpression}, {@link io.sphere.sdk.search.RangeFacetExpression} and {@link io.sphere.sdk.search.FilteredFacetExpression}, so that a facet expression for the corresponding type is obtained.
 
Moved related Search Model classes from {@code io.sphere.sdk.search} to {@code io.sphere.sdk.search.model} package, to clearly separate the Search Model from the Search API classes.
 
Removed type parameters from {@link io.sphere.sdk.search.TermFacetResult}, {@link io.sphere.sdk.search.RangeFacetResult} and {@link io.sphere.sdk.search.FilteredFacetResult}, which now return simple strings as they are received from the platform.
 
Added {@link ProductProjection#getCategoryOrderHints()} and {@link ProductProjectionQueryModel#categoryOrderHints()}. It can be used for search as shown in the following example, but the meta model comes in a later release.
  
{@include.example io.sphere.sdk.products.ProductCategoryOrderHintTest#searchForCategoryAndSort()}
 
 
Added states and update actions for Orders, Reviews and Products: {@link Order#getState()}, {@link io.sphere.sdk.products.Product#getState()}, {@code io.sphere.sdk.reviews.Review#getState()}
 
Added {@link LineItem#getTotalPrice()}, {@link LineItem#getDiscountedPricePerQuantity()}, {@link CustomLineItem#getTotalPrice()} and {@link CustomLineItem#getDiscountedPricePerQuantity()}
 
Deprecated {@link LineItem#getDiscountedPrice()} and {@link CustomLineItem#getDiscountedPrice()} since they are deprecated in the HTTP API
 
Improved documentation of {@link io.sphere.sdk.models.Versioned}.
 
Added {@link io.sphere.sdk.payments.Payment}.
 
Deprecated typo method {@link io.sphere.sdk.carts.CartDraft#witCustom(CustomFieldsDraft)}, use {@link io.sphere.sdk.carts.CartDraft#withCustom(CustomFieldsDraft)} instead.
 
Deprecated {@link io.sphere.sdk.customers.queries.CustomerByTokenGet}, use {@link io.sphere.sdk.customers.queries.CustomerByPasswordTokenGet} instead.
 
Added {@link io.sphere.sdk.customobjects.queries.CustomObjectByIdGet} and {@link CustomObjectDeleteCommand#of(String, Long, Class)} which can delete a {@link CustomObject} by ID.
 
Simplified CustomObject endpoints. Instead of a {@link com.fasterxml.jackson.core.type.TypeReference} for the endpoint result only the class of the value of the custom object needs to be provided.
 

 
Before:
 
{@code final CustomObjectQuery query = CustomObjectQuery.of(new TypeReference>>(){});}
 
After:
 
{@code final CustomObjectQuery query = CustomObjectQuery.of(Pojo.class);}

 
This change applies for other endpoints, too.
 
 
 

 Deprecations in custom object endpoints:
 

 
{@link CustomObjectDeleteCommand#of(io.sphere.sdk.customobjects.CustomObject)}
 
use instead {@link CustomObjectDeleteCommand#ofJsonNode(CustomObject)}

 
{@link CustomObjectDeleteCommand#of(java.lang.String, java.lang.String)}
 
use instead  {@link CustomObjectDeleteCommand#ofJsonNode(java.lang.String, java.lang.String)}
 
{@link CustomObjectByKeyGet#of(java.lang.String, java.lang.String)}
 
use instead {@link CustomObjectByKeyGet#ofJsonNode(java.lang.String, java.lang.String)}
 
{@link CustomObjectQuery#of()}
 
use instead {@link CustomObjectQuery#ofJsonNode()}

 
 
 
Don't include customer password in logs. See 767.
 



 
1.0.0-M18 (01.10.2015)

 

 
{@link io.sphere.sdk.products.search.ProductProjectionSearch#withFuzzy(Boolean)}
 
documentation of the customer flow in {@link io.sphere.sdk.customers.Customer}
 
{@link io.sphere.sdk.types.Custom custom fields}
 
Improved error reporting for status code 413 and 414.

 
{@link io.sphere.sdk.search.TermStats} contains not anymore "T" and "F" but "true" and "false".
 
deprecate {@link io.sphere.sdk.customers.commands.CustomerCreateTokenCommand}, use {@link io.sphere.sdk.customers.commands.CustomerCreatePasswordTokenCommand} instead
 
DiscountedLineItemPrice money field is called value not money. See 711.
 


 
1.0.0-M17 (28.08.2015)

 

 
Support of full locales like "de_DE"
 
{@link io.sphere.sdk.products.ProductProjection} is also a {@link io.sphere.sdk.models.Versioned} for {@link io.sphere.sdk.products.Product}
 
{@link AttributeAccess#ofInteger()}, {@link AttributeAccess#ofIntegerSet()}, {@link AttributeAccess#ofLong()}, {@link AttributeAccess#ofLongSet()}
 
{@link io.sphere.sdk.taxcategories.commands.TaxCategoryUpdateCommand}
 
{@link io.sphere.sdk.products.ProductDraftBuilder#taxCategory(Referenceable)}, {@link io.sphere.sdk.products.ProductDraftBuilder#searchKeywords(SearchKeywords)}
 
{@code Reference} and {@code Reference