@contentful/optimization-api-client 1.1.1 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://www.contentful.com/developers/docs/personalization/">
-    <img alt="Contentful Logo" title="Contentful" src="https://raw.githubusercontent.com/contentful/optimization/optimization-api-client-v1.1.1/contentful-icon.png" width="150">
+    <img alt="Contentful Logo" title="Contentful" src="https://raw.githubusercontent.com/contentful/optimization/optimization-api-client-v2.0.0/contentful-icon.png" width="150">
   </a>
 </p>
 
@@ -11,7 +11,7 @@
 <div align="center">
 
 [Guides](https://contentful.github.io/optimization/documents/Documentation.Guides.html) ·
-[Reference](https://contentful.github.io/optimization) · [Contributing](https://github.com/contentful/optimization/blob/optimization-api-client-v1.1.1/CONTRIBUTING.md)
+[Reference](https://contentful.github.io/optimization) · [Contributing](https://github.com/contentful/optimization/blob/optimization-api-client-v2.0.0/CONTRIBUTING.md)
 
 </div>
 
@@ -23,6 +23,12 @@ We recommend starting applications with Web, React Web, Node, or React Native SD
 directly when building or maintaining SDK layers, tests, tooling, or first-party integrations that
 need raw API access.
 
+> [!IMPORTANT]
+>
+> Upgrading from v1? Follow the
+> [v1-to-v2 migration guide](https://contentful.github.io/optimization/documents/Documentation.Guides.migrating-optimization-sdk-packages-from-v1-to-v2.html)
+> before changing package versions or route-dependent infrastructure.
+
 <details>
   <summary>Table of Contents</summary>
 <!-- mtoc-start -->
@@ -33,6 +39,7 @@ need raw API access.
 - [API surface](#api-surface)
   - [Experience API](#experience-api)
   - [Insights API](#insights-api)
+  - [Schema entry point](#schema-entry-point)
   - [Fetch helpers](#fetch-helpers)
 - [Related](#related)
 
@@ -54,8 +61,8 @@ preferred:
 import { ApiClient } from '@contentful/optimization-api-client'
 
 const client = new ApiClient({
-  clientId: 'your-client-id',
-  environment: 'main',
+  spaceId: 'your-space-id',
+  environment: 'master',
 })
 ```
 
@@ -67,13 +74,13 @@ state, consent handling, event builders, entry resolution, tracking, or platform
 
 ## Common configuration
 
-| Option         | Required? | Default                      | Description                                                 |
-| -------------- | --------- | ---------------------------- | ----------------------------------------------------------- |
-| `clientId`     | Yes       | N/A                          | Shared API key for Experience API and Insights API requests |
-| `environment`  | No        | `'main'`                     | Contentful environment identifier                           |
-| `experience`   | No        | See Experience options below | Experience API endpoint and default request options         |
-| `insights`     | No        | See Insights options below   | Insights API endpoint options                               |
-| `fetchOptions` | No        | SDK defaults                 | Fetch timeout and retry behavior                            |
+| Option         | Required? | Default                      | Description                                                              |
+| -------------- | --------- | ---------------------------- | ------------------------------------------------------------------------ |
+| `spaceId`      | Yes       | N/A                          | Contentful Space identifier for Experience and Insights API requests     |
+| `environment`  | No        | `'master'`                   | Contentful space environment identifier for Experience and Insights APIs |
+| `experience`   | No        | See Experience options below | Experience API endpoint and default request options                      |
+| `insights`     | No        | See Insights options below   | Insights API endpoint options                                            |
+| `fetchOptions` | No        | SDK defaults                 | Fetch timeout and retry behavior                                         |
 
 Common Experience API options:
 
@@ -147,6 +154,20 @@ await client.insights.sendBatchEvents([
 Insights endpoints do not return response data. For last-chance browser lifecycle delivery, pass a
 per-call `beacon` sender that receives the request URL and already serialized body.
 
+### Schema entry point
+
+`@contentful/optimization-api-client/api-schemas` owns the Experience API and Insights API runtime
+validation schemas, inferred types, and validation helpers used by this client. Import those
+contracts from that entry point when building SDK layers, tooling, or tests:
+
+```ts
+import { ExperienceResponse } from '@contentful/optimization-api-client/api-schemas'
+```
+
+This entry point does not include Contentful CDA schemas. Import CDA schemas from
+`@contentful/optimization-core/api-schemas` instead. That Core entry point also provides an
+aggregate schema surface for SDK layers that need both CDA and API contracts.
+
 ### Fetch helpers
 
 This package also exports fetch helper functions used by SDK layers:
@@ -163,8 +184,9 @@ Use generated reference docs for helper signatures and callback payloads.
 
 - [API Client generated reference](https://contentful.github.io/optimization/modules/_contentful_optimization-api-client.html) -
   exported API reference
-- [API Schemas](https://github.com/contentful/optimization/blob/optimization-api-client-v1.1.1/packages/universal/api-schemas/README.md) - runtime validation schemas and inferred API types
-- [Optimization Core SDK](https://github.com/contentful/optimization/blob/optimization-api-client-v1.1.1/packages/universal/core-sdk/README.md) - platform-agnostic SDK layer that composes this
-  client
+- [Optimization Core SDK](https://github.com/contentful/optimization/blob/optimization-api-client-v2.0.0/packages/universal/core-sdk/README.md) - platform-agnostic SDK layer that composes this
+  client and owns CDA schemas through its `/api-schemas` entry point
+- [API Schemas](https://github.com/contentful/optimization/blob/optimization-api-client-v2.0.0/packages/universal/api-schemas/README.md) - deprecated compatibility facade and import migration
+  guidance
 - [Choosing the right SDK](https://contentful.github.io/optimization/documents/Documentation.Guides.choosing-the-right-sdk.html) -
   package selection guidance for application integrations