@algolia/composition 1.21.0 → 1.22.1

package/dist/fetch.d.ts

@@ -361,6 +361,12 @@ type Composition = {
      */
     description?: string | undefined;
     behavior: CompositionBehavior;
+    /**
+     * A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition. Each key is the label your frontend sends at runtime (for example, \"Price (asc)\"), and each value is the name of the index that should be queried when that label is selected.  When a request includes a \"sortBy\" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to.  Up to 20 sorting strategies can be defined.
+     */
+    sortingStrategy?: {
+        [key: string]: string;
+    } | undefined;
 };
 
 /**
@@ -413,6 +419,10 @@ type Condition = {
      * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
      */
     filters?: string | undefined;
+    /**
+     * Sort criteria that trigger the rule.  You can trigger composition rules based on the selected sorting strategy set by the parameter `sortBy`. The rule will trigger if the value passed to `sortBy` matches the one defined in the condition.
+     */
+    sortBy?: string | undefined;
 };
 
 type TimeRange = {
@@ -561,14 +571,14 @@ type SearchForFacetValuesResponse = {
 
 type CompositionRunAppliedRules = {
     /**
-     * Unique record identifier.
+     * The objectID of the applied composition rule on this query.
      */
     objectID: string;
 };
 
 type CompositionRunSearchResponse = Record<string, any> & {
     /**
-     * Unique record identifier.
+     * The objectID of the composition which generated this result set.
      */
     objectID: string;
     appliedRules?: Array<CompositionRunAppliedRules> | undefined;
@@ -578,7 +588,7 @@ type CompositionsSearchResponse = Record<string, any> & {
     run: Array<CompositionRunSearchResponse>;
 };
 
-type CompositionBaseSearchResponse = Record<string, any> & {
+type CompositionBaseSearchResponse = {
     compositions?: CompositionsSearchResponse | undefined;
 };
 
@@ -863,12 +873,15 @@ type BaseSearchResponse = Record<string, any> & {
 
 type ResultsInjectedItemAppliedRulesInfoResponse = {
     /**
-     * Unique record identifier.
+     * The objectID of the applied index level rule on this injected group.
      */
     objectID: string;
 };
 
 type ResultsInjectedItemInfoResponse = Record<string, any> & {
+    /**
+     * The key of the injected group.
+     */
     key: string;
     appliedRules?: Array<ResultsInjectedItemAppliedRulesInfoResponse> | undefined;
 };
@@ -877,7 +890,7 @@ type ResultsCompositionInfoResponse = {
     injectedItems: Array<ResultsInjectedItemInfoResponse>;
 };
 
-type ResultsCompositionsResponse = Record<string, any> & {
+type ResultsCompositionsResponse = {
     compositions: {
         [key: string]: ResultsCompositionInfoResponse;
     };
@@ -1056,26 +1069,15 @@ type Hit<T = Record<string, unknown>> = T & {
     _extra?: HitMetadata | undefined;
 };
 
-type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
+type SearchFields<T = Record<string, unknown>> = {
     /**
      * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
      */
     hits: Hit<T>[];
     /**
-     * Search query.
-     */
-    query: string;
-    /**
-     * URL-encoded string of all search parameters.
+     * Number of hits returned per page.
      */
-    params: string;
-};
-
-type SearchPagination = {
-    /**
-     * Page of search results to retrieve.
-     */
-    page: number;
+    hitsPerPage: number;
     /**
      * Number of results (hits).
      */
@@ -1085,12 +1087,20 @@ type SearchPagination = {
      */
     nbPages: number;
     /**
-     * Number of hits per page.
+     * The current page of the results.
      */
-    hitsPerPage: number;
+    page: number;
+    /**
+     * URL-encoded string of all search parameters.
+     */
+    params: string;
+    /**
+     * The search query string.
+     */
+    query: string;
 };
 
-type SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse & SearchPagination & SearchHits<T> & ResultsCompositionsResponse;
+type SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse & SearchFields<T> & ResultsCompositionsResponse;
 
 type SearchResults<T = Record<string, unknown>> = {
     /**
@@ -1265,18 +1275,22 @@ type Params = {
      * Search query.
      */
     query?: string | undefined;
-    /**
-     * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
-     */
-    relevancyStrictness?: number | undefined;
     /**
      * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
      */
     queryLanguages?: Array<SupportedLanguage> | undefined;
+    /**
+     * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
+     */
+    relevancyStrictness?: number | undefined;
     /**
      * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
      */
     ruleContexts?: Array<string> | undefined;
+    /**
+     * Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the \"sortingStrategy\" mapping. For example, \"Price (asc)\", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in \"sortingStrategy\", and the query is executed using that index instead of main\'s.  In addition to \"sortingStrategy\", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on \"sortBy\", see Composition Rules.  If no value is provided or an invalid value, no sorting strategy is applied.
+     */
+    sortBy?: string | undefined;
     /**
      * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
      */
@@ -1536,6 +1550,18 @@ type SearchForFacetValuesProps = {
     facetName: string;
     searchForFacetValuesRequest?: SearchForFacetValuesRequest | undefined;
 };
+/**
+ * Properties for the `updateSortingStrategyComposition` method.
+ */
+type UpdateSortingStrategyCompositionProps = {
+    /**
+     * Unique Composition ObjectID.
+     */
+    compositionID: string;
+    requestBody: {
+        [key: string]: string;
+    };
+};
 type WaitForCompositionTaskOptions = {
     /**
      * The maximum number of retries. 50 by default.
@@ -1555,7 +1581,7 @@ type WaitForCompositionTaskOptions = {
     compositionID: string;
 };
 
-declare const apiClientVersion = "1.21.0";
+declare const apiClientVersion = "1.22.1";
 declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -1784,6 +1810,17 @@ declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOpt
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchForFacetValues({ compositionID, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
+    /**
+     * Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to create a new sorting strategy mapping or replace the currently configured one. The provided sorting indices MUST be associated indices or replicas of the main targeted index.  WARNING: This endpoint cannot validate if the sort index is related to the composition\'s main index.   Validation will fail at runtime if the index you updated is not related!  The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param updateSortingStrategyComposition - The updateSortingStrategyComposition object.
+     * @param updateSortingStrategyComposition.compositionID - Unique Composition ObjectID.
+     * @param updateSortingStrategyComposition.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateSortingStrategyComposition({ compositionID, requestBody }: UpdateSortingStrategyCompositionProps, requestOptions?: RequestOptions): Promise<TaskIDResponse>;
 };
 
 /**
@@ -1797,4 +1834,4 @@ type CompositionClient = ReturnType<typeof createCompositionClient>;
 
 declare function compositionClient(appId: string, apiKey: string, options?: ClientOptions | undefined): CompositionClient;
 
-export { type Action, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseInjectionQueryParameters, type BaseSearchResponse, type BatchCompositionAction, type BatchParams, type BooleanString, type Composition, type CompositionBaseSearchResponse, type CompositionBehavior, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRule, type CompositionRuleConsequence, type CompositionRulesBatchParams, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionSource, type CompositionSourceSearch, type CompositionsSearchResponse, type Condition, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DedupPositioning, type Deduplication, type DeleteCompositionAction, type DeleteCompositionProps, type DeleteCompositionRuleAction, type DeleteCompositionRuleProps, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type External, type ExternalInjectedItem, type ExternalInjection, type ExternalOrdering, type ExternalSource, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type GetCompositionProps, type GetRuleProps, type GetTaskProps, type GetTaskResponse, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type IgnorePlurals, type IndexSettingsFacets, type InjectedItem, type InjectedItemHitsMetadata, type InjectedItemMetadata, type InjectedItemSource, type Injection, type InsideBoundingBox, type ListCompositionsProps, type ListCompositionsResponse, type Main, type MainInjectionQueryParameters, type MatchLevel, type MatchedGeoLocation, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OptionalFilters, type OptionalWords, type Params, type Personalization, type PutCompositionProps, type PutCompositionRuleProps, type QueryType, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type RulesBatchCompositionAction, type RulesMultipleBatchRequest, type RulesMultipleBatchResponse, type SaveRulesProps, type Search, type SearchCompositionRulesParams, type SearchCompositionRulesProps, type SearchCompositionRulesResponse, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchHits, type SearchPagination, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SearchSource, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TaskIDResponse, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type Value, type WaitForCompositionTaskOptions, type Widgets, apiClientVersion, compositionClient };
+export { type Action, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseInjectionQueryParameters, type BaseSearchResponse, type BatchCompositionAction, type BatchParams, type BooleanString, type Composition, type CompositionBaseSearchResponse, type CompositionBehavior, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRule, type CompositionRuleConsequence, type CompositionRulesBatchParams, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionSource, type CompositionSourceSearch, type CompositionsSearchResponse, type Condition, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DedupPositioning, type Deduplication, type DeleteCompositionAction, type DeleteCompositionProps, type DeleteCompositionRuleAction, type DeleteCompositionRuleProps, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type External, type ExternalInjectedItem, type ExternalInjection, type ExternalOrdering, type ExternalSource, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type GetCompositionProps, type GetRuleProps, type GetTaskProps, type GetTaskResponse, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type IgnorePlurals, type IndexSettingsFacets, type InjectedItem, type InjectedItemHitsMetadata, type InjectedItemMetadata, type InjectedItemSource, type Injection, type InsideBoundingBox, type ListCompositionsProps, type ListCompositionsResponse, type Main, type MainInjectionQueryParameters, type MatchLevel, type MatchedGeoLocation, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OptionalFilters, type OptionalWords, type Params, type Personalization, type PutCompositionProps, type PutCompositionRuleProps, type QueryType, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type RulesBatchCompositionAction, type RulesMultipleBatchRequest, type RulesMultipleBatchResponse, type SaveRulesProps, type Search, type SearchCompositionRulesParams, type SearchCompositionRulesProps, type SearchCompositionRulesResponse, type SearchFields, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SearchSource, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TaskIDResponse, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateSortingStrategyCompositionProps, type Value, type WaitForCompositionTaskOptions, type Widgets, apiClientVersion, compositionClient };

package/dist/node.d.cts

@@ -361,6 +361,12 @@ type Composition = {
      */
     description?: string | undefined;
     behavior: CompositionBehavior;
+    /**
+     * A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition. Each key is the label your frontend sends at runtime (for example, \"Price (asc)\"), and each value is the name of the index that should be queried when that label is selected.  When a request includes a \"sortBy\" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to.  Up to 20 sorting strategies can be defined.
+     */
+    sortingStrategy?: {
+        [key: string]: string;
+    } | undefined;
 };
 
 /**
@@ -413,6 +419,10 @@ type Condition = {
      * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
      */
     filters?: string | undefined;
+    /**
+     * Sort criteria that trigger the rule.  You can trigger composition rules based on the selected sorting strategy set by the parameter `sortBy`. The rule will trigger if the value passed to `sortBy` matches the one defined in the condition.
+     */
+    sortBy?: string | undefined;
 };
 
 type TimeRange = {
@@ -561,14 +571,14 @@ type SearchForFacetValuesResponse = {
 
 type CompositionRunAppliedRules = {
     /**
-     * Unique record identifier.
+     * The objectID of the applied composition rule on this query.
      */
     objectID: string;
 };
 
 type CompositionRunSearchResponse = Record<string, any> & {
     /**
-     * Unique record identifier.
+     * The objectID of the composition which generated this result set.
      */
     objectID: string;
     appliedRules?: Array<CompositionRunAppliedRules> | undefined;
@@ -578,7 +588,7 @@ type CompositionsSearchResponse = Record<string, any> & {
     run: Array<CompositionRunSearchResponse>;
 };
 
-type CompositionBaseSearchResponse = Record<string, any> & {
+type CompositionBaseSearchResponse = {
     compositions?: CompositionsSearchResponse | undefined;
 };
 
@@ -863,12 +873,15 @@ type BaseSearchResponse = Record<string, any> & {
 
 type ResultsInjectedItemAppliedRulesInfoResponse = {
     /**
-     * Unique record identifier.
+     * The objectID of the applied index level rule on this injected group.
      */
     objectID: string;
 };
 
 type ResultsInjectedItemInfoResponse = Record<string, any> & {
+    /**
+     * The key of the injected group.
+     */
     key: string;
     appliedRules?: Array<ResultsInjectedItemAppliedRulesInfoResponse> | undefined;
 };
@@ -877,7 +890,7 @@ type ResultsCompositionInfoResponse = {
     injectedItems: Array<ResultsInjectedItemInfoResponse>;
 };
 
-type ResultsCompositionsResponse = Record<string, any> & {
+type ResultsCompositionsResponse = {
     compositions: {
         [key: string]: ResultsCompositionInfoResponse;
     };
@@ -1056,26 +1069,15 @@ type Hit<T = Record<string, unknown>> = T & {
     _extra?: HitMetadata | undefined;
 };
 
-type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
+type SearchFields<T = Record<string, unknown>> = {
     /**
      * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
      */
     hits: Hit<T>[];
     /**
-     * Search query.
-     */
-    query: string;
-    /**
-     * URL-encoded string of all search parameters.
+     * Number of hits returned per page.
      */
-    params: string;
-};
-
-type SearchPagination = {
-    /**
-     * Page of search results to retrieve.
-     */
-    page: number;
+    hitsPerPage: number;
     /**
      * Number of results (hits).
      */
@@ -1085,12 +1087,20 @@ type SearchPagination = {
      */
     nbPages: number;
     /**
-     * Number of hits per page.
+     * The current page of the results.
      */
-    hitsPerPage: number;
+    page: number;
+    /**
+     * URL-encoded string of all search parameters.
+     */
+    params: string;
+    /**
+     * The search query string.
+     */
+    query: string;
 };
 
-type SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse & SearchPagination & SearchHits<T> & ResultsCompositionsResponse;
+type SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse & SearchFields<T> & ResultsCompositionsResponse;
 
 type SearchResults<T = Record<string, unknown>> = {
     /**
@@ -1265,18 +1275,22 @@ type Params = {
      * Search query.
      */
     query?: string | undefined;
-    /**
-     * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
-     */
-    relevancyStrictness?: number | undefined;
     /**
      * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
      */
     queryLanguages?: Array<SupportedLanguage> | undefined;
+    /**
+     * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
+     */
+    relevancyStrictness?: number | undefined;
     /**
      * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
      */
     ruleContexts?: Array<string> | undefined;
+    /**
+     * Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the \"sortingStrategy\" mapping. For example, \"Price (asc)\", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in \"sortingStrategy\", and the query is executed using that index instead of main\'s.  In addition to \"sortingStrategy\", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on \"sortBy\", see Composition Rules.  If no value is provided or an invalid value, no sorting strategy is applied.
+     */
+    sortBy?: string | undefined;
     /**
      * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
      */
@@ -1536,6 +1550,18 @@ type SearchForFacetValuesProps = {
     facetName: string;
     searchForFacetValuesRequest?: SearchForFacetValuesRequest | undefined;
 };
+/**
+ * Properties for the `updateSortingStrategyComposition` method.
+ */
+type UpdateSortingStrategyCompositionProps = {
+    /**
+     * Unique Composition ObjectID.
+     */
+    compositionID: string;
+    requestBody: {
+        [key: string]: string;
+    };
+};
 type WaitForCompositionTaskOptions = {
     /**
      * The maximum number of retries. 50 by default.
@@ -1555,7 +1581,7 @@ type WaitForCompositionTaskOptions = {
     compositionID: string;
 };
 
-declare const apiClientVersion = "1.21.0";
+declare const apiClientVersion = "1.22.1";
 declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -1784,6 +1810,17 @@ declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOpt
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchForFacetValues({ compositionID, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
+    /**
+     * Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to create a new sorting strategy mapping or replace the currently configured one. The provided sorting indices MUST be associated indices or replicas of the main targeted index.  WARNING: This endpoint cannot validate if the sort index is related to the composition\'s main index.   Validation will fail at runtime if the index you updated is not related!  The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param updateSortingStrategyComposition - The updateSortingStrategyComposition object.
+     * @param updateSortingStrategyComposition.compositionID - Unique Composition ObjectID.
+     * @param updateSortingStrategyComposition.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateSortingStrategyComposition({ compositionID, requestBody }: UpdateSortingStrategyCompositionProps, requestOptions?: RequestOptions): Promise<TaskIDResponse>;
 };
 
 /**
@@ -1797,4 +1834,4 @@ type CompositionClient = ReturnType<typeof createCompositionClient>;
 
 declare function compositionClient(appId: string, apiKey: string, options?: ClientOptions | undefined): CompositionClient;
 
-export { type Action, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseInjectionQueryParameters, type BaseSearchResponse, type BatchCompositionAction, type BatchParams, type BooleanString, type Composition, type CompositionBaseSearchResponse, type CompositionBehavior, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRule, type CompositionRuleConsequence, type CompositionRulesBatchParams, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionSource, type CompositionSourceSearch, type CompositionsSearchResponse, type Condition, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DedupPositioning, type Deduplication, type DeleteCompositionAction, type DeleteCompositionProps, type DeleteCompositionRuleAction, type DeleteCompositionRuleProps, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type External, type ExternalInjectedItem, type ExternalInjection, type ExternalOrdering, type ExternalSource, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type GetCompositionProps, type GetRuleProps, type GetTaskProps, type GetTaskResponse, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type IgnorePlurals, type IndexSettingsFacets, type InjectedItem, type InjectedItemHitsMetadata, type InjectedItemMetadata, type InjectedItemSource, type Injection, type InsideBoundingBox, type ListCompositionsProps, type ListCompositionsResponse, type Main, type MainInjectionQueryParameters, type MatchLevel, type MatchedGeoLocation, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OptionalFilters, type OptionalWords, type Params, type Personalization, type PutCompositionProps, type PutCompositionRuleProps, type QueryType, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type RulesBatchCompositionAction, type RulesMultipleBatchRequest, type RulesMultipleBatchResponse, type SaveRulesProps, type Search, type SearchCompositionRulesParams, type SearchCompositionRulesProps, type SearchCompositionRulesResponse, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchHits, type SearchPagination, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SearchSource, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TaskIDResponse, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type Value, type WaitForCompositionTaskOptions, type Widgets, apiClientVersion, compositionClient };
+export { type Action, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseInjectionQueryParameters, type BaseSearchResponse, type BatchCompositionAction, type BatchParams, type BooleanString, type Composition, type CompositionBaseSearchResponse, type CompositionBehavior, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRule, type CompositionRuleConsequence, type CompositionRulesBatchParams, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionSource, type CompositionSourceSearch, type CompositionsSearchResponse, type Condition, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DedupPositioning, type Deduplication, type DeleteCompositionAction, type DeleteCompositionProps, type DeleteCompositionRuleAction, type DeleteCompositionRuleProps, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type External, type ExternalInjectedItem, type ExternalInjection, type ExternalOrdering, type ExternalSource, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type GetCompositionProps, type GetRuleProps, type GetTaskProps, type GetTaskResponse, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type IgnorePlurals, type IndexSettingsFacets, type InjectedItem, type InjectedItemHitsMetadata, type InjectedItemMetadata, type InjectedItemSource, type Injection, type InsideBoundingBox, type ListCompositionsProps, type ListCompositionsResponse, type Main, type MainInjectionQueryParameters, type MatchLevel, type MatchedGeoLocation, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OptionalFilters, type OptionalWords, type Params, type Personalization, type PutCompositionProps, type PutCompositionRuleProps, type QueryType, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type RulesBatchCompositionAction, type RulesMultipleBatchRequest, type RulesMultipleBatchResponse, type SaveRulesProps, type Search, type SearchCompositionRulesParams, type SearchCompositionRulesProps, type SearchCompositionRulesResponse, type SearchFields, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SearchSource, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TaskIDResponse, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateSortingStrategyCompositionProps, type Value, type WaitForCompositionTaskOptions, type Widgets, apiClientVersion, compositionClient };