The resources matching the query predicate. + * Each query endpoint returns resources of its specific type.
+ * * @return null|BaseResourceCollection */ public function getResults(); /** + *Object containing supplementary information about the results.
+ * * @return null|mixed */ diff --git a/lib/commercetools-api/src/Models/Common/PagedQueryResponseBuilder.php b/lib/commercetools-api/src/Models/Common/PagedQueryResponseBuilder.php index 4d68c061316..01d8bc0baa5 100644 --- a/lib/commercetools-api/src/Models/Common/PagedQueryResponseBuilder.php +++ b/lib/commercetools-api/src/Models/Common/PagedQueryResponseBuilder.php @@ -105,6 +105,9 @@ public function getTotal() } /** + *The resources matching the query predicate. + * Each query endpoint returns resources of its specific type.
+ * * @return null|BaseResourceCollection */ @@ -114,6 +117,8 @@ public function getResults() } /** + *Object containing supplementary information about the results.
+ * * @return null|JsonObject */ diff --git a/lib/commercetools-api/src/Models/Common/PagedQueryResponseModel.php b/lib/commercetools-api/src/Models/Common/PagedQueryResponseModel.php index 4628f15cb6a..4f9f1bd7f07 100644 --- a/lib/commercetools-api/src/Models/Common/PagedQueryResponseModel.php +++ b/lib/commercetools-api/src/Models/Common/PagedQueryResponseModel.php @@ -160,6 +160,9 @@ public function getTotal() } /** + *The resources matching the query predicate. + * Each query endpoint returns resources of its specific type.
+ * * * @return null|BaseResourceCollection */ @@ -178,6 +181,8 @@ public function getResults() } /** + *Object containing supplementary information about the results.
+ * * * @return null|mixed */ diff --git a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeError.php b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeError.php index 3ff1f284cfa..4a527533463 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeError.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeError.php @@ -13,4 +13,9 @@ interface GraphQLInsufficientScopeError extends GraphQLErrorObject { + /** + + * @return null|string + */ + public function getCode(); } diff --git a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php index 2037b566432..fa8488b0595 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php @@ -37,8 +37,6 @@ public function __construct( } /** - *One of the error codes that is listed on the Errors page.
- * * * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/InsufficientScopeError.php b/lib/commercetools-api/src/Models/Error/InsufficientScopeError.php index fd1f6155839..bf0b0cf95d7 100644 --- a/lib/commercetools-api/src/Models/Error/InsufficientScopeError.php +++ b/lib/commercetools-api/src/Models/Error/InsufficientScopeError.php @@ -13,4 +13,22 @@ interface InsufficientScopeError extends ErrorObject { + /** + + * @return null|string + */ + public function getCode(); + + /** + *"Insufficient scope. One of the following scopes is missing:"
Plain text description of the cause of the error.
+ *"Insufficient scope. One of the following scopes is missing:"
Error identifier.
- * * * @return null|string */ @@ -65,7 +63,7 @@ public function getCode() } /** - *Plain text description of the cause of the error.
+ *"Insufficient scope. One of the following scopes is missing:"
The range's lower endpoint.
+ *0 represents -∞.
The range's lower endpoint.
+ *An empty string represents -∞.
+ * * @return null|string */ public function getFromStr(); /** + *The range's upper endpoint.
+ *0 represents +∞.
The range's upper endpoint.
+ *An empty string represents +∞.
+ * * @return null|string */ public function getToStr(); /** + *Number of ProductVariants for which the values in a field fall into the specified range.
+ * * @return null|int */ public function getCount(); /** + *Number of Products for which the values in a field fall into the specified range.
+ *Present only if the counting products extension is enabled.
Sum of all values contained in the range.
+ * * @return null|float */ public function getTotal(); /** + *Minimum value within the range.
+ * * @return null|float */ public function getMin(); /** + *Maximum value within the range.
+ * * @return null|float */ public function getMax(); /** + *Arithmetic mean of the values within the range.
+ * * @return null|float */ diff --git a/lib/commercetools-api/src/Models/Product/FacetRangeBuilder.php b/lib/commercetools-api/src/Models/Product/FacetRangeBuilder.php index ec9c818a00b..138c866436c 100644 --- a/lib/commercetools-api/src/Models/Product/FacetRangeBuilder.php +++ b/lib/commercetools-api/src/Models/Product/FacetRangeBuilder.php @@ -81,6 +81,9 @@ final class FacetRangeBuilder implements Builder private $mean; /** + *The range's lower endpoint.
+ *0 represents -∞.
The range's lower endpoint.
+ *An empty string represents -∞.
+ * * @return null|string */ @@ -99,6 +105,9 @@ public function getFromStr() } /** + *The range's upper endpoint.
+ *0 represents +∞.
The range's upper endpoint.
+ *An empty string represents +∞.
+ * * @return null|string */ @@ -117,6 +129,8 @@ public function getToStr() } /** + *Number of ProductVariants for which the values in a field fall into the specified range.
+ * * @return null|int */ @@ -126,6 +140,9 @@ public function getCount() } /** + *Number of Products for which the values in a field fall into the specified range.
+ *Present only if the counting products extension is enabled.
Sum of all values contained in the range.
+ * * @return null|float */ @@ -144,6 +163,8 @@ public function getTotal() } /** + *Minimum value within the range.
+ * * @return null|float */ @@ -153,6 +174,8 @@ public function getMin() } /** + *Maximum value within the range.
+ * * @return null|float */ @@ -162,6 +185,8 @@ public function getMax() } /** + *Arithmetic mean of the values within the range.
+ * * @return null|float */ diff --git a/lib/commercetools-api/src/Models/Product/FacetRangeModel.php b/lib/commercetools-api/src/Models/Product/FacetRangeModel.php index b312c795aee..0b33efc9199 100644 --- a/lib/commercetools-api/src/Models/Product/FacetRangeModel.php +++ b/lib/commercetools-api/src/Models/Product/FacetRangeModel.php @@ -108,6 +108,9 @@ public function __construct( } /** + *The range's lower endpoint.
+ *0 represents -∞.
The range's lower endpoint.
+ *An empty string represents -∞.
+ * * * @return null|string */ @@ -144,6 +150,9 @@ public function getFromStr() } /** + *The range's upper endpoint.
+ *0 represents +∞.
The range's upper endpoint.
+ *An empty string represents +∞.
+ * * * @return null|string */ @@ -180,6 +192,8 @@ public function getToStr() } /** + *Number of ProductVariants for which the values in a field fall into the specified range.
+ * * * @return null|int */ @@ -198,6 +212,9 @@ public function getCount() } /** + *Number of Products for which the values in a field fall into the specified range.
+ *Present only if the counting products extension is enabled.
Sum of all values contained in the range.
+ * * * @return null|float */ @@ -234,6 +253,8 @@ public function getTotal() } /** + *Minimum value within the range.
+ * * * @return null|float */ @@ -252,6 +273,8 @@ public function getMin() } /** + *Maximum value within the range.
+ * * * @return null|float */ @@ -270,6 +293,8 @@ public function getMax() } /** + *Arithmetic mean of the values within the range.
+ * * * @return null|float */ diff --git a/lib/commercetools-api/src/Models/Product/FacetTerm.php b/lib/commercetools-api/src/Models/Product/FacetTerm.php index d0607a71605..f1859e84dc1 100644 --- a/lib/commercetools-api/src/Models/Product/FacetTerm.php +++ b/lib/commercetools-api/src/Models/Product/FacetTerm.php @@ -18,18 +18,25 @@ interface FacetTerm extends JsonObject public const FIELD_PRODUCT_COUNT = 'productCount'; /** + *Value for the field specified in the term facet expression for which at least one ProductVariant could be found.
+ * * @return null|mixed */ public function getTerm(); /** + *Number of ProductVariants for which the term applies.
Number of Products for which the term applies.
+ * Only available if the counting products extension is enabled.
Value for the field specified in the term facet expression for which at least one ProductVariant could be found.
+ * * @return null|mixed */ @@ -48,6 +50,8 @@ public function getTerm() } /** + *Number of ProductVariants for which the term applies.
Number of Products for which the term applies.
+ * Only available if the counting products extension is enabled.
Value for the field specified in the term facet expression for which at least one ProductVariant could be found.
+ * * * @return null|mixed */ @@ -70,6 +72,8 @@ public function getTerm() } /** + *Number of ProductVariants for which the term applies.
Number of Products for which the term applies.
+ * Only available if the counting products extension is enabled.
Number of ProductVariants matching the value specified in filtered facet expression.
+ * * @return null|int */ public function getCount(); /** + *Number of Products matching the value specified in filtered facet expression.
+ *Present only if the counting products extension is enabled.
Number of ProductVariants matching the value specified in filtered facet expression.
+ * * @return null|int */ @@ -42,6 +44,9 @@ public function getCount() } /** + *Number of Products matching the value specified in filtered facet expression.
+ *Present only if the counting products extension is enabled.
Number of ProductVariants matching the value specified in filtered facet expression.
+ * * * @return null|int */ @@ -89,6 +91,9 @@ public function getCount() } /** + *Number of Products matching the value specified in filtered facet expression.
+ *Present only if the counting products extension is enabled.
Number of results requested.
+ *The maximum number of results returned on a page.
* * @return null|int @@ -29,32 +29,42 @@ interface ProductProjectionPagedSearchResponse extends JsonObject public function getLimit(); /** + *The starting point for the retrieved paginated result.
+ * * @return null|int */ - public function getCount(); + public function getOffset(); /** + *Actual number of results returned.
+ * * @return null|int */ - public function getTotal(); + public function getCount(); /** - *Number of elements skipped.
+ *Total number of results matching the query.
* * @return null|int */ - public function getOffset(); + public function getTotal(); /** + *ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter.
+ * If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.
Facet results for each facet expression specified in the search request.
+ *Only present if at least one facet parameter was provided with the search request.
Number of results requested.
+ *The maximum number of results returned on a page.
* * @return null|int @@ -68,35 +68,42 @@ public function getLimit() } /** + *The starting point for the retrieved paginated result.
+ * * @return null|int */ - public function getCount() + public function getOffset() { - return $this->count; + return $this->offset; } /** + *Actual number of results returned.
+ * * @return null|int */ - public function getTotal() + public function getCount() { - return $this->total; + return $this->count; } /** - *Number of elements skipped.
+ *Total number of results matching the query.
* * @return null|int */ - public function getOffset() + public function getTotal() { - return $this->offset; + return $this->total; } /** + *ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter.
+ * If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.
Facet results for each facet expression specified in the search request.
+ *Only present if at least one facet parameter was provided with the search request.
Number of results requested.
+ *The maximum number of results returned on a page.
* * * @return null|int @@ -96,62 +96,69 @@ public function getLimit() } /** + *The starting point for the retrieved paginated result.
+ * * * @return null|int */ - public function getCount() + public function getOffset() { - if (is_null($this->count)) { + if (is_null($this->offset)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_COUNT); + $data = $this->raw(self::FIELD_OFFSET); if (is_null($data)) { return null; } - $this->count = (int) $data; + $this->offset = (int) $data; } - return $this->count; + return $this->offset; } /** + *Actual number of results returned.
+ * * * @return null|int */ - public function getTotal() + public function getCount() { - if (is_null($this->total)) { + if (is_null($this->count)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_TOTAL); + $data = $this->raw(self::FIELD_COUNT); if (is_null($data)) { return null; } - $this->total = (int) $data; + $this->count = (int) $data; } - return $this->total; + return $this->count; } /** - *Number of elements skipped.
+ *Total number of results matching the query.
* * * @return null|int */ - public function getOffset() + public function getTotal() { - if (is_null($this->offset)) { + if (is_null($this->total)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_OFFSET); + $data = $this->raw(self::FIELD_TOTAL); if (is_null($data)) { return null; } - $this->offset = (int) $data; + $this->total = (int) $data; } - return $this->offset; + return $this->total; } /** + *ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter.
+ * If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.
Facet results for each facet expression specified in the search request.
+ *Only present if at least one facet parameter was provided with the search request.
Statistical data over values for date, time, datetime, number, and money type fields.
Statistical data over values for date, time, datetime, number, and money type fields.
Statistical data over values for date, time, datetime, number, and money type fields.
Data type to which the facet is applied.
+ * * @return null|string */ public function getDataType(); /** + *Number of ProductVariants that have no value for the specified term facet expression.
+ * * @return null|int */ public function getMissing(); /** + *Number of terms matching the term facet expression.
+ *categories.id and reviewRatingStatistics.count, the value represents the number of Products.variants.attributes.{name}, the value represents the number of Product Variants matching the expression.Number of terms not represented in this object (such as the number of terms beyond the limit).
+ * * @return null|int */ public function getOther(); /** + *Values for the field specified in term facet expression for which at least one ProductVariant could be found.
+ *By default, facet terms are returned in a descending order of their count.
If the term facet expression specifies to count Products through the counting products extension, then facet terms are returned in a descending order of their productCount.
Data type to which the facet is applied.
+ * * @return null|string */ @@ -60,6 +62,8 @@ public function getDataType() } /** + *Number of ProductVariants that have no value for the specified term facet expression.
+ * * @return null|int */ @@ -69,6 +73,12 @@ public function getMissing() } /** + *Number of terms matching the term facet expression.
+ *categories.id and reviewRatingStatistics.count, the value represents the number of Products.variants.attributes.{name}, the value represents the number of Product Variants matching the expression.Number of terms not represented in this object (such as the number of terms beyond the limit).
+ * * @return null|int */ @@ -87,6 +99,10 @@ public function getOther() } /** + *Values for the field specified in term facet expression for which at least one ProductVariant could be found.
+ *By default, facet terms are returned in a descending order of their count.
If the term facet expression specifies to count Products through the counting products extension, then facet terms are returned in a descending order of their productCount.
Data type to which the facet is applied.
+ * * * @return null|string */ @@ -113,6 +115,8 @@ public function getDataType() } /** + *Number of ProductVariants that have no value for the specified term facet expression.
+ * * * @return null|int */ @@ -131,6 +135,12 @@ public function getMissing() } /** + *Number of terms matching the term facet expression.
+ *categories.id and reviewRatingStatistics.count, the value represents the number of Products.variants.attributes.{name}, the value represents the number of Product Variants matching the expression.Number of terms not represented in this object (such as the number of terms beyond the limit).
+ * * * @return null|int */ @@ -167,6 +179,10 @@ public function getOther() } /** + *Values for the field specified in term facet expression for which at least one ProductVariant could be found.
+ *By default, facet terms are returned in a descending order of their count.
If the term facet expression specifies to count Products through the counting products extension, then facet terms are returned in a descending order of their productCount.