sizebay-core-sdk 1.12.0-dev.2 → 1.12.0-dev.3

package/README.md

@@ -309,25 +309,25 @@ Get grouped looks with optional filters and pagination (Public endpoint).
 <!-- DOCGEN:params GetGroupedLooksParams -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `tenantId` | number |  Yes  | Tenant ID (required).<br>Identifies the client/tenant for which to retrieve grouped looks. |
-| `limit` | number |  No  | Number of results to return per page.<br>Must be between 1 and 100. Defaults to 50 if not specified. |
-| `offset` | number |  No  | Number of results to skip for pagination.<br>Used to fetch subsequent pages of results. |
-| `order` | SortOrder |  No  | Sort order for results by timestamp.<br>Use 'asc' for oldest first, 'desc' for newest first. |
-| `permalink` | string |  No  | Filter by product permalink.<br>Returns only grouped looks that contain this specific product.<br>Useful for finding looks that include a particular item. |
-| `gender` | Gender |  No  | Filter by gender.<br>Returns only grouped looks designed for the specified gender. |
-| `ageGroup` | AgeGroup |  No  | Filter by age group.<br>Returns only grouped looks appropriate for the specified age range. |
-| `style` | Style |  No  | Filter by style.<br>Returns only grouped looks matching the specified style category. |
-| `collection` | Collection |  No  | Filter by collection.<br>Returns only grouped looks from the specified seasonal collection. |
-| `status` | GroupedLookStatus |  No  | Filter by status.<br>Returns only grouped looks with the specified status (enabled or disabled). |
+| `tenantId` | number |  Yes  | Tenant ID (required). |
+| `limit` | number |  No  | Maximum number of looks to return per page (1-100).<br>Use smaller values for faster responses, larger for comprehensive results. |
+| `offset` | number |  No  | Number of looks to skip before returning results.<br>Use with limit to implement pagination: page 2 = offset 50 (if limit is 50). |
+| `order` | SortOrder |  No  | Sort order by creation date.<br>Use 'desc' to show newest looks first, 'asc' for oldest first. |
+| `permalink` | string |  No  | Filter by product permalink.<br>Find all looks that include this specific product. Useful for showing<br>styling suggestions when a user views a product page. |
+| `gender` | Gender |  No  | Filter by target gender.<br>Show only looks designed for MALE or FEMALE audiences. |
+| `ageGroup` | AgeGroup |  No  | Filter by target age group.<br>Show only looks appropriate for the specified age range. |
+| `style` | Style |  No  | Filter by style category.<br>Show only looks matching the desired style (casual, formal, party, etc.). |
+| `collection` | Collection |  No  | Filter by seasonal collection.<br>Show only looks from a specific season (spring, summer, fall, winter). |
+| `status` | GroupedLookStatus |  No  | Filter by active status.<br>Use 'enabled' to show only active looks, 'disabled' for inactive ones. |
 <!-- /DOCGEN -->
 
 #### Returns
 
 <!-- DOCGEN:returns GroupedLooksListResponse -->
 > **`GroupedLooksListResponse`**
-> * `data`: `GroupedLookResponseDto[]` — Array of grouped looks
-> * `total`: `number` — Total number of grouped looks matching the filters
-> * `pagination`: `PaginationInfo` — Pagination information
+> * `data`: `GroupedLookResponseDto[]` — Fashion looks for the current page.<br>Display these looks to users. Each look contains styled outfits with try-on images.
+> * `total`: `number` — Total number of looks matching your filters across all pages.<br>Use this to show "Showing X of Y looks" or calculate total pages.
+> * `pagination`: `PaginationInfo` — Pagination information for navigating between pages.<br>Use this to implement pagination controls in your UI.
 <!-- /DOCGEN -->
 
 #### Example
@@ -360,17 +360,17 @@ Get a specific grouped look by ID (Public endpoint).
 
 <!-- DOCGEN:returns GroupedLookResponseDto -->
 > **`GroupedLookResponseDto`**
-> * `id`: `string` — Unique identifier
-> * `tenantId`: `number` — Tenant ID
-> * `gender`: `Gender` — Gender
-> * `ageGroup`: `AgeGroup` — Age group
-> * `style`: `Style` — Style
-> * `collection`: `Collection` — Collection
-> * `rate`: `number` — Rating from 0 to 5
-> * `status`: `GroupedLookStatus` — Status of the grouped look
-> * `timestamp`: `string` — Creation timestamp
-> * `tryons`: `TryonGroup[]` — Array of tryons grouped by BMI and skin tone
-> * `feedback`: `GroupedLookFeedbackResponseDto` — Feedback information if exists
+> * `id`: `string` — Unique identifier for this fashion look (UUID).<br>Use this to fetch the look again or reference it in other operations.
+> * `tenantId`: `number` — Tenant ID that owns this look.
+> * `gender`: `Gender` — Target gender for this look (MALE or FEMALE).<br>Use to filter or categorize looks by target audience.
+> * `ageGroup`: `AgeGroup` — Target age group for this look.<br>Use to show age-appropriate looks to users.
+> * `style`: `Style` — Style category of this look.<br>Use to filter looks by style preference or display style tags.
+> * `collection`: `Collection` — Seasonal collection this look belongs to.<br>Use to show seasonal looks or filter by collection.
+> * `rate`: `number` — Quality rating of this look (0-5).<br>Higher ratings indicate better quality. Use to sort or filter by quality.
+> * `status`: `GroupedLookStatus` — Current status of this look.<br>Only show 'enabled' looks to users, hide 'disabled' ones.
+> * `timestamp`: `string` — When this look was created (ISO 8601 format).<br>Use to sort by date or show "new" looks.
+> * `tryons`: `TryonGroup[]` — All virtual try-on images organized by body type and skin tone.<br>Iterate through this to display all try-on variations. Each group represents<br>a body type, and each group contains try-ons for different skin tones.
+> * `feedback`: `GroupedLookFeedbackResponseDto` — User feedback for this look, if any has been submitted.<br>Use to display feedback or quality metrics to users.
 <!-- /DOCGEN -->
 
 #### Example
@@ -554,17 +554,17 @@ ClothType.SHOE_ACCESSORY // For shoes, accessories
 <!-- DOCGEN:params GroupedLookResponseDto -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `id` | string |  Yes  | Unique identifier |
-| `tenantId` | number |  Yes  | Tenant ID |
-| `gender` | Gender |  Yes  | Gender |
-| `ageGroup` | AgeGroup |  Yes  | Age group |
-| `style` | Style |  Yes  | Style |
-| `collection` | Collection |  Yes  | Collection |
-| `rate` | number |  Yes  | Rating from 0 to 5 |
-| `status` | GroupedLookStatus |  Yes  | Status of the grouped look |
-| `timestamp` | string |  Yes  | Creation timestamp |
-| `tryons` | TryonGroup[] |  Yes  | Array of tryons grouped by BMI and skin tone |
-| `feedback` | GroupedLookFeedbackResponseDto |  No  | Feedback information if exists |
+| `id` | string |  Yes  | Unique identifier for this fashion look (UUID).<br>Use this to fetch the look again or reference it in other operations. |
+| `tenantId` | number |  Yes  | Tenant ID that owns this look. |
+| `gender` | Gender |  Yes  | Target gender for this look (MALE or FEMALE).<br>Use to filter or categorize looks by target audience. |
+| `ageGroup` | AgeGroup |  Yes  | Target age group for this look.<br>Use to show age-appropriate looks to users. |
+| `style` | Style |  Yes  | Style category of this look.<br>Use to filter looks by style preference or display style tags. |
+| `collection` | Collection |  Yes  | Seasonal collection this look belongs to.<br>Use to show seasonal looks or filter by collection. |
+| `rate` | number |  Yes  | Quality rating of this look (0-5).<br>Higher ratings indicate better quality. Use to sort or filter by quality. |
+| `status` | GroupedLookStatus |  Yes  | Current status of this look.<br>Only show 'enabled' looks to users, hide 'disabled' ones. |
+| `timestamp` | string |  Yes  | When this look was created (ISO 8601 format).<br>Use to sort by date or show "new" looks. |
+| `tryons` | TryonGroup[] |  Yes  | All virtual try-on images organized by body type and skin tone.<br>Iterate through this to display all try-on variations. Each group represents<br>a body type, and each group contains try-ons for different skin tones. |
+| `feedback` | GroupedLookFeedbackResponseDto |  No  | User feedback for this look, if any has been submitted.<br>Use to display feedback or quality metrics to users. |
 <!-- /DOCGEN -->
 
 ### `GroupedLooksListResponse`
@@ -572,9 +572,9 @@ ClothType.SHOE_ACCESSORY // For shoes, accessories
 <!-- DOCGEN:params GroupedLooksListResponse -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `data` | GroupedLookResponseDto[] |  Yes  | Array of grouped looks |
-| `total` | number |  Yes  | Total number of grouped looks matching the filters |
-| `pagination` | PaginationInfo |  Yes  | Pagination information |
+| `data` | GroupedLookResponseDto[] |  Yes  | Fashion looks for the current page.<br>Display these looks to users. Each look contains styled outfits with try-on images. |
+| `total` | number |  Yes  | Total number of looks matching your filters across all pages.<br>Use this to show "Showing X of Y looks" or calculate total pages. |
+| `pagination` | PaginationInfo |  Yes  | Pagination information for navigating between pages.<br>Use this to implement pagination controls in your UI. |
 <!-- /DOCGEN -->
 
 ### `PaginationInfo`
@@ -582,10 +582,10 @@ ClothType.SHOE_ACCESSORY // For shoes, accessories
 <!-- DOCGEN:params PaginationInfo -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `limit` | number |  Yes  | Number of results per page |
-| `offset` | number |  Yes  | Number of results skipped |
-| `hasNext` | boolean |  Yes  | Whether there are more results after this page |
-| `hasPrevious` | boolean |  Yes  | Whether there are results before this page |
+| `limit` | number |  Yes  | Number of looks returned in this page.<br>Matches the limit parameter you sent in the request. |
+| `offset` | number |  Yes  | Number of looks skipped to reach this page.<br>Matches the offset parameter you sent in the request. |
+| `hasNext` | boolean |  Yes  | Whether there are more looks available after this page.<br>Use this to show/hide "Next" button or load more functionality. |
+| `hasPrevious` | boolean |  Yes  | Whether there are looks before this page.<br>Use this to show/hide "Previous" button. |
 <!-- /DOCGEN -->
 
 ### `TryonGroup`
@@ -593,8 +593,8 @@ ClothType.SHOE_ACCESSORY // For shoes, accessories
 <!-- DOCGEN:params TryonGroup -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `bmi` | string |  Yes  | BMI identifier |
-| `skinTones` | TryonDetails[] |  Yes  | Array of try-ons organized by skin tone |
+| `bmi` | string |  Yes  | Body type identifier (e.g., 'slim', 'regular', 'plus'). |
+| `skinTones` | TryonDetails[] |  Yes  | Try-on images for different skin tones within this body type.<br>Iterate through these to show all skin tone variations for the same body type. |
 <!-- /DOCGEN -->
 
 ### `TryonDetails`
@@ -602,6 +602,6 @@ ClothType.SHOE_ACCESSORY // For shoes, accessories
 <!-- DOCGEN:params TryonDetails -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `skinTone` | string |  Yes  | Skin tone identifier |
-| `tryonDetails` | Record<string, any> |  Yes  | Try-on details object (structure may vary) |
+| `skinTone` | string |  Yes  | Skin tone identifier (e.g., 'light', 'brown', 'dark'). |
+| `tryonDetails` | Record<string, any> |  Yes  | Try-on image data including URL and rendering metadata.<br>Contains the actual image URL and other properties needed to display the try-on. |
 <!-- /DOCGEN -->

package/dist/sizebay-core-sdk.es.js

@@ -392,13 +392,18 @@ class m {
     });
   }
   /**
-   * Get grouped looks with optional filters and pagination (Public endpoint)
+   * List fashion looks with virtual try-ons.
    *
-   * Retrieves a list of grouped looks with associated tryons.
-   * Supports filtering by various criteria and pagination.
+   * Retrieves a paginated list of styled outfit combinations that have been
+   * pre-generated with AI-powered virtual try-ons. Each look shows how products
+   * look together when worn by avatares with different body types and skin tones.
    *
-   * @param params - Parameters for the request (tenantId is required)
-   * @returns Promise resolving to the paginated list of grouped looks
+   * Use filters to find looks by gender, age group, style, collection, or specific products.
+   * Use pagination (limit/offset) to navigate through large result sets efficiently.
+   *
+   * @param params - Search parameters. tenantId is required. Use filters to narrow results
+   *                 and limit/offset for pagination.
+   * @returns Promise resolving to paginated list of fashion looks with try-on images
    * @throws {ApiError} if the HTTP status is not 2xx or on network failure
    */
   getGroupedLooks(t) {
@@ -409,15 +414,17 @@ class m {
     });
   }
   /**
-   * Get a specific grouped look by ID (Public endpoint)
+   * Get a specific fashion look by ID with all try-on variations.
    *
-   * Retrieves detailed information about a specific grouped look including
-   * associated tryons and feedback if available.
+   * Retrieves complete details of a fashion look including all AI-generated
+   * virtual try-on images. Each look shows the same outfit combination rendered
+   * on different avatares (various body types and skin tones), allowing users
+   * to see how the look appears on different people.
    *
-   * @param id - Grouped look UUID
-   * @param tenantId - Tenant ID (required)
-   * @returns Promise resolving to the grouped look details
-   * @throws {ApiError} if the HTTP status is not 2xx or on network failure
+   * @param id - Fashion look UUID identifier
+   * @param tenantId - Tenant ID
+   * @returns Promise resolving to complete fashion look with all try-on variations
+   * @throws {ApiError} if the HTTP status is not 2xx (e.g., 404 if not found) or on network failure
    */
   getGroupedLookById(t, e) {
     const s = new URL(`${this.endpoint}/api/public/grouped-looks/${t}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sizebay-core-sdk",
-  "version": "1.12.0-dev.2",
+  "version": "1.12.0-dev.3",
   "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",