@commercengine/storefront-sdk 0.3.8 → 0.3.10

package/dist/types/storefront.d.ts

@@ -44,7 +44,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/catalog/products/{product_id}": {
+    "/catalog/products/{product_id_or_slug}": {
         parameters: {
             query?: never;
             header?: never;
@@ -53,7 +53,7 @@ export interface paths {
         };
         /**
          * Retrieve a product detail
-         * @description Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
+         * @description Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
          */
         get: operations["get-product-detail"];
         put?: never;
@@ -663,6 +663,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/store/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve store config
+         * @description Retrieve store config detail
+         */
+        get: operations["get-config"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/customers/{id}/documents": {
         parameters: {
             query?: never;
@@ -1848,6 +1868,7 @@ export interface components {
             readonly has_variant: boolean;
             tags: string[] | null;
             category_ids: string[];
+            categories: components["schemas"]["Category"][];
             /** Format: double */
             reviews_rating_sum: number;
             reviews_count: number;
@@ -2337,10 +2358,9 @@ export interface components {
             readonly email?: string;
             /**
              * @description Reviews with approved status will be displayed.
-             * @default pending
              * @enum {string}
              */
-            readonly status: "approved" | "rejected" | "archived" | "pending";
+            readonly status?: "approved";
             /** @default false */
             is_featured: boolean;
             tags?: string[];
@@ -4272,6 +4292,73 @@ export interface components {
             /** @enum {unknown} */
             verification_type?: "auto" | "manual";
         };
+        /** StoreConfig */
+        StoreConfig: {
+            /** @default false */
+            is_kyc_enabled: boolean;
+            /** @default false */
+            is_customer_group_enabled: boolean;
+            brand: components["schemas"]["Brand"];
+            currency: components["schemas"]["Currency"];
+            readonly customer_groups: components["schemas"]["CustomerGroup"][];
+            readonly kyc_documents: components["schemas"]["KycDocumentConfig"][];
+            measurement: components["schemas"]["MeasurementUnit"];
+            terms_of_service: components["schemas"]["StoreTemplate"];
+            refund_policy: components["schemas"]["StoreTemplate"];
+        };
+        /** StoreTemplate */
+        StoreTemplate: {
+            readonly id: string;
+            name: string;
+            /** @description to be used in email subject or notification heading if provided. */
+            content_title: string | null;
+            /** @enum {unknown} */
+            content_type: "html" | "markdown" | "plaintext";
+            content: string;
+        };
+        /** KycDocumentConfig */
+        KycDocumentConfig: {
+            readonly id: string;
+            /** @enum {unknown} */
+            document_type: "gst" | "pan" | "other";
+            title: string;
+            description: string | null;
+            /** @default true */
+            active: boolean;
+            is_mandatory: boolean;
+            is_attachment_required: boolean;
+            /** @enum {unknown} */
+            verification_type: "auto" | "manual";
+        };
+        /** CustomerGroup */
+        CustomerGroup: {
+            readonly id: string;
+            name: string;
+            description: string | null;
+            /** @description first record will be treated as default if not changed. */
+            is_default: boolean;
+            /** @default true */
+            active: boolean;
+        };
+        /** Brand */
+        Brand: {
+            /** @description brand name. it will be used in emails and other communications. */
+            name: string;
+            readonly logo_url: string;
+            /** @description json object having key - value pair.
+             *
+             *     example - {"facebook": "www.facebook.com/commecengine"} */
+            social_media_links: {
+                [key: string]: string;
+            };
+        };
+        /** MeasurementUnit */
+        MeasurementUnit: {
+            /** @enum {unknown} */
+            weight?: "gm";
+            /** @enum {unknown} */
+            dimension?: "cm";
+        };
         /** GstinDetail */
         GstinDetail: {
             id?: string;
@@ -4453,6 +4540,8 @@ export interface components {
         sortingParam: string;
         /** @description search keyword */
         searchKeyword: string;
+        /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+        CustomerGroupId: string;
     };
     requestBodies: never;
     headers: never;
@@ -4469,12 +4558,15 @@ export interface operations {
                 limit?: components["parameters"]["pageLimitParam"];
                 /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                 sort_by?: components["parameters"]["sortingParam"];
-                /** @description filter products by categories */
+                /** @description filter products by categories ids */
                 category_id?: string[];
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+                /** @description filter products by categories slugs */
+                category_slug?: string[];
+            };
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path?: never;
             cookie?: never;
         };
@@ -4511,12 +4603,13 @@ export interface operations {
                 sort_by?: components["parameters"]["sortingParam"];
                 /** @description filter sku by categories */
                 category_id?: string[];
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
                 /** @description array of sku */
                 sku?: string[];
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4544,14 +4637,14 @@ export interface operations {
     };
     "get-product-detail": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
-                /** @description id of a particular product */
-                product_id: string;
+                /** @description The unique identifier of the product. Can be either the product ID or the slug. */
+                product_id_or_slug: string;
             };
             cookie?: never;
         };
@@ -4578,11 +4671,11 @@ export interface operations {
     };
     "list-product-variants": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
                 /** @description ID of a particular product */
                 product_id: string;
@@ -4612,11 +4705,11 @@ export interface operations {
     };
     "get-variant-detail": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
                 /** @description product id */
                 product_id: string;
@@ -4649,7 +4742,7 @@ export interface operations {
     "list-categories": {
         parameters: {
             query?: {
-                /** @description To return child categories */
+                /** @description To return child categories using category id. */
                 parent_category_id?: string;
                 /** @description return child categories up to nesting level */
                 nested_level?: number;
@@ -4657,6 +4750,8 @@ export interface operations {
                 search?: components["parameters"]["searchKeyword"];
                 /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                 sort_by?: components["parameters"]["sortingParam"];
+                /** @description To return child categories using category slug */
+                parent_category_slug?: string;
             };
             header?: never;
             path?: never;
@@ -4774,7 +4869,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4812,7 +4910,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4851,7 +4952,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -5989,6 +6093,35 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    "get-config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                        success?: boolean;
+                        content?: {
+                            store_config?: components["schemas"]["StoreConfig"];
+                        };
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     "list-documents": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercengine/storefront-sdk",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "TypeScript SDK for the Storefront API",
   "type": "module",
   "main": "dist/index.js",