npm - @algolia/recommend - Versions diffs - 5.55.2 → 5.56.0 - Mend

@algolia/recommend 5.55.2 → 5.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/README.md +4 -4
package/dist/browser.d.ts +143 -5
package/dist/builds/browser.js +282 -1
package/dist/builds/browser.js.map +1 -1
package/dist/builds/browser.min.js +5 -5
package/dist/builds/browser.min.js.map +1 -1
package/dist/builds/browser.umd.js +6 -6
package/dist/builds/fetch.js +282 -1
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +282 -1
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +282 -1
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +282 -1
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +143 -5
package/dist/node.d.cts +143 -5
package/dist/node.d.ts +143 -5
package/dist/src/recommendClient.cjs +282 -1
package/dist/src/recommendClient.cjs.map +1 -1
package/dist/src/recommendClient.js +282 -1
package/dist/src/recommendClient.js.map +1 -1
package/dist/worker.d.ts +143 -5
package/package.json +8 -8

package/README.md CHANGED Viewed

@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/recommend@5.55.2
+yarn add @algolia/recommend@5.56.0
 # or
-npm install @algolia/recommend@5.55.2
+npm install @algolia/recommend@5.56.0
 # or
-pnpm add @algolia/recommend@5.55.2
+pnpm add @algolia/recommend@5.56.0
 ```
 ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/recommend@5.55.2
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/recommend@5.55.2/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/recommend@5.56.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
 /**
  * Response, taskID, and deletion timestamp.
@@ -556,7 +556,7 @@ type BaseRecommendRequest = {
 /**
  * Search parameters to use for a fallback request if there aren\'t enough recommendations.
  */
-type FallbackParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
+type FallbackParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings & Record<string, unknown>;
 /**
  * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
@@ -1408,9 +1408,9 @@ type SearchRecommendRulesProps = {
     searchRecommendRulesParams?: SearchRecommendRulesParams | undefined;
 };
-declare const apiClientVersion = "5.55.2";
+declare const apiClientVersion = "5.56.0";
 declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
-    transporter: _algolia_client_common.Transporter;
+    transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
      * The `appId` currently in use.
      */
@@ -1455,6 +1455,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchRecommendRules({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<RecommendUpdatedAtResponse>;
+    /**
+     * Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn\'t require a facet value placeholder (it tries to match the data source item\'s attributes instead).
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param batchRecommendRules - The batchRecommendRules object.
+     * @param batchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param batchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param batchRecommendRules.recommendRule - The recommendRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see batchRecommendRules for the plain version.
+     */
+    batchRecommendRulesWithHTTPInfo({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RecommendUpdatedAtResponse>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
@@ -1463,6 +1478,17 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customDelete for the plain version.
+     */
+    customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
@@ -1471,6 +1497,17 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customGet for the plain version.
+     */
+    customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
@@ -1480,6 +1517,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customPost for the plain version.
+     */
+    customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
@@ -1489,6 +1538,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customPut for the plain version.
+     */
+    customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * Deletes a Recommend rule from a recommendation scenario.
      *
@@ -1501,6 +1562,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteRecommendRule({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
+    /**
+     * Deletes a Recommend rule from a recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param deleteRecommendRule - The deleteRecommendRule object.
+     * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param deleteRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see deleteRecommendRule for the plain version.
+     */
+    deleteRecommendRuleWithHTTPInfo({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
     /**
      * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
      *
@@ -1513,6 +1589,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRecommendRule({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<RecommendRule>;
+    /**
+     * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - settings
+     * @param getRecommendRule - The getRecommendRule object.
+     * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendRule for the plain version.
+     */
+    getRecommendRuleWithHTTPInfo({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RecommendRule>>;
     /**
      * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
      *
@@ -1525,6 +1616,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRecommendStatus({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<GetRecommendTaskResponse>;
+    /**
+     * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param getRecommendStatus - The getRecommendStatus object.
+     * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendStatus.taskID - Unique task identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendStatus for the plain version.
+     */
+    getRecommendStatusWithHTTPInfo({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetRecommendTaskResponse>>;
     /**
      * Retrieves recommendations from selected AI models.
      *
@@ -1534,6 +1640,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendations for the plain version.
+     */
+    getRecommendationsWithHTTPInfo(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetRecommendationsResponse>>;
     /**
      * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
      *
@@ -1546,6 +1664,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchRecommendRules({ indexName, model, searchRecommendRulesParams }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<SearchRecommendRulesResponse>;
+    /**
+     * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - settings
+     * @param searchRecommendRules - The searchRecommendRules object.
+     * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see searchRecommendRules for the plain version.
+     */
+    searchRecommendRulesWithHTTPInfo({ indexName, model, searchRecommendRulesParams }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchRecommendRulesResponse>>;
 };
 /**
@@ -1555,7 +1688,12 @@ type ErrorBase = Record<string, any> & {
     message?: string | undefined;
 };
+/**
+ * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
+ */
+type FacetFilters = Array<FacetFilters> | string;
 declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions | undefined): RecommendClient;
 type RecommendClient = ReturnType<typeof createRecommendClient>;
-export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BatchRecommendRulesProps, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type InsideBoundingBox, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type OptionalWords, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendUpdatedAtResponse, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TimeRange, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, type Widgets, apiClientVersion, recommendClient };
+export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BatchRecommendRulesProps, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type InsideBoundingBox, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type OptionalWords, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendUpdatedAtResponse, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TimeRange, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, type Widgets, apiClientVersion, recommendClient };

package/dist/builds/browser.js CHANGED Viewed

@@ -9,7 +9,7 @@ import { createXhrRequester } from "@algolia/requester-browser-xhr";
 // src/recommendClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent, shuffle, validateRequired } from "@algolia/client-common";
-var apiClientVersion = "5.55.2";
+var apiClientVersion = "5.56.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -138,6 +138,35 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn\'t require a facet value placeholder (it tries to match the data source item\'s attributes instead).
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param batchRecommendRules - The batchRecommendRules object.
+     * @param batchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param batchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param batchRecommendRules.recommendRule - The recommendRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see batchRecommendRules for the plain version.
+     */
+    batchRecommendRulesWithHTTPInfo({ indexName, model, recommendRule }, requestOptions) {
+      validateRequired("indexName", "batchRecommendRulesWithHTTPInfo", indexName);
+      validateRequired("model", "batchRecommendRulesWithHTTPInfo", model);
+      const requestPath = "/1/indexes/{indexName}/{model}/recommend/rules/batch".replace("{indexName}", encodeURIComponent(indexName)).replace("{model}", encodeURIComponent(model));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: recommendRule ? recommendRule : {}
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
@@ -158,6 +187,29 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customDelete for the plain version.
+     */
+    customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
+      validateRequired("path", "customDeleteWithHTTPInfo", path);
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
@@ -178,6 +230,29 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customGet for the plain version.
+     */
+    customGetWithHTTPInfo({ path, parameters }, requestOptions) {
+      validateRequired("path", "customGetWithHTTPInfo", path);
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
@@ -200,6 +275,31 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customPost for the plain version.
+     */
+    customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
+      validateRequired("path", "customPostWithHTTPInfo", path);
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
@@ -222,6 +322,31 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see customPut for the plain version.
+     */
+    customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
+      validateRequired("path", "customPutWithHTTPInfo", path);
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * Deletes a Recommend rule from a recommendation scenario.
      *
@@ -248,6 +373,35 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Deletes a Recommend rule from a recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param deleteRecommendRule - The deleteRecommendRule object.
+     * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param deleteRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see deleteRecommendRule for the plain version.
+     */
+    deleteRecommendRuleWithHTTPInfo({ indexName, model, objectID }, requestOptions) {
+      validateRequired("indexName", "deleteRecommendRuleWithHTTPInfo", indexName);
+      validateRequired("model", "deleteRecommendRuleWithHTTPInfo", model);
+      validateRequired("objectID", "deleteRecommendRuleWithHTTPInfo", objectID);
+      const requestPath = "/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{model}", encodeURIComponent(model)).replace("{objectID}", encodeURIComponent(objectID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
      *
@@ -274,6 +428,35 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - settings
+     * @param getRecommendRule - The getRecommendRule object.
+     * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendRule for the plain version.
+     */
+    getRecommendRuleWithHTTPInfo({ indexName, model, objectID }, requestOptions) {
+      validateRequired("indexName", "getRecommendRuleWithHTTPInfo", indexName);
+      validateRequired("model", "getRecommendRuleWithHTTPInfo", model);
+      validateRequired("objectID", "getRecommendRuleWithHTTPInfo", objectID);
+      const requestPath = "/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{model}", encodeURIComponent(model)).replace("{objectID}", encodeURIComponent(objectID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
      *
@@ -300,6 +483,35 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param getRecommendStatus - The getRecommendStatus object.
+     * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendStatus.taskID - Unique task identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendStatus for the plain version.
+     */
+    getRecommendStatusWithHTTPInfo({ indexName, model, taskID }, requestOptions) {
+      validateRequired("indexName", "getRecommendStatusWithHTTPInfo", indexName);
+      validateRequired("model", "getRecommendStatusWithHTTPInfo", model);
+      validateRequired("taskID", "getRecommendStatusWithHTTPInfo", taskID);
+      const requestPath = "/1/indexes/{indexName}/{model}/task/{taskID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{model}", encodeURIComponent(model)).replace("{taskID}", encodeURIComponent(taskID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * Retrieves recommendations from selected AI models.
      *
@@ -331,6 +543,44 @@ function createRecommendClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getRecommendations for the plain version.
+     */
+    getRecommendationsWithHTTPInfo(getRecommendationsParams, requestOptions) {
+      if (getRecommendationsParams && Array.isArray(getRecommendationsParams)) {
+        const newSignatureRequest = {
+          requests: getRecommendationsParams
+        };
+        getRecommendationsParams = newSignatureRequest;
+      }
+      validateRequired("getRecommendationsParams", "getRecommendationsWithHTTPInfo", getRecommendationsParams);
+      validateRequired(
+        "getRecommendationsParams.requests",
+        "getRecommendationsWithHTTPInfo",
+        getRecommendationsParams.requests
+      );
+      const requestPath = "/1/indexes/*/recommendations";
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: getRecommendationsParams,
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
+    },
     /**
      * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
      *
@@ -358,6 +608,37 @@ function createRecommendClient({
         cacheable: true
       };
       return transporter.request(request, requestOptions);
+    },
+    /**
+     * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - settings
+     * @param searchRecommendRules - The searchRecommendRules object.
+     * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see searchRecommendRules for the plain version.
+     */
+    searchRecommendRulesWithHTTPInfo({ indexName, model, searchRecommendRulesParams }, requestOptions) {
+      validateRequired("indexName", "searchRecommendRulesWithHTTPInfo", indexName);
+      validateRequired("model", "searchRecommendRulesWithHTTPInfo", model);
+      const requestPath = "/1/indexes/{indexName}/{model}/recommend/rules/search".replace("{indexName}", encodeURIComponent(indexName)).replace("{model}", encodeURIComponent(model));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: searchRecommendRulesParams ? searchRecommendRulesParams : {},
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.requestWithHttpInfo(request, requestOptions);
     }
   };
 }