Skip to content

Commit

Permalink
build(codegen): updating SDK (#781)
Browse files Browse the repository at this point in the history
Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com>
  • Loading branch information
ct-sdks[bot] authored Aug 12, 2024
1 parent d32ac42 commit cece0c6
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
17 changes: 12 additions & 5 deletions packages/platform-sdk/src/generated/models/product-search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ export interface ProductSearchMatchingVariants {
*/
readonly matchedVariants: ProductSearchMatchingVariantEntry[]
}
/**
* The query parameters used for [data integration with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
*
*/
export interface ProductSearchProjectionParams {
/**
* Expands a `value` of type [Reference](ctp:api:type:Reference) in a [ProductProjection](ctp:api:type:ProductProjection).
Expand Down Expand Up @@ -149,17 +153,21 @@ export interface ProductSearchRequest {
*/
readonly query?: _SearchQuery
/**
* Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
* Controls how results to your query are [sorted](/../api/projects/product-search#sorting).
* If not provided, the results are sorted by relevance score in descending order.
*
*
*/
readonly sort?: SearchSorting[]
/**
* The maximum number of search results to be returned.
* The maximum number of search results to be returned in one [page](/../api/projects/product-search#pagination).
*
*
*/
readonly limit?: number
/**
* The number of search results to be skipped in the response for pagination.
* The number of search results to be skipped in the response for [pagination](/../api/projects/product-search#pagination).
*
*
*/
readonly offset?: number
Expand All @@ -169,8 +177,7 @@ export interface ProductSearchRequest {
*/
readonly markMatchingVariants?: boolean
/**
* Set this field to `{}` to get the [ProductProjection](ctp:api:type:ProductProjection) included in the [ProductSearchResult](ctp:api:type:ProductSearchResult).
* Include query parameters for controlling [Reference Expansion](/../api/general-concepts#reference-expansion) or [projections](/../api/projects/productProjections#projection-dimensions) according to your needs.
* Controls data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
* If not set, the result does not include the Product Projection.
*
*
Expand Down
4 changes: 1 addition & 3 deletions packages/platform-sdk/src/generated/models/search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -311,13 +311,11 @@ export type SearchSortMode = 'avg' | 'max' | 'min' | 'sum' | string
export type SearchSortOrder = 'asc' | 'desc' | string
/**
* Sorting parameters provided with a Search request.
* Sorting allows you to control how results to your query are sorted.
* If no sorting is specified, the results are sorted by relevance in descending (`desc`) order.
*
*/
export interface SearchSorting {
/**
* Use any searchable field of the resource as sort criterion.
* Use any searchable field of the resource as sort criterion, or `"score"` to sort by relevance score calculated by the API.
*
*
*/
Expand Down
1 change: 1 addition & 0 deletions references.txt
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,4 @@ bbcf212f1c06136cd406dd802b8a208daaa1e732
dd82e076236554dd808fb9309d53cb2a207cb296
aa1065bc2b62370c10a6fd7f49098bd9ec71c3ad
6fbc0468427de97a13a8ae23c0d0c157b52b2f45
9b3af920548866a0b9804f2ed2396d5ee45ef1bc

0 comments on commit cece0c6

Please sign in to comment.