Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/changes_api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
'@commercetools/platform-sdk': minor
---

**Api changes**

<details>
<summary>Changed Property(s)</summary>

- :warning: changed property `actions` of type `MyBusinessUnitUpdate` from type `BusinessUnitUpdateAction[]` to `MyBusinessUnitUpdateAction[]`
</details>
31 changes: 2 additions & 29 deletions changes.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,7 @@
**Api changes**

<details>
<summary>Changed Type(s)</summary>
<summary>Changed Property(s)</summary>

- :warning: changed type `DeliveryPayload` from type `object` to `SubscriptionNotification`
- :warning: changed type `EventDeliveryPayload` from type `DeliveryPayload` to `SubscriptionNotification`
</details>

<details>
<summary>Added Type(s)</summary>

- added type `BusinessUnitSetUnitTypeAction`
- added type `BaseEvent`
- added type `BusinessUnitTopLevelUnitSetMessage`
- added type `BusinessUnitTypeSetMessage`
- added type `BusinessUnitTopLevelUnitSetMessagePayload`
- added type `BusinessUnitTypeSetMessagePayload`
- added type `SubscriptionNotification`
</details>

<details>
<summary>Removed Property(s)</summary>

- :warning: removed property `data` from type `Event`
</details>

<details>
<summary>Added Property(s)</summary>

- added property `projectKey` to type `DeliveryPayload`
- added property `resource` to type `DeliveryPayload`
- added property `resourceUserProvidedIdentifiers` to type `DeliveryPayload`
- :warning: changed property `actions` of type `MyBusinessUnitUpdate` from type `BusinessUnitUpdateAction[]` to `MyBusinessUnitUpdateAction[]`
</details>
4 changes: 2 additions & 2 deletions packages/platform-sdk/src/generated/models/error.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2041,7 +2041,7 @@ export interface StoreCartDiscountsLimitReachedError extends IErrorObject {
readonly stores: StoreKeyReference[]
}
/**
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/product-projection-search) does not have the correct syntax.
*
*/
export interface SyntaxErrorError extends IErrorObject {
Expand Down Expand Up @@ -3565,7 +3565,7 @@ export interface GraphQLStoreCartDiscountsLimitReachedError
readonly stores: StoreKeyReference[]
}
/**
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/product-projection-search) does not have the correct syntax.
*
*/
export interface GraphQLSyntaxErrorError extends IGraphQLErrorObject {
Expand Down
3 changes: 1 addition & 2 deletions packages/platform-sdk/src/generated/models/me.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
AssociateRoleAssignmentDraft,
BusinessUnitResourceIdentifier,
BusinessUnitType,
BusinessUnitUpdateAction,
} from './business-unit'
import {
CartReference,
Expand Down Expand Up @@ -148,7 +147,7 @@ export interface MyBusinessUnitUpdate {
*
*
*/
readonly actions: BusinessUnitUpdateAction[]
readonly actions: MyBusinessUnitUpdateAction[]
}
export type MyBusinessUnitUpdateAction =
| MyBusinessUnitAddAddressAction
Expand Down
4 changes: 2 additions & 2 deletions packages/platform-sdk/src/generated/models/product-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export interface AttributeDefinition {
*/
readonly inputHint: TextInputHint
/**
* If `true`, the Attribute's values are available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/products-search) API for use in full-text search queries, filters, and facets.
* If `true`, the Attribute's values are available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/product-projection-search) API for use in full-text search queries, filters, and facets.
*
* Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
* The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
Expand Down Expand Up @@ -140,7 +140,7 @@ export interface AttributeDefinitionDraft {
*/
readonly inputHint?: TextInputHint
/**
* Set to `true` if the Attribute's values should be available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/products-search) API and can be used in full-text search queries, filters, and facets.
* Set to `true` if the Attribute's values should be available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/product-projection-search) API and can be used in full-text search queries, filters, and facets.
* Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
* The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
* This constraint is enforced at both Product creation and Product update.
Expand Down
40 changes: 20 additions & 20 deletions packages/platform-sdk/src/generated/models/product.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export interface FacetRange {
/**
* Number of [Products](ctp:api:type:Product) for which the values in a field fall into the specified range.
*
* Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
* Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.
*
*
*/
Expand Down Expand Up @@ -153,7 +153,7 @@ export interface FacetResults {
}
export interface FacetTerm {
/**
* Value for the field specified in the [term facet expression](/../api/projects/products-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type:ProductVariant) could be found.
* Value for the field specified in the [term facet expression](/../api/projects/product-projection-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type:ProductVariant) could be found.
*
*
*/
Expand All @@ -166,7 +166,7 @@ export interface FacetTerm {
readonly count: number
/**
* Number of [Products](ctp:api:type:Product) for which the `term` applies.
* Only available if the `counting products` [extension](/../api/projects/products-search#counting-products) is enabled.
* Only available if the `counting products` [extension](/../api/projects/product-projection-search#counting-products) is enabled.
*
*
*/
Expand All @@ -182,15 +182,15 @@ export type FacetTypes = 'filter' | 'range' | 'terms' | (string & {})
export interface FilteredFacetResult extends IFacetResult {
readonly type: 'filter'
/**
* Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
* Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
*
*
*/
readonly count: number
/**
* Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
* Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
*
* Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
* Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.
*
*
*/
Expand Down Expand Up @@ -389,7 +389,7 @@ export interface ProductData {
*/
readonly variants: ProductVariant[]
/**
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
*
*
*/
Expand Down Expand Up @@ -481,7 +481,7 @@ export interface ProductDraft {
*/
readonly taxCategory?: TaxCategoryResourceIdentifier
/**
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
*
*
*/
Expand Down Expand Up @@ -736,19 +736,19 @@ export interface ProductProjectionPagedQueryResponse {
readonly results: ProductProjection[]
}
/**
* The response returned to a [Product Projection Search](/../api/projects/products-search#product-projection-search) request.
* The object contains the [query results](/../api/projects/products-search#query-results) with Product Projections where at least one ProductVariant matches the search query, as well as the [facet results](/../api/projects/products-search#facet-results), if requested.
* The response returned to a [Product Projection Search](/../api/projects/product-projection-search#product-projection-search) request.
* The object contains the [query results](/../api/projects/product-projection-search#query-results) with Product Projections where at least one ProductVariant matches the search query, as well as the [facet results](/../api/projects/product-projection-search#facet-results), if requested.
*
*/
export interface ProductProjectionPagedSearchResponse {
/**
* The maximum number of results returned on a [page](/../api/projects/products-search#pagination).
* The maximum number of results returned on a [page](/../api/projects/product-projection-search#pagination).
*
*
*/
readonly limit: number
/**
* The starting point for the retrieved [paginated](/../api/projects/products-search#pagination) result.
* The starting point for the retrieved [paginated](/../api/projects/product-projection-search#pagination) result.
*
*
*/
Expand All @@ -767,13 +767,13 @@ export interface ProductProjectionPagedSearchResponse {
readonly total?: number
/**
* [ProductProjections](ctp:api:type:ProductProjection) where at least one [ProductVariant](ctp:api:type: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](/../api/projects/products-search#matching-variants) are marked as such.
* If the query parameter `markMatchingVariants=true` was provided with the request, the [matching variants](/../api/projects/product-projection-search#matching-variants) are marked as such.
*
*
*/
readonly results: ProductProjection[]
/**
* Facet results for each [facet expression](/../api/projects/products-search#facets) specified in the search request.
* Facet results for each [facet expression](/../api/projects/product-projection-search#facets) specified in the search request.
*
* Only present if at least one `facet` parameter was provided with the search request.
*
Expand Down Expand Up @@ -1125,7 +1125,7 @@ export interface SearchKeyword {
readonly suggestTokenizer?: SuggestTokenizer
}
/**
* Search keywords are JSON objects primarily used by [Product Suggestions](/projects/products-suggestions), but are also considered for a [full text search](/projects/products-search#full-text-search).
* Search keywords are JSON objects primarily used by [Product Suggestions](/projects/products-suggestions), but are also considered for a [full text search](/projects/product-projection-search#full-text-search).
* The keys are of type [Locale](ctp:api:type:Locale), and the values are an array of [SearchKeyword](ctp:api:type:SearchKeyword).
*
*/
Expand Down Expand Up @@ -1171,13 +1171,13 @@ export interface TermFacetResult extends IFacetResult {
*/
readonly dataType: TermFacetResultType
/**
* Number of [ProductVariants](ctp:api:type:ProductVariant) that have no value for the specified [term facet expression](/../api/projects/products-search#term-facet-expression).
* Number of [ProductVariants](ctp:api:type:ProductVariant) that have no value for the specified [term facet expression](/../api/projects/product-projection-search#term-facet-expression).
*
*
*/
readonly missing: number
/**
* Number of terms matching the [term facet expression](/../api/projects/products-search#term-facet-expression).
* Number of terms matching the [term facet expression](/../api/projects/product-projection-search#term-facet-expression).
*
* - If the expression refers to Product fields like `categories.id` and `reviewRatingStatistics.count`, the value represents the number of Products.
* - If the expression is defined for fields specific to Product Variants, for example, `variants.attributes.{name}`, the value represents the number of Product Variants matching the expression.
Expand All @@ -1192,11 +1192,11 @@ export interface TermFacetResult extends IFacetResult {
*/
readonly other: number
/**
* Values for the field specified in [term facet expression](/../api/projects/products-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type:ProductVariant) could be found.
* Values for the field specified in [term facet expression](/../api/projects/product-projection-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type: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](ctp:api:type:Product) through the `counting products` [extension](/projects/products-search#counting-products), then facet terms are returned in a descending order of their `productCount`.
* If the term facet expression specifies to count [Products](ctp:api:type:Product) through the `counting products` [extension](/projects/product-projection-search#counting-products), then facet terms are returned in a descending order of their `productCount`.
*
*
*/
Expand Down Expand Up @@ -2510,7 +2510,7 @@ export interface ProductTransitionStateAction extends IProductUpdateAction {
readonly force?: boolean
}
/**
* Removes the current [projection](/../api/projects/productProjections#current--staged) of the Product. The staged projection is unaffected. To retrieve unpublished Products, the `staged` parameter must be set to `false` when [querying](ctp:api:endpoint:/{projectKey}/product-projections:GET)/[searching](/projects/products-search#product-projection-search) Product Projections. Produces the [ProductUnpublished](ctp:api:type:ProductUnpublishedMessage) Message.
* Removes the current [projection](/../api/projects/productProjections#current--staged) of the Product. The staged projection is unaffected. To retrieve unpublished Products, the `staged` parameter must be set to `false` when [querying](ctp:api:endpoint:/{projectKey}/product-projections:GET)/[searching](/projects/product-projection-search#product-projection-search) Product Projections. Produces the [ProductUnpublished](ctp:api:type:ProductUnpublishedMessage) Message.
*
* When a Product is unpublished, any associated Line Items already present in a Cart remain unaffected and can still be ordered. To prevent this, do the following:
*
Expand Down
8 changes: 4 additions & 4 deletions packages/platform-sdk/src/generated/models/project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ export interface IProjectUpdateAction {
*/
export interface SearchIndexingConfiguration {
/**
* Configuration for the [Product Projection Search](/../api/projects/products-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
* Configuration for the [Product Projection Search](/../api/projects/product-projection-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
*
*/
readonly products?: SearchIndexingConfigurationValues
Expand Down Expand Up @@ -503,14 +503,14 @@ export interface ProjectChangeProductSearchIndexingEnabledAction
extends IProjectUpdateAction {
readonly action: 'changeProductSearchIndexingEnabled'
/**
* - If `false`, the indexing of [Product](ctp:api:type:Product) information will stop and the [Product Projection Search](/../api/projects/products-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will not be available anymore for this Project. The Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be changed to `"Deactivated"`.
* - If `true`, the indexing of [Product](ctp:api:type:Product) information will start and the [Product Projection Search](/../api/projects/products-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be shown as `"Indexing"` during this time. As soon as the indexing has finished, the configuration status will be changed to `"Activated"` making the aforementioned endpoints fully available for this Project.
* - If `false`, the indexing of [Product](ctp:api:type:Product) information will stop and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will not be available anymore for this Project. The Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be changed to `"Deactivated"`.
* - If `true`, the indexing of [Product](ctp:api:type:Product) information will start and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be shown as `"Indexing"` during this time. As soon as the indexing has finished, the configuration status will be changed to `"Activated"` making the aforementioned endpoints fully available for this Project.
*
*
*/
readonly enabled: boolean
/**
* Controls whether the action should apply to [Product Projection Search](/../api/projects/products-search) or to [Product Search](/../api/projects/product-search).
* Controls whether the action should apply to [Product Projection Search](/../api/projects/product-projection-search) or to [Product Search](/../api/projects/product-search).
*
*
*/
Expand Down
2 changes: 2 additions & 0 deletions references.txt
Original file line number Diff line number Diff line change
Expand Up @@ -400,3 +400,5 @@ de47ebf513b4738e7e766621036e58609acba897
f0288f95a5fe33fd2973df3f8290defb15129192
21aedcd93ff144743f0570a5fd0b65af601baa76
790830d35463033d3b7e35060d16659c82040f4e
761762c7caad45bc86b08db7021a033fff18ba90
b32dd9c6633745d71fb526473fed6cc60e1fab0a