JavaScript API client changelog

5.49.1

chore(deps): dependencies 2026-02-23 (#5999)

5.49.0

chore(deps): dependencies 2026-02-16 (#5965)
feat(specs): add optional feedID to composition result set (#5991)
fix(specs): invalid API format for multi feed in Comp API (#5993)

5.48.2

fix(javascript): Added warning in comment (#5961)

5.48.1

docs(specs): align with style guides (#5930)
fix(specs): insights-api timestamp documentation (#5925)
fix(specs): BREAKING CHANGE – remove unnecessary required fields (#5959)
The SearchResponse model now accepts query and params as optional parameters, as they are not always returned by the API.
fix(specs): add missing redirect property to rule consequence schema (#5934)
chore(deps): dependencies 2026-02-09 (#5935)

5.48.0

BREAKING CHANGES: this minor version includes multiple breaking changes related to fixes on different APIs. See below for more details.

feat(specs): conditions is not required anymore in composition rules (#5853)
docs(SearchParams): Document that filter scores are supported in virtual replicas (#5716)
fix(specs): BREAKING CHANGE – remove baseRecommendRequest from trendingFacets [CR-10264] (#5858)
The TrendingFacets model has been updated to reflect the API response.
docs: BREAKING CHANGE – authentication type can’t be updated (#5824)
The AuthenticationUpdate model has been updated to reflect that the type field can’t be updated.
chore(deps): dependencies 2026-01-26 (#5859)
feat(clients): Test python timeout (#5883)
fix(specs): allow additionalProperties on insights-api events (#5885)
fix(specs): BREAKING CHANGE – more accurate composition behavior typing (#5892)
The CompositionBehavior model is now a union type for better accuracy.
feat(specs): BREAKING CHANGE – Ingestion API: new code property in oauth authentication (#5897)
The AuthOAuth and AuthOAuthPartial models have been updated to reflect that the clientId field is now optional, and the code field can be set.
chore(deps): dependencies 2026-02-02 (#5898)

5.47.0

feat(specs): introduce multifeed composition behavior for beta release (#5828)

5.46.4

chore: agentic config prep (#5825)

5.46.3

fix(specs): BREAKING CHANGE — remove fields requirement from run response in CompAPI client (#5809)
Some fields from the Composition Run search response were marked as required while they were optional on the API side. This has been fixed, but might impact the client types.
chore(deps): dependencies 2025-12-29 (#5792)

5.46.2

chore: migrate lerna config (#5772)
chore(deps): dependencies 2025-12-22 (#5775)

5.46.1

chore: setup release workflow for npm trusted publisher (#5717)
refactor(specs): extract results field in a dedicated directory (#5739)
chore(deps): dependencies 2025-11-24 (#5653)
chore: update instantsearch dependencies (#5743)
refactor(specs): re-organise response for Composition API (#5744)
chore(deps): dependencies 2025-12-15 (#5745)
fix(specs): update list with NLU permissions (#5769)

5.46.0

chore(scripts): update the jira action (#5678)
chore(scripts): remove component from jira ticket (#5680)
chore(specs): change oneOf order for docs (#5676)
feat(specs): add sortBy query param and sortingStrategy (#5686)
feat(specs): add sortBy trigger on Composition Rules (#5707)
docs(abtests): Added documentation for featureFilters configuration i… (#5688)
feat(javascript): allow cache on POST (#5675)

5.45.0

chore(deps): dependencies 2025-11-17 (#5624)
feat(specs): allow enablePersonalization query parameter at run time for Composition API (#5651)

5.44.0

feat(specs): add useImagesObjects property in commercetools source input (#5586)
fix(specs): Add title values to key oneOfs (#5581)
chore(deps): dependencies 2025-11-10 (#5585)
fix(specs): update run reason in observability (#5623)
fix(specs): add tags and scope to rules (#5625)

5.43.0

feat(clients): remove schedule capabilities (#5552)
chore(deps): dependencies 2025-11-03 (#5553)
feat(specs): add fallbackParameters to Frequently bought together [RECO-2443] (#5579)

5.42.0

fix(specs): add ACL to missing endpoints (#5529)
chore(deps): dependencies 2025-10-27 (#5530)
feat(specs): add specific documentation for facets query parameter in Composition API (#5477)

5.41.0

fix(specs): ingestion small fix + added source input descriptions (#5515)
feat(specs): add facets query parameter available at run time (#5486)
chore(deps): dependencies 2025-10-20 (#5487)

5.40.1

chore(deps): dependencies 2025-10-13 (#5453)
fix(clients): forward requestOptions to searchForHits (#5473)
fix(clients): upgrade linter (#5476)
chore: remove dead links (#5472)
docs: replace links for the new doc (#5478)

5.40.0

feat(specs): add compositions deduplication setting (#5418)
fix(clients): add a default idleConnTimeout (#5442)
chore(deps): dependencies 2025-09-29 (#5393)

5.39.0

feat(specs): add partialNoCreate action to ingestion specs (#5389)

5.38.0

chore(deps): dependencies 2025-09-08 (#5310)
test(javascript): update compositions testcases for metadata and external injected items (#5331)
fix(specs): normalize spelling of summaries (#5340)
feat(specs): allow filtering transformations type (#5363)
feat(specs): deprecate Predict real-time endpoints (#5364)
chore(deps): dependencies 2025-09-15 (#5341)
feat(specs): merge composition & composition-full (#5333)
chore(deps): dependencies 2025-09-22 (#5369)

5.37.0

fix(specs): Cross-reference filerPromotes to relevant guide (#5279)
feat(specs): add put task endpoint to ingestion api (#5281)
fix(specs): add getVersion parameter to getSettings (#5254)
feat(specs): add put and delete API for compositions and rules (#5282)
chore(deps): dependencies 2025-09-01 (#5285)
chore(website): exclude schema from generated variables file (#5306)
fix(clients): link to support/help center on unreachable hosts (#5305)

5.36.0

fix(clients): prefix tags with v (#5186)
chore(deps): dependencies 2025-08-04 (#5187)
refactor(specs): mutualise code between Search API & Comp API for search query parameters (#5125)
fix(specs): define batch actions (#5242)
feat(specs): add fields for metadata in composition injectedItems (#5241)
chore(deps): dependencies 2025-08-11 (#5225)
feat(specs): abtests stopped at (#5275)

5.35.0

chore(deps): dependencies 2025-07-28 (#5161)
fix(clients): add batchSize to accountCopyIndex (#5181)
feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package (#5157)

5.34.1

refactor(specs): add interface to manipulate query parameter between composition API & Search API (#5123)
chore(deps): dependencies 2025-07-21 (#5129)
fix(specs): Add customSearchParameters to Variant schema, and add direction query param for GET abtests (#5130)
fix(specs): value/price clarifications in the Insights API (#5154)
fix(clients): reduce chances of Push rate limiting (#5153)

5.34.0

fix(specs): abtests metadata mean (#5121)
fix(specs): cleanup for composition API clients (#5119)
refactor(specs): group files for composition api (#5122)
feat(specs): add lastUpdatedAt to personalization real-time user (#5126)

5.33.0

feat(specs): document runMetadata parameter (#5087)
chore(deps): dependencies 2025-07-14 (#5091)
fix(specs): abtest v3 naming conflict with Metric type (#5090)

5.32.0

feat(templates): use headers in js advanced perso client (#5083)

5.31.0

fix(specs): update sourceRun docs (#5057)
fix(specs): allow one sided rule validity (#5060)
chore(deps): dependencies 2025-07-07 (#5063)
feat(javascript): generate abtesting v3 alpha client (#4783)

5.30.0

chore(deps): dependencies 2025-06-23 (#5016)
chore(deps): dependencies 2025-06-30 (#5031)
feat(specs): abtesting winsorizedAmount (#5053)

5.29.0

fix(specs): fix type in realtime_user (#5012)
feat(clients): add replaceAllObjectsWithTransformation (#5008)
chore(spec): fix comment of custom path (#5014)
fix(clients): allow chunked requests on WithTransformation methods (#5011)

5.28.0

feat(javascript): add exactOptionalPropertyTypes to tsconfig (#4935)
chore(deps): dependencies 2025-06-09 (#4943)
feat(specs): update try transformation specs for no-code (#4974)
feat(clients): add real-time personalization to advanced-personalization [PRED-3870] (#4976)
chore(deps): dependencies 2025-06-16 (#4977)
fix(clients): processingTimeMS should be optional (#5004)
feat(specs): add new ingestion property for push (#5007)

5.27.0

feat(specs): add with transformation helpers (#4931)

5.26.0

fix(specs): typo (#4854)
chore(deps): dependencies 2025-05-19 (#4853)
feat(specs): add global push endpoint (#4855)
feat(javascript): add bridge to transformation on algoliasearch (#4852)
fix(specs): updated watchResponse (#4879)
chore(deps): dependencies 2025-05-26 (#4880)
feat(specs): update transformation specs for no-code (#4901)
chore(deps): dependencies 2025-06-02 (#4899)
feat(clients): add generic parameter (#4922)
fix(specs): more indexing actions to push (#4930)
fix(specs): wrong ACL for getSettings (#4933)

5.25.0

chore(deps): dependencies 2025-05-05 (#4804)
feat(specs): enrich response for list composition endpoint (#4819)
feat(specs): make response fields required for composition list endpoint (#4821)
fix(specs): add x-acl to insights endpoints (#4822)
chore(deps): dependencies 2025-05-12 (#4823)
feat(scripts): add push to mcp-node on release (#4784)

5.24.0

chore(deps): dependencies 2025-04-21 (#4762)
feat(javascript): prepare composition for stable release (#4782)
chore(deps): dependencies 2025-04-28 (#4785)
feat(javascript): add accountCopyIndex helper (#4798)

5.23.4

fix(specs): condition cant be numeric filter (#4726)
fix(specs): event.status can be null (#4727)
fix(specs): add missing recordType collection (#4728)
chore(deps): dependencies 2025-04-14 (#4729)
fix(clients): correctly deserialize SearchResult (#4756)

5.23.3

fix(specs): userData is any type (#4702)
docs(partialUpdate): add note about multiple operations (#4721)
chore(deps): dependencies 2025-04-07 (#4703)
fix(specs): message is not required in WatchResponse (#4723)

5.23.2

fix(specs): make the updateAt non-null in ingestion (#4697)

5.23.1

chore(deps): dependencies 2025-03-31 (#4661)
chore: deprecate mcm methods (#4694)

5.23.0

feat(clients): add new realtime-personalization api (#4613)
chore: do not generate realtime personalization (#4655)
feat(specs): add CT Query predicate property (#4654)

5.22.0

chore(deps): dependencies 2025-03-10 (#4566)
feat(specs): add the owner attributes to ingestion resources (#4616)
chore(deps): dependencies 2025-03-24 (#4617)

5.21.0

feat(specs): add subscriptionAction to ingestion specs (#4587)

5.20.4

chore(scripts): point jira issues to another epic (#4505)
chore(deps): dependencies 2025-03-03 (#4511)
fix(specs): Increase optionalWords visibility in docs (#4559)

5.20.3

chore(deps): dependencies 2025-02-17 (#4459)

5.20.2

chore(deps): dependencies 2025-02-10 (#4432)

5.20.1

fix(specs): responseFields description (#4399)
fix(specs): add a linter to assert that type is present (#4393)
chore(deps): dependencies 2025-01-27 (#4395)

5.20.0

feat(specs): only use shortname in the source input (#4287)
fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings (#4324)
chore(deps): dependencies 2025-01-13 (#4325)
fix(specs): optionalFilters additional explanation (#4353)
fix(specs): ingestion expected and received events type (#4356)
fix(specs): extend Analytics descriptions (#4360)
fix(specs): remove the processing outcome (#4359)
fix(specs): adjust style for banner descriptions (#4362)
chore(deps): dependencies 2025-01-20 (#4365)
feat(specs): rename composition to composition-full (private) and add composition (public) (#4357)
fix(javascript): use beta version (#4385)

5.19.0

chore(deps): dependencies 2024-12-23 (#4258)
fix(specs): drop singer from ingestion specs (#4281)
feat(javascript): expose current apiKey on the client instance (#4285)
chore(deps): dependencies 2024-12-30 (#4286)
feat(clients): cleanup after replaceAllObjects failure (#3824)
chore(deps): dependencies 2025-01-06 (#4299)
feat(specs): improve Composition Client searchResponse specs (matches SearchClient more closely for IS) (#4300)
feat(specs): add notification settings to tasks (#4297)
feat(clients): add optionnal scopes to replaceAllObjects (#4296)
chore: revert release (#4314)

5.18.0

chore(deps): dependencies 2024-12-16 (#4235)
chore: trigger auto close pr (#4250)
feat(javascript): add worker build (#4249)
fix(specs): endpoint level timeout for ingestion (#4251)
feat(specs): update composition specs according to upcoming API changes (#4234)

5.17.1

fix(specs): enable watcher for push (#4229)
fix(specs): add ignoreConjugations to AlternativesAsExact (#4230)

5.17.0

fix(specs): different summaries for saveObject/addOrUpdate methods (#4223)
feat(specs): add watch to pushTask ingestion (#4224)

5.16.0

feat(specs): add info and link about indexing rate limits (#4136)
fix(javascript): set latest version on prereleases (#4138)
fix(specs): nb_api_calls in getLogs response is optional (#4142)
fix(javascript): allow async param on createIterablePromise (#4144)
chore(deps): dependencies 2024-11-25 (#4145)
fix(specs): consequence is required when saving rules (#4146)
fix(specs): saveRule response type (#4170)
feat(clients): allow batch size on objects helper (#4172)
chore(deps): dependencies 2024-12-02 (#4174)
fix(specs): remove SFCC source type (#4190)
chore: add homepage to JavaScript client package (#4192)
fix(specs): add sourceType to listTasks (#4193)
feat(generators): allow per-spec timeouts (#4173)
chore(deps): dependencies 2024-12-09 (#4197)

5.15.0

chore(scripts): change dist folder and bump (#4113)
chore(deps): dependencies 2024-11-18 (#4109)
fix(playground): add formatter for python (#4125)
fix(specs): do not cache searchCompositionRules (#4127)
feat(specs): default authMode to WithinHeaders for Composition Client (#4129)
fix(cts): add tests for HTML error (#4097)

5.14.2

fix(javascript): add support for private package publish (#4106)
fix(specs): make the searchParams compatible with v4 (#4108)
fix(specs): remove private beta endpoint from recommend (#4110)

5.14.0

feat(specs): add estimate path and responses (#4057)
chore(deps): dependencies 2024-11-11 (#4080)
feat(specs): update estimate response type (#4101)
fix(specs): rename composition run endpoint (#4099)
fix(scripts): dart and js releases (#4104)

5.13.0

fix(javascript): allow import from dist (#4060)
fix(specs): add secrets payload for updates (#4061)
fix(clients): update browse iterator (#4058)
chore(deps): dependencies 2024-11-04 (#4065)
feat(scripts): compute eligibility dates (#4064)
feat(specs): add composition API (#4056)

5.12.0

feat(specs): add secrets authentications to ingestion (#4054)

5.11.0

feat(specs): add missing message attribute to GetObjectsResponse [skip-bc] (#4029)
fix(specs): support synonyms type in camel case [skip-bc] (#4031)
chore(deps): dependencies 2024-10-28 [skip-bc] (#4032)
feat(clients): expose waitForTasks to batch helpers [skip-bc] (#4030)

5.10.2

chore(javascript): update release script (#4022)
fix(specs): results in getObjects is required (#4024)

5.10.1

fix(javascript): common package types (#4015)

5.10.0

feat(javascript): assert algoliasearch bundle (#3991)
fix(javascript): do not publish ts (#4009)
chore(deps): dependencies 2024-10-21 (#3992)
fix(javascript): use unknown over any (#4011)
docs(analytics): constrain pagination only to limit query parameter (#4012)
chore(javascript): build algoliasearch everytime (#4013)

5.9.1

fix(javascript): missing search dependency (#3988)

5.9.0

fix(javascript): do not publish ts (#3966)
fix(specs): Typo tolernace on words (#3968)
feat(javascript): add every APIs (#3942)
fix(specs): Add context to hitsPerPage (#3969)
chore(deps): dependencies 2024-10-14 (#3944)
fix(specs): alternativesAsExact is plurals and synonyms (#3974)
fix(specs): Separators are non-alphanumeric characters (#3978)
fix(specs): multiple clients fixes (#3971)

5.8.1

fix(specs): Typos in API descriptions (#3932)
fix(specs): use the read transporter for browse (#3938)
chore: apply codacy fixes (#3935)
fix(specs): correct type for banners [skip-bc] (#3939)

5.8.0

fix(specs): update analytics and abtesting max pagination query limit (#3696)
feat(specs): add support for widgets / banners in search for the csharp client (#3870)
fix(specs): correct typos is Search API (#3898)
chore(deps): dependencies 2024-10-07 (#3876)
fix(javascript): node 14 compatibility (#3897)
chore(javascript): use oxlint (#3895)
chore: revert and fix release (#3922)

5.7.0

chore(clients): add workflow to auto-close PR (#3834)
fix(specs): API key description will be obfuscated (#3840)
feat(specs): add recommend batch rules endpoint (#3782)
chore(deps): dependencies 2024-09-30 (#3842)

5.6.1

chore(javascript): update READMEs (#3829)
fix(specs): correct query params for ingestion [skip-bc] (#3830)

5.6.0

chore(deps): dependencies 2024-09-23 (#3790)
feat(javascript): add logger-console package from v4 (#3823)

5.5.3

fix(javascript): add override to name property (#3785)

5.5.2

fix(specs): recommend remove unsupported query parameters [RECO-2345] [skip-bc] (#3692)
fix(specs): remove models from ingestion specs [skip-bc] (#3774)

5.5.1

fix(javascript): react-native lite resolution (#3771)

5.5.0

feat(javascript): add react-native field in package.json (#3767)

5.4.3

fix(specs): update search api specs [skip-bc] (#3760)
chore(deps): dependencies 2024-09-16 [skip-bc] (#3704)

5.4.2

fix(javascript): umd export name (#3701)

5.4.1

fix(specs): remove usage [skip-bc] (#3691)
chore: assert node helpers (#3689)
feat(specs): add (optional) _automaticInsights to search result (#3688)

5.4.0

feat(javascript): add requester-testing package (#3684)
feat(javascript): add worker exports (#3680)

5.3.2

fix(javascript): use transporter directly (#3682)

5.3.1

fix(javascript): assert helpers and fix setClientApiKey helper (#3663)

5.3.0

fix(javascript): type definition and template cleanup (#3656)
feat(clients): helper to switch API key in use (#3616)
fix(specs): note on Analytics API server (#3650)
feat(clients): add helper to check if an index exists (#3646)
fix(specs): note on insights API server (#3649)
fix(specs): don’t extend $ref objects (#3623)

5.2.5

chore(javascript): use tsup bundler (#3640)
fix(specs): usage api (#3624)
fix(specs): no links across API specs (#3643)

5.2.4

fix(specs): ignorePlurals can be a boolean string (#3620)
fix(clients): correly parse usage hosts (#3622)

5.2.3

fix(specs): ingestion push task payload [skip-bc] (#3607)

5.2.2

fix(javascript): dependency imports and low-level init (#3596)
chore(javascript): add license to the root of the repo (#3610)
fix(javascript): prefix with node: for node packages (#3608)

5.2.1

fix(specs): partial update operation (#3486)

5.2.0

feat(specs): push source type (#3600)
fix(specs): filter run list by type (#3577)
docs(specs): update api’s length minimum value (#3574)

5.1.1

fix(clients): highlight and snippet results e2e (#3567)
fix(specs): another wrong link (#3570)
chore(specs): breaking change method names mapping table (#3568)
fix(javascript): exports type field (#3569)
fix(clients): mention main branch instead of master (#3566)
fix(specs): broken link (#3559)

5.1.0

feat(javascript): add search wrappers to lite client (#3556)
feat(specs): add /schedule endpoint (#3350)

5.0.2

chore(specs): update rendered title for search params (#3553)

5.0.1

fix(specs): delete user token processing time (#3525)

5.0.0

New major version released! Browse our documentation

fix(specs): required ingestion search params (#3516)

5.0.0-beta.18

feat(specs): recursive snippets and highlights result (#3497)

5.0.0-beta.17

feat(specs): add authentications to ingestion transformations (#3494)

5.0.0-beta.16

feat(specs): add generate code endpoint to ingestion specs (#3489)
fix(specs): ingestion docker task input (#3488)
fix(specs): ingestion search endpoint (#3487)

5.0.0-beta.15

feat(specs): add transformation copilot to ingestion (#3479)
fix(specs): ingestion destination reject indexPrefix (#3478)
fix(specs): ingestion destinations and transformations (#3477)
fix(clients): move the license to the root (#3457)
fix(specs): dictionary entry for stopwords has type property (#3456)
fix(specs): body is not required in multiple batch request (#3454)
feat(specs): add runSource endpoint (#3453)
chore(clients): remove mention of GA (#3452)

5.0.0-beta.14

fix(specs): built-in ops accept also int (#3450)
fix(specs): required prop for dictionaryEntry (#3449)
feat(clients): delete unused models (#3445)
fix(specs): proper title with linter (#3444)
fix(specs): getObject return object (#3446)
fix(specs): clarify decompounding limitations (#3227)

5.0.0-beta.13

feat(specs): add v2 endpoints for ingestion (#3416)
fix(specs): add primary to get settings response (#3415)
chore(specs): add eslint rule to avoid cross-references (#3413)
fix(specs): remove cross-references of analytics (#3414)
feat(specs): add v2 endpoints for ingestion (#3410)
fix(specs): remove cross-specs references (#3412)

5.0.0-beta.12

fix(specs): update shopify feature flags (#3380)
feat(clients): add api key helper test (#3338)
fix(specs): recommend non required parameters (#3355)
fix(specs): results is required in GetRecommendationsResponse (#3357)

5.0.0-beta.11

fix(specs): browse response required properties (#3348)
fix(specs): ingestion task and transformation (#3347)
fix(specs): clarify browse parameters (#3333)

5.0.0-beta.10

chore(javascript): nx cache lock (#3327)

5.0.0-beta.9

feat(specs): add redirect to renderingContent (#3296)

5.0.0-beta.8

fix(clients): update ingestion transformations description and fix taggroups (#3265)

5.0.0-beta.7

feat(clients): generate common LICENSE (#3258)
fix(clients): update README snippets and contributing guides (#3257)
feat(clients): add saveObjects, deleteObjects and partialUpdateObjects helpers (#3180)
fix(specs): virtual is a fetchedIndex props (#3255)
fix(specs): add virtual index settings and update renderingContent (#3254)
fix(clients): chunked batch helper size property consistency (#3253)

5.0.0-beta.6

feat(javascript): legacy getRecommendations signature (#3241)
feat(clients): add recommend to algoliasearch (#2860)
fix(javascript): deprecated publish options (#3220)

5.0.0-beta.5

feat(specs): add transformations endpoints to ingestion (#3215)
fix(specs): update discover endpoint (#3212)
feat(specs): add validate endpoint (#3087)
chore(clients): use the ruff python formatter (#3204)
fix(clients): reduce common tests flakyness (#3205)
feat(clients): add chunkedBatch helper for Kotlin and Scala (#3206)
feat(clients): add generateSecuredApiKey to java (#3167)

5.0.0-beta.4

feat(clients): add generate_secured_api_key to ruby (#3166)
fix(clients): safer replaceAllObjects + metis compliant (#3164)

5.0.0-beta.3

fix(clients): remove unused models from lite clients (#3159)
feat(clients): add waitForAppTask helper (#3158)
fix(clients): chunked batch helper (#3154)
fix(specs): rankingInfo required properties (#3157)
feat(specs): add getAppTask endpoint to search (#3156)
fix(specs): dont mention index api keys (#3117)

5.0.0-beta.2

fix(specs): exhaustiveFacetsCount is not deprecated for sffv (#3089)
fix(specs): simplify filter types (#3042)

5.0.0-beta.1

feat(specs): promote @kai687 to code owner (#3014)
fix(specs): remove periods on summaries (#3013)

5.0.0-alpha.114

feat(javascript): allow custom connect timeout (#3010)
fix(specs): attribute and index names case sensitive (#2990)
feat(specs): update shopify source and task inputs (#2987)
fix(specs): Personalization API (#2982)
fix(specs): a/b testing (#2981)

5.0.0-alpha.113

fix(specs): recommend api (#2958)
fix(specs): update documentation for consistency (#2976)
feat(clients): add usage client (#2960)
feat(specs): add algoliaInsights auth type (#2959)
fix(specs): usage api (#2954)
fix(specs): crawler api (#2949)

5.0.0-alpha.112

fix(specs): query suggestions api (#2924)
fix(specs): ingestion api reference (#2918)
fix(javascript): extra parameter in jsdoc def (#2933)

5.0.0-alpha.111

chore(javascript): assert authMode (#2897)
fix(specs): more flexible custom methods (#2889)

5.0.0-alpha.110

fix(specs): make languages an enum (#2865)

5.0.0-alpha.109

feat(specs): insights api reference (#2859)
feat(specs): add ga4BigqueryExport, streaming and append options to task inputs (#2858)
feat(specs): improve API reference documentation (#2831)

5.0.0-alpha.108

feat(specs): Add MappingInput to Task Inputs (#2787)
fix(javascript): use correct vendor values (#2829)

5.0.0-alpha.107

fix(javascript): move node related helpers at node bundle level (#2807)

5.0.0-alpha.106

fix(specs): add queryID to search response (#2801)
chore(specs): remove JSON specs and new worlds logic (#2794)

5.0.0-alpha.105

fix(specs): add missing attributes for CT Source update (#2792)
chore(javascript): assert replaceAllObjects (#2790)
fix(javascript): allow batchSize on ReplaceAllObjectsOptions (#2788)
feat(javascript): add replaceAllObjects (#2768)
chore(javascript): broken tests (#2767)
feat(javascript): add getSecuredApiKey and validity check (#2766)
fix(clients): replace all objects (#2762)
fix(clients): browse synonyms page not in response (#2757)

5.0.0-alpha.104

fix(specs): allow custom fields to be nullable (#2746)

5.0.0-alpha.103

feat(specs): add CustomFields to CT Source Input (#2742)
fix(clients): add e2e tests for analytics API (#2737)

5.0.0-alpha.102

docs(clients): add ACL section to code doc (#2576)

5.0.0-alpha.101

feat(specs): update query suggestions unauthorized response example (#2606)
feat(specs): add acls to API endpoints (#2604)

5.0.0-alpha.100

fix(specs): correct searchSynonyms parameters (#2595)
feat(specs): import crawler and usage specs from new world repo (#2598)
feat(specs): AB testing tracked user count (#2596)
fix(clients): support the rest of the languages (#2571)
fix(clients): monitoring for JavaScript and Python (#2568)
feat(specs): add acl permissions to operations (#2555)
fix(specs): rename clearAllSynonyms to clearSynonyms (#2553)

5.0.0-alpha.99

fix(javascript): lock (#2548)

5.0.0-alpha.98

feat(specs): update Insights API spec (#2376)
chore(clients): provide snippets for all languages (#2518)
feat(clients): generate code snippets from cts (#2511)

5.0.0-alpha.97

feat(clients): deserialize in e2e and SFFV response (#2500)
chore(clients): add more e2e (#2497)

5.0.0-alpha.96

feat(clients): add missing clients (#2479)

5.0.0-alpha.95

fix(specs): port recommend changes (#2476)
feat(javascript): add cache TTL and fix support message (#2474)

5.0.0-alpha.94

chore(javascript): remove some non needed props from generators (#2412)
fix(specs): provide non clashing names for custom methods (#2369)
fix(specs): highlight result map definition (#2312)

5.0.0-alpha.93

chore(specs): publish docs specs (#2255)
feat(specs): add startDate and endDate query parameter to list events (#2229)
fix(specs): require window in list runs (#2226)

5.0.0-alpha.92

feat(specs): add window parameter to observability responses (#2223)
chore(specs): lint —fix on pre-commit (#2224)

5.0.0-alpha.91

chore(specs): remove unused spec file (#2186)
fix(javascript): algoliaseach bundling (#2185)
revert(specs): insights identify (#2182)
feat(specs): add authenticatedUserToken and Identify to insights (#2151)

5.0.0-alpha.90

fix(specs): Change trigger input for task update (#2147)
feat(javascript): add searchForHits and searchForFacets helpers (#2138)
feat(specs): Add failureThreshold to Task and TaskUpdate types (#2144)
fix(specs): remove duplicate objectID (#2113)

5.0.0-alpha.89

feat(specs): revenue and filterEffects typing updates (#2105)

5.0.0-alpha.88

fix(javascript): release process (#2106)

5.0.0-alpha.87

feat(specs): synchronize specs for all client (#2103)
feat(javascript): add discover handlers to source model (#2096)
feat(javascript): handle run discover type (#2101)
fix(specs): search insideBoundingBox type (#2098)
feat(specs): add new events type for insights (#2080)
feat(specs): Remove attributeForDistinct from the indexSettingsAsSearc… (#2078)

5.0.0-alpha.86

feat(specs): add attributesToExclude for Ingestion (#2053)
fix(specs): userData type as ‘any’ (#2033)

5.0.0-alpha.85

feat(javascript): add partial task action type (#2034)

5.0.0-alpha.84

feat(javascript): add batchSize to the observability event object (#2029)

5.0.0-alpha.83

fix(specs): exhaustiveNbHits as optional (#2007)
fix(specs): introduced SourceUpdateDocker (#2005)
fix(specs): add ‘critical’ event status to enum (#2006)
fix(clients): userToken max length (#2004)
fix(clients): user token character limit (#2003)

5.0.0-alpha.82

feat(specs): add recordType and fallbackIsInStockValue in inputs (#1988)
feat(javascript): remove unused property (#1987)
feat(specs): add inference ACL to API key object (#1985)
feat(specs): add failureThreshold to Ingestion API (#1962)
feat(specs): update ingestion specs for BigCommerce (#1961)

5.0.0-alpha.81

chore(clients): dependency upgrade (#1940)

5.0.0-alpha.80

fix(specs): remove some parameters from trending requests (#1915)

5.0.0-alpha.79

fix(javascript): move cjs.js to cjs (#1894)
fix(specs): mixed SearchParams and IndexSettings (#1889)

5.0.0-alpha.77

fix(specs): allow JSON array for aroundPrecision (#1855)
fix(specs): optional/required query and params (#1864)
feat(specs): delete Predict (#1860)

5.0.0-alpha.76

fix(specs): allow partial input update for authentications (#1856)
fix(specs): search w/ hits & facets responses (#1774)

5.0.0-alpha.75

fix(javascript): publish script esm (#1787)

5.0.0-alpha.74

feat(specs): query suggestions (#1740)
feat(specs): Review OpenAPI common specs (#1692)
fix(javascript): allow package.json to be pushed (#1781)
fix(javascript): release process (#1779)
feat(specs): add OpenAPI spec for Monitoring API (#1683)
fix(specs): facet stats properties as double (#1694)
fix(specs): add input to authentication list (#1688)

5.0.0-alpha.73

feat(specs): updated_at removed from Run response (#1651)
feat(specs): add new outlier count properties to variant payload (#1656)
docs(specs): review Insights API spec (#1647)

5.0.0-alpha.72

fix(specs): change github container registry name (#1641)

5.0.0-alpha.71

fix(specs): change github container registry name (#1641)

5.0.0-alpha.70

fix(specs): add blocking to reasonCode instead of outcome (#1622)

5.0.0-alpha.69

fix(specs): add blocking run outcome (#1619)

5.0.0-alpha.68

feat(specs): add startDate and endDate parameters to Ingestion API (#1614)
fix(specs): add processing run outcome (#1613)
fix(javascript): waitForApiKey helper (#1598)

5.0.0-alpha.67

fix(specs): add docker source input (#1594)

5.0.0-alpha.66

feat(specs): add objectID to BQ source input (#1575)

5.0.0-alpha.65

feat(specs): ingestion partial update method changed to patch (#1564)

5.0.0-alpha.64

feat(specs): add task input for bigquery (#1549)

5.0.0-alpha.63

feat(specs): add property to BigQuery source input (#1547)

5.0.0-alpha.62

feat(specs): add property to BigQuery source input (#1547)

5.0.0-alpha.61

feat(specs): add reason code to run outcome (#1531)
feat(clients): add Kotlin API client (#1400)
fix(specs): remove unsupported delete option for task action type (#1511)

5.0.0-alpha.60

fix(specs): update required for kotlin tests to pass (#1492)
feat(clients): add bigquery to sourceTypes enum (#1490)

5.0.0-alpha.59

feat(specs): add predict segment size to responses [PRED-1277] (#1478)
feat(specs): add neuralSearch options (#1474)
fix(javascript): remove mode from Fetch requester (#1475)

5.0.0-alpha.58

feat(specs): add size to predict segment response (#1434)
fix(specs): add input in GET tasks (#1472)
fix(specs): add transform event type (#1470)
fix(specs): task trigger guard import order (#1459)

5.0.0-alpha.57

fix(specs): task trigger guard import (#1458)
fix(specs): task trigger guard update (#1457)

5.0.0-alpha.56

feat(specs): add delimiter option for csv source (#1445)

5.0.0-alpha.55

feat(specs): add lastUpdatedAt field to predict segments (#1431)

5.0.0-alpha.54

fix(specs): add customRequest to ingestion and small fix (#1418)
fix(specs): update BigCommerce source payload (#1416)

5.0.0-alpha.53

feat(specs): add new BigCommerce source fields (#1387)
feat(specs): make the eu region available for the ingestion client (#1396)
feat(specs): update affinity value type to accomodate booleans and numbers (#1388)

5.0.0-alpha.52

fix(specs): authenticationID not required in source and destination (#1379)

5.0.0-alpha.51

fix(specs): add skipped runs (#1359)
feat(clients): upgrade to node 18 (#1344)

5.0.0-alpha.50

feat(specs): add a reason string to the run object (#1347)

5.0.0-alpha.49

fix(specs): add pagination to events (#1337)

5.0.0-alpha.48

fix(specs): add UniqueIDColumn property to SourceJSON input (#1333)

5.0.0-alpha.47

fix(specs): update Predict Segment operators to textual format (#1316)

5.0.0-alpha.46

feat(specs): make DELETE endpoints return a 200 OK (#1314)
fix(specs): remove segment version (#1313)

5.0.0-alpha.45

refactor(specs): new predict segment condition syntax (#1202)
feat(specs): remove content attributes from models [PRED-982] (#1226)

5.0.0-alpha.44

feat(specs): add sort and order handling in query parameters (#1304)

5.0.0-alpha.43

feat(specs): add CSV source (#1301)

5.0.0-alpha.42

fix(specs): rename task type to onDemand (#1299)
feat(javascript): export task trigger guards from each build entrypoints (#1289)

5.0.0-alpha.41

feat(javascript): improve on task trigger type guards (#1286)

5.0.0-alpha.40

feat(javascript): add task trigger type guards (#1280)
fix(specs): correct types for Tasks trigger (#1279)

5.0.0-alpha.39

feat(specs): add more descriptions to the Ingestion API (#1273)
fix(specs): add query params for observability (#1277)
feat(specs): source update changes (#1276)

5.0.0-alpha.38

feat(specs): add search endpoint to every item type (#1274)

5.0.0-alpha.37

feat(specs): add sourceID query param to task list endpoint (#1250)

5.0.0-alpha.36

chore(specs): change PlatformType naming to Platform (#1246)
feat(specs): add query param to filter list endpoint results (#1245)

5.0.0-alpha.35

fix(specs): fix method for task enable/disable status (#1242)

5.0.0-alpha.34

feat(javascript): add error to APIError if possible (#1234)

5.0.0-alpha.33

feat(specs): add query params to task lists endpoint in Ingestion APIC (#1233)

5.0.0-alpha.32

fix(specs): remove input from auth list (#1229)
fix(specs): authenticationID is not required in source and destination (#1203)
fix(specs): move lastRun and nextRun to task.trigger (#1228)
fix(specs): make enabled nullable (#1212)

5.0.0-alpha.31

fix(specs): numberOfPendingTasks is plural (#1211)
fix(specs): example should be integer (#1210)

5.0.0-alpha.30

feat(specs): add source json to ingestion client (#1200)

5.0.0-alpha.29

fix(javascript): update ingestion specs (#1192)
fix(javascript): pass with no tests (#1191)
fix(specs): new CT source input (#1190)
fix(specs): Algolia Search hostnames (#1189)

5.0.0-alpha.28

fix(clients): replace sources client with ingestion (#1178)
feat(javascript): create ingestion client (#1101)
fix(specs): mistakes in the ingestion spec (#1176)
feat(specs): create ingestion specs (#1100)

5.0.0-alpha.27

feat(specs): add appropriate type to model instance type property (#1077)

5.0.0-alpha.26

feat(specs): add modelID as part of getModelMetrics response (#1075)

5.0.0-alpha.25

feat(specs): attributes no longer required in model instance response (#1065)

5.0.0-alpha.24

fix(specs): update predict model endpoint modelAttributes type (#1063)

5.0.0-alpha.23

chore(specs): setup revised predict model spec (#1045)

5.0.0-alpha.22

fix(specs): update model response (#1034)

5.0.0-alpha.21

fix(specs): prefix Predict predictions success types (#1032)

5.0.0-alpha.20

feat(specs): predict segments (#1013)
feat(specs): deleteByParams (#1016)

5.0.0-alpha.19

feat(specs): predict model endpoints (#1014)

5.0.0-alpha.18

feat(specs): update predict client API URL (#1010)

5.0.0-alpha.17

fix(specs): remove unretrievableAttributes from searchParams (#988)

5.0.0-alpha.16

fix(javascript): fix funnel stage type casing (#982)

5.0.0-alpha.15

fix(javascript): update Predict models error spec (#980)
feat(specs): create new methods (#974)

5.0.0-alpha.14

fix(javascript): encode query parameters (#973)

5.0.0-alpha.13

fix(javascript): update Predict type exports (#953)

5.0.0-alpha.12

fix(javascript): revert: do not send user-agent for Predict (#957) (#919)

5.0.0-alpha.11

fix(javascript): use exports field to pick correct bundle (#947)

5.0.0-alpha.10

fix(javascript): allow undefined object when all parameters are optional (#922)

5.0.0-alpha.9

fix(javascript): do not send user-agent for Predict (#919)

5.0.0-alpha.8

fix(clients): list available regions when region is missing (#916)
fix(specs): make batch body parameters required (#917)
fix(javascript): build (#867)

5.0.0-alpha.7

fix(specs): allow searchParams in browse method (#911)

5.0.0-alpha.6

fix(specs): browseResponse, IndexSettings and searchResponse (#900)
fix(javascript): utils tests run time (#908)

5.0.0-alpha.5

fix(specs): wrong body parameter name (#896)
fix(javascript): helpers type options (#895)

5.0.0-alpha.4

fix(specs): getApiKeyResponse, multipleBatch, partialUpdateObject (#889)
fix(javascript): make type filename consistent (#890)
fix(javascript): expose clearCache and appId at the root of the client (#892)
feat(javascript): provide browseObjects, browseRules and browseSynonyms helper methods (#887)

5.0.0-alpha.3

fix(javascript): provide more options to algoliasearch (#877)
fix(specs): rules and objects parameters/responses (#876)

5.0.0-alpha.2

fix(javascript): expose sub algoliasearch client’s type (#873)
feat(javascript): allow providing options for node requester (#872)
fix(specs): make hits required, facets count as an integer, searchParams as optional (#868)

5.0.0-alpha.1

feat(javascript): support generic for hits (#854)
feat(javascript): add requester-fetch (#855)
fix(javascript): ensure requesters work as in v4 (#823)
fix(clients): make POST body related to the endpoint, assert body in tests (#849)
fix(specs): wrong parameters for searchSynonyms (#852)
fix(clients): add generation banner to generated files (#816)
feat(javascript): expose transporter, remove nullish coalescing and optional chaining (#799)
fix(javascript): provide requestOptions to helper methods (#797)
fix(javascript): rename predict package (#796)
feat(javascript): use @algolia NPM namespace (#785)
fix(specs): add renderingContent to search response (#787)
feat(javascript): add abtesting client, better init usage (#784)
fix(specs): correct type for highlightResult and snippetResult (#783)
fix(specs): fix missing params and types (#772)
feat(specs): Add tags to the settings and search params (#768)
fix(javascript): add class-proposal plugin for client-common (#765)
fix(specs): correct type for highlightResult and snippetResult (#783)
fix(specs): fix missing params and types (#772)
feat(specs): Add tags to the settings and search params (#768)
fix(javascript): add class-proposal plugin for client-common (#765)
fix(javascript): improve bundlesize, add check to CI (#762)
fix(specs): correct type for renderingContent and consequenceParams (#759)
feat(javascript): add waitForApiKey helper method (#738)
fix(javascript): import lite resolution (#737)
fix(javascript): publish algoliasearch dist (#735)
feat(javascript): nest lite package in algoliasearch (#729)
fix(specs): correct type for typoTolerance (#722)
fix(specs): types and parameters (#708)
fix(javascript): export types for algoliasearch (#706)
fix(javascript): clean rollup config (#700)
feat(javascript): allow legacy signature for search method (#665)
test(clients): test more region param and timeouts (#663)
fix(clients): rename maxTrial to maxRetries (#659)
fix(javascript): remove duplicate echoRequester logic (#650)
fix(javascript): remove duplicate types, add some type descriptions (#644)
fix(javascript): convert timeouts to ms APIC-512 (#643)
fix(specs): rename rules and synonyms methods (#642)
fix(javascript): remove factory from build (#639)
fix(javascript): check that appId, apiKey and region are valid parameters (#622)
feat(javascript): allow overriding all transporter options (#615)
refactor(javascript): simplify transporter.request (#617)
fix(javascript): rename timedout and timeouted to timed out (#616)
feat(javascript): use the text/plain content-type (#614)
fix(javascript): enable cache (#612)
fix(javascript): cache on POST read request (#611)
fix(specs): correctly pass searchParams to the request (#531)
refactor(javascript): type setTimeout in a way compatible with node & browser (#527)
fix(specs): allow POST methods to send read requests (#525)
fix(javascript): remove unused methods of algoliasearch-lite (#524)
feat(javascript): add waitForTask in search client (#510)
fix(specs): rename search method (#514)
fix(specs): correct mistakes (#509)
style(specs): add out-of-line-one-of rule (and allOf and anyOf) APIC-418 (#512)
fix(specs): correct type for taskID APIC-478 (#504)
fix(javascript): move logic to custom gens (#486)
fix(javascript): update version (#448)
fix(javascript): add missing descriptions (#416)
chore(javascript): fix npm publish issue (#409)
chore(javascript): run lerna exec with double-dash to pass dashed flags to the spanwed command (#391)
chore(javascript): split build task to avoid memory issue (#383)
chore(javascript): build util packages first when building all (#371)
feat(javascript): provide lite package (#354)
chore(javascript): fix ts-node issue (#368)
fix(javascript): handle parent in models (#339)
fix(javascript): update template to include correct dependency version (#328)
chore(javascript): remove dependency to openapitools.json at rollup (#323)
chore(javascript): add yarn.lock on release process (#314)
fix(javascript): keep comments and jsdoc in build (#307)
feat(javascript): expose requestOptions and cache options (#283)
feat(javascript): use responses and requests cache (#281)
feat(javascript): add cache layer (#274)
fix(javascript): engine support node > 14 (#260)
feat(javascript): expose models (#252)
feat(javascript): upgrade to bundlesize 2 (#243)
fix(javascript): use package version in rollup (#232)
feat(javascript): use beta npm org (#226)
fix(javascript): use babel plugin for classProperties (#222)
feat(javascript): provide algoliasearch package (#158)
feat(javascript): remove classes usage (#156)
feat(javascript): add addUserAgent method (#154)
fix(javascript): utils build and cache (#147)
feat(javascript): bundle CJS, ESM and UMD (#135)
fix(javascript): prevent conflict with version variable (#141)
feat(javascript): monorepo (#131)
fix(javascript): auth via query parameters (#124)
fix(javascript): node timeouts (#123)
feat(javascript): add browser xhr requester (#115)
feat(clients): retrieve hosts from spec file (#111)
feat(specs): improve consistency and naming (#96)
feat(specs): add servers (#98)
feat(specs): bundle specs (#91)
feat(specs): add abtesting specs and client (#76)
feat(specs): add objects endpoints (#54)
feat(specs): improve specs consistency (#51)
feat(specs): add search endpoints (#50)
feat(specs): add dictionary specs (#49)
feat(specs): search advanced endpoints APIC-197 (#40)
feat(specs): add analytics specs and client. (#36)
feat(specs): add personalizaton spec and client (#27)
feat(specs): add recommend spec and client (#19)
feat(specs): add settings spec (#17)
fix(specs): correctly pass searchParams to the request (#531)
refactor(javascript): type setTimeout in a way compatible with node & browser (#527)
fix(specs): allow POST methods to send read requests (#525)
fix(javascript): remove unused methods of algoliasearch-lite (#524)
feat(javascript): add waitForTask in search client (#510)
fix(specs): rename search method (#514)
fix(specs): correct mistakes (#509)
style(specs): add out-of-line-one-of rule (and allOf and anyOf) APIC-418 (#512)
fix(specs): correct type for taskID APIC-478 (#504)
fix(javascript): move logic to custom gens (#486)
fix(spec): predict server (#441)
chore: use Client suffix (#386)
fix(javascript): update version (#448)
fix(javascript): add missing descriptions (#416)
chore(javascript): fix npm publish issue (#409)

API clients (current)

Clients and methods