sizebay-core-sdk 1.10.0-dev.3 → 1.10.0-dev.4

package/README.md

@@ -111,13 +111,11 @@ Fetch products similar to a reference.
 
 <!-- DOCGEN:returns GetSimilarProductsResponse -->
 > **`GetSimilarProductsResponse`**
-> * `data`: `ProductDto[]` — An array of products that are visually similar to the reference item.
-The results are ordered by their similarity score.
+> * `data`: `ProductDto[]` — An array of products that are visually similar to the reference item.<br>The results are ordered by their similarity score.
 > * `page`: `number` — The current page number of the results.
 > * `perPage`: `number` — The number of items per page.
 > * `total`: `number` — The total number of similar products found.
-> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or expired,
-which may affect personalized results.
+> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or expired,<br>which may affect personalized results.
 <!-- /DOCGEN -->
 
 #### Example
@@ -147,10 +145,8 @@ Retrieve pairs of complementary products.
 <!-- DOCGEN:params GetComplementaryProductsParams -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `permalink` | string |  Yes  | The URL permalink of the reference product.
-Its style, color, and category are used to find matching items. |
-| `similarityThreshold` | number |  Yes  | The minimum similarity score (0-1) for recommended products.
-A higher value yields more similar items, while a lower value provides more variety. |
+| `permalink` | string |  Yes  | The URL permalink of the reference product.<br>Its style, color, and category are used to find matching items. |
+| `similarityThreshold` | number |  Yes  | The minimum similarity score (0-1) for recommended products.<br>A higher value yields more similar items, while a lower value provides more variety. |
 | `tenantId` | number |  Yes  | Tenant (client) ID. |
 | `collectionName` | string |  Yes  | Embeddings collection name (namespace). |
 | `sid` | string |  Yes  | Session identifier (`sid`) for the user. |
@@ -165,11 +161,9 @@ A higher value yields more similar items, while a lower value provides more vari
 
 <!-- DOCGEN:returns GetComplementaryProductsResponse -->
 > **`GetComplementaryProductsResponse`**
-> * `baseProduct`: `ProductDto` — The reference product used to generate recommendations.
-This is the item that corresponds to the permalink from the request.
+> * `baseProduct`: `ProductDto` — The reference product used to generate recommendations.<br>This is the item that corresponds to the permalink from the request.
 > * `complementary`: `ComplementaryPairDto[]` — A list of recommended pairs of products that are complementary to the base product.
-> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or has expired.
-If true, personalization may be affected.
+> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or has expired.<br>If true, personalization may be affected.
 <!-- /DOCGEN -->
 
 #### Example
@@ -342,34 +336,20 @@ Sends user profile data. Uses cached `sid` if not provided.
 <!-- DOCGEN:params SessionProfilePayload -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `name` | string |  Yes  | Internal profile identifier or display name for the user.
-Typically used for analytics and user identification within Sizebay's system. |
-| `skinType` | number |  Yes  | Skin tone classification used for color matching and style recommendations.
-Numerical value representing different skin tone categories. |
-| `footShape` | string |  Yes  | Foot shape classification for footwear recommendations.
-Used to provide better shoe fit analysis when available. |
-| `gender` | string |  Yes  | User's gender for size system selection and fit calculations.
-Uses single character format as defined by Sizebay's standards. |
-| `age` | string |  Yes  | User's age for age-appropriate sizing and recommendations.
-Stored as string to accommodate various age formats. |
-| `is3dFeel` | boolean |  Yes  | Feature flag indicating if advanced 3D fit visualization is enabled.
-Affects the level of detail in size recommendations and fit analysis. |
-| `weight` | string |  Yes  | User's body weight in the unit system specified by isMetric.
-Used for comprehensive fit analysis and size calculations. |
-| `height` | string |  Yes  | User's height in the unit system specified by isMetric.
-Critical measurement for accurate size recommendations. |
+| `name` | string |  Yes  | Internal profile identifier or display name for the user.<br>Typically used for analytics and user identification within Sizebay's system. |
+| `skinType` | number |  Yes  | Skin tone classification used for color matching and style recommendations.<br>Numerical value representing different skin tone categories. |
+| `footShape` | string |  Yes  | Foot shape classification for footwear recommendations.<br>Used to provide better shoe fit analysis when available. |
+| `gender` | string |  Yes  | User's gender for size system selection and fit calculations.<br>Uses single character format as defined by Sizebay's standards. |
+| `age` | string |  Yes  | User's age for age-appropriate sizing and recommendations.<br>Stored as string to accommodate various age formats. |
+| `is3dFeel` | boolean |  Yes  | Feature flag indicating if advanced 3D fit visualization is enabled.<br>Affects the level of detail in size recommendations and fit analysis. |
+| `weight` | string |  Yes  | User's body weight in the unit system specified by isMetric.<br>Used for comprehensive fit analysis and size calculations. |
+| `height` | string |  Yes  | User's height in the unit system specified by isMetric.<br>Critical measurement for accurate size recommendations. |
 | `measures` | { insoleLength: number; poundWeight: number | null; } |  Yes  | Additional precise body measurements for enhanced fit accuracy. |
-| `product` | string |  Yes  | Product context or identifier related to the current profiling session.
-Can link the profile to a specific product being viewed. |
-| `isMetric` | boolean |  Yes  | Unit system preference for all measurements and recommendations.
-- true: Metric system (cm, kg)
-- false: Imperial system (inches, lbs) |
-| `bodyShapeChest` | number |  Yes  | Chest/bust body shape index for clothing fit analysis.
-Numerical value representing body proportions in the chest area. |
-| `bodyShapeHip` | number |  Yes  | Hip body shape index for lower body clothing fit analysis.
-Numerical value representing body proportions in the hip area. |
-| `bodyShapeWaist` | number |  Yes  | Waist body shape index for torso fit analysis.
-Numerical value representing body proportions in the waist area. |
+| `product` | string |  Yes  | Product context or identifier related to the current profiling session.<br>Can link the profile to a specific product being viewed. |
+| `isMetric` | boolean |  Yes  | Unit system preference for all measurements and recommendations.<br>- true: Metric system (cm, kg)<br>- false: Imperial system (inches, lbs) |
+| `bodyShapeChest` | number |  Yes  | Chest/bust body shape index for clothing fit analysis.<br>Numerical value representing body proportions in the chest area. |
+| `bodyShapeHip` | number |  Yes  | Hip body shape index for lower body clothing fit analysis.<br>Numerical value representing body proportions in the hip area. |
+| `bodyShapeWaist` | number |  Yes  | Waist body shape index for torso fit analysis.<br>Numerical value representing body proportions in the waist area. |
 <!-- /DOCGEN -->
 
 #### Example
@@ -421,8 +401,7 @@ await client.sendProfile(profilePayload);
 | `style` | string |  Yes  | The style classification of the product. |
 | `gtin` | string |  Yes  | The Global Trade Item Number (GTIN) for the product. |
 | `additionalImageLinks` | string[] |  Yes  | A list of additional image URLs for the product. |
-| `suitableSizes` | SuitableSizeDto[] |  No  | Size recommendations from Sizebay's What Fits Me feature, including comfort scores.
-This is populated when personalized sizing is available. |
+| `suitableSizes` | SuitableSizeDto[] |  No  | Size recommendations from Sizebay's What Fits Me feature, including comfort scores.<br>This is populated when personalized sizing is available. |
 | `clothType` | ClothType |  No  | The standardized clothing type, used for recommendations and size chart matching. |
 <!-- /DOCGEN -->
 
@@ -442,14 +421,9 @@ This is populated when personalized sizing is available. |
 <!-- DOCGEN:params SuitableSizeDto -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `size` | string |  Yes  | Size label as defined in the product catalog (e.g., "M", "42", "8-10").
-Uses the same format as the store's size system. |
-| `comfortable` | number |  Yes  | AI-calculated comfort score ranging from 0 to 1, where:
-- 0.0 = Very uncomfortable fit
-- 0.5 = Adequate fit
-- 1.0 = Perfect comfortable fit |
-| `value` | boolean |  No  | Boolean indicator of whether this size is considered suitable for the user.
-Based on comfort threshold and fit analysis algorithms. |
+| `size` | string |  Yes  | Size label as defined in the product catalog (e.g., "M", "42", "8-10").<br>Uses the same format as the store's size system. |
+| `comfortable` | number |  Yes  | AI-calculated comfort score ranging from 0 to 1, where a lower value indicates a better fit:<br>- 0.0 = Perfect, comfortable fit<br>- 0.5 = Adequate, but potentially tight/loose fit<br>- 1.0 = Very uncomfortable fit |
+| `value` | boolean |  No  | Boolean indicator of whether this size is considered suitable for the user.<br>Based on comfort threshold and fit analysis algorithms. |
 <!-- /DOCGEN -->
 
 ### `ComplementaryPairDto`
@@ -457,10 +431,8 @@ Based on comfort threshold and fit analysis algorithms. |
 <!-- DOCGEN:params ComplementaryPairDto -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `first` | ProductDto |  Yes  | First recommended product that complements the base product sent in the request.
-This product is selected based on style compatibility and fashion rules. |
-| `secondary` | ProductDto |  No  | Second recommended product that complements the base product sent in the request.
-May be null if no suitable second complementary item is found. |
+| `first` | ProductDto |  Yes  | First recommended product that complements the base product sent in the request.<br>This product is selected based on style compatibility and fashion rules. |
+| `secondary` | ProductDto |  No  | Second recommended product that complements the base product sent in the request.<br>May be null if no suitable second complementary item is found. |
 <!-- /DOCGEN -->
 
 ### `ClothType`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sizebay-core-sdk",
-  "version": "1.10.0-dev.3",
+  "version": "1.10.0-dev.4",
   "description": "A SDK designed for integrating multiple services (such as event tracking, AI services, etc.) into your application.",
   "main": "dist/sizebay-core-sdk.umd.js",
   "module": "dist/sizebay-core-sdk.es.js",