Skip to content

Commit fef9a76

Browse files
authored
Update generated SDKs (#1048)
* build(codegen): updating SDK * build(codegen): updating SDK --------- Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com>
1 parent 70c3d5f commit fef9a76

File tree

8 files changed

+44
-59
lines changed

8 files changed

+44
-59
lines changed

.changeset/changes_api.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
'@commercetools/platform-sdk': minor
3+
---
4+
5+
**Api changes**
6+
7+
<details>
8+
<summary>Changed Property(s)</summary>
9+
10+
- :warning: changed property `actions` of type `MyBusinessUnitUpdate` from type `BusinessUnitUpdateAction[]` to `MyBusinessUnitUpdateAction[]`
11+
</details>

changes.md

+2-29
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
11
**Api changes**
22

33
<details>
4-
<summary>Changed Type(s)</summary>
4+
<summary>Changed Property(s)</summary>
55

6-
- :warning: changed type `DeliveryPayload` from type `object` to `SubscriptionNotification`
7-
- :warning: changed type `EventDeliveryPayload` from type `DeliveryPayload` to `SubscriptionNotification`
8-
</details>
9-
10-
<details>
11-
<summary>Added Type(s)</summary>
12-
13-
- added type `BusinessUnitSetUnitTypeAction`
14-
- added type `BaseEvent`
15-
- added type `BusinessUnitTopLevelUnitSetMessage`
16-
- added type `BusinessUnitTypeSetMessage`
17-
- added type `BusinessUnitTopLevelUnitSetMessagePayload`
18-
- added type `BusinessUnitTypeSetMessagePayload`
19-
- added type `SubscriptionNotification`
20-
</details>
21-
22-
<details>
23-
<summary>Removed Property(s)</summary>
24-
25-
- :warning: removed property `data` from type `Event`
26-
</details>
27-
28-
<details>
29-
<summary>Added Property(s)</summary>
30-
31-
- added property `projectKey` to type `DeliveryPayload`
32-
- added property `resource` to type `DeliveryPayload`
33-
- added property `resourceUserProvidedIdentifiers` to type `DeliveryPayload`
6+
- :warning: changed property `actions` of type `MyBusinessUnitUpdate` from type `BusinessUnitUpdateAction[]` to `MyBusinessUnitUpdateAction[]`
347
</details>

packages/platform-sdk/src/generated/models/error.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2041,7 +2041,7 @@ export interface StoreCartDiscountsLimitReachedError extends IErrorObject {
20412041
readonly stores: StoreKeyReference[]
20422042
}
20432043
/**
2044-
* 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.
2044+
* 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.
20452045
*
20462046
*/
20472047
export interface SyntaxErrorError extends IErrorObject {
@@ -3565,7 +3565,7 @@ export interface GraphQLStoreCartDiscountsLimitReachedError
35653565
readonly stores: StoreKeyReference[]
35663566
}
35673567
/**
3568-
* 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.
3568+
* 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.
35693569
*
35703570
*/
35713571
export interface GraphQLSyntaxErrorError extends IGraphQLErrorObject {

packages/platform-sdk/src/generated/models/me.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import {
99
AssociateRoleAssignmentDraft,
1010
BusinessUnitResourceIdentifier,
1111
BusinessUnitType,
12-
BusinessUnitUpdateAction,
1312
} from './business-unit'
1413
import {
1514
CartReference,
@@ -148,7 +147,7 @@ export interface MyBusinessUnitUpdate {
148147
*
149148
*
150149
*/
151-
readonly actions: BusinessUnitUpdateAction[]
150+
readonly actions: MyBusinessUnitUpdateAction[]
152151
}
153152
export type MyBusinessUnitUpdateAction =
154153
| MyBusinessUnitAddAddressAction

packages/platform-sdk/src/generated/models/product-type.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export interface AttributeDefinition {
7979
*/
8080
readonly inputHint: TextInputHint
8181
/**
82-
* 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.
82+
* 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.
8383
*
8484
* Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
8585
* The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
@@ -140,7 +140,7 @@ export interface AttributeDefinitionDraft {
140140
*/
141141
readonly inputHint?: TextInputHint
142142
/**
143-
* 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.
143+
* 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.
144144
* Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
145145
* The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
146146
* This constraint is enforced at both Product creation and Product update.

packages/platform-sdk/src/generated/models/product.ts

+20-20
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export interface FacetRange {
108108
/**
109109
* Number of [Products](ctp:api:type:Product) for which the values in a field fall into the specified range.
110110
*
111-
* Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
111+
* Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.
112112
*
113113
*
114114
*/
@@ -153,7 +153,7 @@ export interface FacetResults {
153153
}
154154
export interface FacetTerm {
155155
/**
156-
* 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.
156+
* 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.
157157
*
158158
*
159159
*/
@@ -166,7 +166,7 @@ export interface FacetTerm {
166166
readonly count: number
167167
/**
168168
* Number of [Products](ctp:api:type:Product) for which the `term` applies.
169-
* Only available if the `counting products` [extension](/../api/projects/products-search#counting-products) is enabled.
169+
* Only available if the `counting products` [extension](/../api/projects/product-projection-search#counting-products) is enabled.
170170
*
171171
*
172172
*/
@@ -182,15 +182,15 @@ export type FacetTypes = 'filter' | 'range' | 'terms' | (string & {})
182182
export interface FilteredFacetResult extends IFacetResult {
183183
readonly type: 'filter'
184184
/**
185-
* Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
185+
* Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
186186
*
187187
*
188188
*/
189189
readonly count: number
190190
/**
191-
* Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
191+
* Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
192192
*
193-
* Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
193+
* Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.
194194
*
195195
*
196196
*/
@@ -389,7 +389,7 @@ export interface ProductData {
389389
*/
390390
readonly variants: ProductVariant[]
391391
/**
392-
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
392+
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
393393
*
394394
*
395395
*/
@@ -481,7 +481,7 @@ export interface ProductDraft {
481481
*/
482482
readonly taxCategory?: TaxCategoryResourceIdentifier
483483
/**
484-
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
484+
* Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
485485
*
486486
*
487487
*/
@@ -736,19 +736,19 @@ export interface ProductProjectionPagedQueryResponse {
736736
readonly results: ProductProjection[]
737737
}
738738
/**
739-
* The response returned to a [Product Projection Search](/../api/projects/products-search#product-projection-search) request.
740-
* 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.
739+
* The response returned to a [Product Projection Search](/../api/projects/product-projection-search#product-projection-search) request.
740+
* 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.
741741
*
742742
*/
743743
export interface ProductProjectionPagedSearchResponse {
744744
/**
745-
* The maximum number of results returned on a [page](/../api/projects/products-search#pagination).
745+
* The maximum number of results returned on a [page](/../api/projects/product-projection-search#pagination).
746746
*
747747
*
748748
*/
749749
readonly limit: number
750750
/**
751-
* The starting point for the retrieved [paginated](/../api/projects/products-search#pagination) result.
751+
* The starting point for the retrieved [paginated](/../api/projects/product-projection-search#pagination) result.
752752
*
753753
*
754754
*/
@@ -767,13 +767,13 @@ export interface ProductProjectionPagedSearchResponse {
767767
readonly total?: number
768768
/**
769769
* [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.
770-
* If the query parameter `markMatchingVariants=true` was provided with the request, the [matching variants](/../api/projects/products-search#matching-variants) are marked as such.
770+
* 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.
771771
*
772772
*
773773
*/
774774
readonly results: ProductProjection[]
775775
/**
776-
* Facet results for each [facet expression](/../api/projects/products-search#facets) specified in the search request.
776+
* Facet results for each [facet expression](/../api/projects/product-projection-search#facets) specified in the search request.
777777
*
778778
* Only present if at least one `facet` parameter was provided with the search request.
779779
*
@@ -1125,7 +1125,7 @@ export interface SearchKeyword {
11251125
readonly suggestTokenizer?: SuggestTokenizer
11261126
}
11271127
/**
1128-
* 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).
1128+
* 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).
11291129
* The keys are of type [Locale](ctp:api:type:Locale), and the values are an array of [SearchKeyword](ctp:api:type:SearchKeyword).
11301130
*
11311131
*/
@@ -1171,13 +1171,13 @@ export interface TermFacetResult extends IFacetResult {
11711171
*/
11721172
readonly dataType: TermFacetResultType
11731173
/**
1174-
* Number of [ProductVariants](ctp:api:type:ProductVariant) that have no value for the specified [term facet expression](/../api/projects/products-search#term-facet-expression).
1174+
* 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).
11751175
*
11761176
*
11771177
*/
11781178
readonly missing: number
11791179
/**
1180-
* Number of terms matching the [term facet expression](/../api/projects/products-search#term-facet-expression).
1180+
* Number of terms matching the [term facet expression](/../api/projects/product-projection-search#term-facet-expression).
11811181
*
11821182
* - If the expression refers to Product fields like `categories.id` and `reviewRatingStatistics.count`, the value represents the number of Products.
11831183
* - 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.
@@ -1192,11 +1192,11 @@ export interface TermFacetResult extends IFacetResult {
11921192
*/
11931193
readonly other: number
11941194
/**
1195-
* 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.
1195+
* 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.
11961196
*
11971197
* By default, facet terms are returned in a descending order of their `count`.
11981198
*
1199-
* 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`.
1199+
* 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`.
12001200
*
12011201
*
12021202
*/
@@ -2510,7 +2510,7 @@ export interface ProductTransitionStateAction extends IProductUpdateAction {
25102510
readonly force?: boolean
25112511
}
25122512
/**
2513-
* 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.
2513+
* 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.
25142514
*
25152515
* 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:
25162516
*

packages/platform-sdk/src/generated/models/project.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ export interface IProjectUpdateAction {
287287
*/
288288
export interface SearchIndexingConfiguration {
289289
/**
290-
* Configuration for the [Product Projection Search](/../api/projects/products-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
290+
* Configuration for the [Product Projection Search](/../api/projects/product-projection-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
291291
*
292292
*/
293293
readonly products?: SearchIndexingConfigurationValues
@@ -503,14 +503,14 @@ export interface ProjectChangeProductSearchIndexingEnabledAction
503503
extends IProjectUpdateAction {
504504
readonly action: 'changeProductSearchIndexingEnabled'
505505
/**
506-
* - 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"`.
507-
* - 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.
506+
* - 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"`.
507+
* - 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.
508508
*
509509
*
510510
*/
511511
readonly enabled: boolean
512512
/**
513-
* Controls whether the action should apply to [Product Projection Search](/../api/projects/products-search) or to [Product Search](/../api/projects/product-search).
513+
* Controls whether the action should apply to [Product Projection Search](/../api/projects/product-projection-search) or to [Product Search](/../api/projects/product-search).
514514
*
515515
*
516516
*/

references.txt

+2
Original file line numberDiff line numberDiff line change
@@ -400,3 +400,5 @@ de47ebf513b4738e7e766621036e58609acba897
400400
f0288f95a5fe33fd2973df3f8290defb15129192
401401
21aedcd93ff144743f0570a5fd0b65af601baa76
402402
790830d35463033d3b7e35060d16659c82040f4e
403+
761762c7caad45bc86b08db7021a033fff18ba90
404+
b32dd9c6633745d71fb526473fed6cc60e1fab0a

0 commit comments

Comments
 (0)