[Auto Generated] 3.9.0

Author: jigardafda

CHANGELOG.md

@@ -14,7 +14,7 @@ Get started with the python Development SDK for Fynd Platform
 ### Usage
 
 ```bash
-pip install "git+https://github.com/gofynd/fdk-client-python.git@3.8.0#egg=fdk_client"
+pip install "git+https://github.com/gofynd/fdk-client-python.git@3.9.0#egg=fdk_client"
 ```
 
 Using this method, you can `import` fdk-client-python like so:

README.md

@@ -1 +1 @@
-__version__ = "3.8.0"
+__version__ = "3.9.0"

fdk_client/__init__.py

@@ -26,7 +26,7 @@ def __init__(self, config: ApplicationConfig):
             "applyCoupon": "/service/application/cart/v1.0/coupon",
             "removeCoupon": "/service/application/cart/v1.0/coupon",
             "getBulkDiscountOffers": "/service/application/cart/v1.0/bulk-price",
-            "applyRewardPoints": "/service/application/cart/v1.0/redeem/points/",
+            "applyLoyaltyPoints": "/service/application/cart/v1.0/redeem",
             "getAddresses": "/service/application/cart/v1.0/address",
             "addAddress": "/service/application/cart/v1.0/address",
             "getAddressById": "/service/application/cart/v1.0/address/{id}",
@@ -301,7 +301,7 @@ async def updateCart(self, x_ordering_source=None, id=None, i=None, b=None, area
         return response
 
     async def updateCartBreakup(self, x_ordering_source=None, id=None, i=None, b=None, buy_now=None, cart_type=None, body="", request_headers:Dict={}):
-        """Update cart. Customers can adjust the cart breakup by  applying or removing store credits as needed.
+        """Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed.
         :param x-ordering-source : Ordering source header, to be used to identify source of order creation. : type 
         :param id : The unique identifier of the cart. : type string
         :param i : Select `true` to retrieve all the items added in the cart. : type boolean
@@ -690,8 +690,8 @@ async def getBulkDiscountOffers(self, item_id=None, article_id=None, uid=None, s
 
         return response
 
-    async def applyRewardPoints(self, x_ordering_source=None, id=None, i=None, b=None, buy_now=None, body="", request_headers:Dict={}):
-        """Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases.
+    async def applyLoyaltyPoints(self, x_ordering_source=None, id=None, i=None, b=None, buy_now=None, body="", request_headers:Dict={}):
+        """Users can redeem their accumulated loyalty points and apply them to the items in their cart, thereby availing discounts on their current purchases.
         :param x-ordering-source : Ordering source header, to be used to identify source of order creation. : type 
         :param id : The unique identifier of the cart. : type string
         :param i : Select `true` to retrieve all the items added in the cart. : type boolean
@@ -712,15 +712,15 @@ async def applyRewardPoints(self, x_ordering_source=None, id=None, i=None, b=Non
             payload["buy_now"] = buy_now
 
         # Parameter validation
-        schema = CartValidator.applyRewardPoints()
+        schema = CartValidator.applyLoyaltyPoints()
         schema.dump(schema.load(payload))
 
         # Body validation
-        from .models import RewardPointCreation
-        schema = RewardPointCreation()
+        from .models import RedeemLoyaltyPoints
+        schema = RedeemLoyaltyPoints()
         schema.dump(schema.load(body))
 
-        url_with_params = await create_url_with_params(api_url=self._urls["applyRewardPoints"], proccessed_params="""{"required":[],"optional":[{"in":"header","name":"x-ordering-source","schema":{"$ref":"#/components/schemas/OrderingSource"},"description":"Ordering source header, to be used to identify source of order creation."},{"in":"query","name":"id","schema":{"type":"string"},"description":"The unique identifier of the cart."},{"in":"query","name":"i","schema":{"type":"boolean"},"description":"Select `true` to retrieve all the items added in the cart."},{"in":"query","name":"b","schema":{"type":"boolean"},"description":"Select `true` to retrieve the price breakup of cart items."},{"in":"query","name":"buy_now","schema":{"type":"boolean"},"description":"This is boolean to get buy_now cart."}],"query":[{"in":"query","name":"id","schema":{"type":"string"},"description":"The unique identifier of the cart."},{"in":"query","name":"i","schema":{"type":"boolean"},"description":"Select `true` to retrieve all the items added in the cart."},{"in":"query","name":"b","schema":{"type":"boolean"},"description":"Select `true` to retrieve the price breakup of cart items."},{"in":"query","name":"buy_now","schema":{"type":"boolean"},"description":"This is boolean to get buy_now cart."}],"headers":[{"in":"header","name":"x-ordering-source","schema":{"$ref":"#/components/schemas/OrderingSource"},"description":"Ordering source header, to be used to identify source of order creation."}],"path":[]}""", serverType="application", x_ordering_source=x_ordering_source, id=id, i=i, b=b, buy_now=buy_now)
+        url_with_params = await create_url_with_params(api_url=self._urls["applyLoyaltyPoints"], proccessed_params="""{"required":[],"optional":[{"in":"header","name":"x-ordering-source","schema":{"$ref":"#/components/schemas/OrderingSource"},"description":"Ordering source header, to be used to identify source of order creation."},{"in":"query","name":"id","schema":{"type":"string"},"description":"The unique identifier of the cart."},{"in":"query","name":"i","schema":{"type":"boolean"},"description":"Select `true` to retrieve all the items added in the cart."},{"in":"query","name":"b","schema":{"type":"boolean"},"description":"Select `true` to retrieve the price breakup of cart items."},{"in":"query","name":"buy_now","schema":{"type":"boolean"},"description":"This is boolean to get buy_now cart."}],"query":[{"in":"query","name":"id","schema":{"type":"string"},"description":"The unique identifier of the cart."},{"in":"query","name":"i","schema":{"type":"boolean"},"description":"Select `true` to retrieve all the items added in the cart."},{"in":"query","name":"b","schema":{"type":"boolean"},"description":"Select `true` to retrieve the price breakup of cart items."},{"in":"query","name":"buy_now","schema":{"type":"boolean"},"description":"This is boolean to get buy_now cart."}],"headers":[{"in":"header","name":"x-ordering-source","schema":{"$ref":"#/components/schemas/OrderingSource"},"description":"Ordering source header, to be used to identify source of order creation."}],"path":[]}""", serverType="application", x_ordering_source=x_ordering_source, id=id, i=i, b=b, buy_now=buy_now)
         query_string = await create_query_string(id=id, i=i, b=b, buy_now=buy_now)
         if query_string:
             url_with_params += "?" + query_string
@@ -739,15 +739,15 @@ async def applyRewardPoints(self, x_ordering_source=None, id=None, i=None, b=Non
             if not key.startswith("x-fp-"):
                 exclude_headers.append(key)
 
-        response = await AiohttpHelper().aiohttp_request("POST", url_with_params, headers=get_headers_with_signature(urlparse(self._urls["applyRewardPoints"]).netloc, "post", await create_url_without_domain("/service/application/cart/v1.0/redeem/points/", x_ordering_source=x_ordering_source, id=id, i=i, b=b, buy_now=buy_now), query_string, headers, body, exclude_headers=exclude_headers), data=body, cookies=self._conf.cookies, debug=(self._conf.logLevel=="DEBUG"))
+        response = await AiohttpHelper().aiohttp_request("POST", url_with_params, headers=get_headers_with_signature(urlparse(self._urls["applyLoyaltyPoints"]).netloc, "post", await create_url_without_domain("/service/application/cart/v1.0/redeem", x_ordering_source=x_ordering_source, id=id, i=i, b=b, buy_now=buy_now), query_string, headers, body, exclude_headers=exclude_headers), data=body, cookies=self._conf.cookies, debug=(self._conf.logLevel=="DEBUG"))
 
         if 200 <= int(response['status_code']) < 300:
             from .models import CartDetailResult
             schema = CartDetailResult()
             try:
                 schema.load(response["json"])
             except Exception as e:
-                print("Response Validation failed for applyRewardPoints")
+                print("Response Validation failed for applyLoyaltyPoints")
                 print(e)
 
         return response
@@ -1704,7 +1704,7 @@ async def getPromotionPaymentOffers(self, id=None, uid=None, body="", request_he
         return response
 
     async def checkoutCartV2(self, x_ordering_source=None, buy_now=None, cart_type=None, body="", request_headers:Dict={}):
-        """The checkout cart initiates the order creation process based on the items in the user's cart,  their selected address, and chosen payment methods. It also supports multiple payment method  options and revalidates the cart details to ensure a secure and seamless order placement.
+        """The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement.
         :param x-ordering-source : Ordering source header, to be used to identify source of order creation. : type 
         :param buy_now : This indicates the type of cart to checkout. : type boolean
         :param cart_type : The type of cart. : type string

fdk_client/application/cart/client.py

@@ -306,7 +306,7 @@ class BulkPriceResult(BaseSchema):
     pass
 
 
-class RewardPointCreation(BaseSchema):
+class RedeemLoyaltyPoints(BaseSchema):
     pass
 
 
@@ -1157,6 +1157,10 @@ class RawBreakup(BaseSchema):
 
     subtotal = fields.Float(required=False)
 
+    engage_amount = fields.Float(required=False)
+    
+    engage_mop_amount = fields.Float(required=False)
+    
     fynd_cash = fields.Float(required=False)
 
     discount = fields.Float(required=False)
@@ -1229,6 +1233,22 @@ class LoyaltyPoints(BaseSchema):
 
     is_applied = fields.Boolean(required=False)
 
+    total_points = fields.Float(required=False)
+    
+    points = fields.Float(required=False)
+    
+    amount = fields.Float(required=False)
+    
+    mop_amount = fields.Float(required=False)
+    
+    earn_points = fields.Float(required=False)
+    
+    earn_points_amount = fields.Float(required=False)
+    
+    earn_title = fields.Str(required=False)
+    
+    title = fields.Str(required=False)
+    
 
 
 class CartBreakup(BaseSchema):
@@ -1739,11 +1759,11 @@ class BulkPriceResult(BaseSchema):
 
 
 
-class RewardPointCreation(BaseSchema):
+class RedeemLoyaltyPoints(BaseSchema):
     # Cart swagger.json
 
 
-    points = fields.Boolean(required=False)
+    redeem_points = fields.Boolean(required=False)
 
 
 

fdk_client/application/cart/models.py

@@ -378,7 +378,7 @@ class getBulkDiscountOffers(BaseSchema):
 
 
 
-    class applyRewardPoints(BaseSchema):
+    class applyLoyaltyPoints(BaseSchema):
 
 
         x__ordering__source = fields.Nested(OrderingSource, required=False)

fdk_client/application/cart/validator.py

@@ -727,6 +727,8 @@ class ProductDetailGroupedAttribute(BaseSchema):
 
     title = fields.Str(required=False)
 
+    id = fields.Str(required=False)
+    
     details = fields.List(fields.Nested(ProductDetailAttribute, required=False), required=False)
 
 

fdk_client/application/catalog/models.py

@@ -74,13 +74,14 @@ async def getAllPages(self, theme_id=None, body="", request_headers:Dict={}):
 
         return response
 
-    async def getPage(self, theme_id=None, page_value=None, filters=None, section_preview_hash=None, company=None, body="", request_headers:Dict={}):
-        """Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api.
+    async def getPage(self, theme_id=None, page_value=None, filters=None, section_preview_hash=None, company=None, url_params=None, body="", request_headers:Dict={}):
+        """Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. Supports dynamic URL parameter for custom sections.
         :param theme_id : Id of the theme to be retrieved. : type string
         :param page_value : Value of the page to be retrieved. : type string
         :param filters : Filters on sections to be applied or not. : type string
         :param section_preview_hash : Unique hash id on sections preview. : type string
         :param company : Company id of the application. : type integer
+        :param url_params : URL parameters extracted from the browser path and query string, used for dynamic variable mapping in custom sections. The value should be a stringified  JSON object containing the browser's URL parameters, with the JSON escaped. : type string
         """
         payload = {}
 
@@ -94,14 +95,16 @@ async def getPage(self, theme_id=None, page_value=None, filters=None, section_pr
             payload["section_preview_hash"] = section_preview_hash
         if company is not None:
             payload["company"] = company
+        if url_params is not None:
+            payload["url_params"] = url_params
 
         # Parameter validation
         schema = ThemeValidator.getPage()
         schema.dump(schema.load(payload))
 
 
-        url_with_params = await create_url_with_params(api_url=self._urls["getPage"], proccessed_params="""{"required":[{"name":"theme_id","in":"path","description":"Id of the theme to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be retrieved.","required":true,"schema":{"type":"string"}}],"optional":[{"name":"filters","in":"query","description":"Filters on sections to be applied or not.","required":false,"schema":{"type":"string"}},{"name":"section_preview_hash","in":"query","description":"Unique hash id on sections preview.","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Company id of the application.","required":false,"schema":{"type":"integer"}}],"query":[{"name":"filters","in":"query","description":"Filters on sections to be applied or not.","required":false,"schema":{"type":"string"}},{"name":"section_preview_hash","in":"query","description":"Unique hash id on sections preview.","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Company id of the application.","required":false,"schema":{"type":"integer"}}],"headers":[],"path":[{"name":"theme_id","in":"path","description":"Id of the theme to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be retrieved.","required":true,"schema":{"type":"string"}}]}""", serverType="application", theme_id=theme_id, page_value=page_value, filters=filters, section_preview_hash=section_preview_hash, company=company)
-        query_string = await create_query_string(filters=filters, section_preview_hash=section_preview_hash, company=company)
+        url_with_params = await create_url_with_params(api_url=self._urls["getPage"], proccessed_params="""{"required":[{"name":"theme_id","in":"path","description":"Id of the theme to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be retrieved.","required":true,"schema":{"type":"string"}}],"optional":[{"name":"filters","in":"query","description":"Filters on sections to be applied or not.","required":false,"schema":{"type":"string"}},{"name":"section_preview_hash","in":"query","description":"Unique hash id on sections preview.","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Company id of the application.","required":false,"schema":{"type":"integer"}},{"name":"url_params","in":"query","description":"URL parameters extracted from the browser path and query string, used for dynamic variable mapping in custom sections. The value should be a stringified  JSON object containing the browser's URL parameters, with the JSON escaped.","required":false,"schema":{"type":"string","format":"json"},"example":"{\"slug\": \"awesome-product\", \"page_type\": \"product\", \"path_segment_0\": \"product\", \"path_segment_1\": \"awesome-product\", \"full_path\": \"/product/awesome-product\"}"}],"query":[{"name":"filters","in":"query","description":"Filters on sections to be applied or not.","required":false,"schema":{"type":"string"}},{"name":"section_preview_hash","in":"query","description":"Unique hash id on sections preview.","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Company id of the application.","required":false,"schema":{"type":"integer"}},{"name":"url_params","in":"query","description":"URL parameters extracted from the browser path and query string, used for dynamic variable mapping in custom sections. The value should be a stringified  JSON object containing the browser's URL parameters, with the JSON escaped.","required":false,"schema":{"type":"string","format":"json"},"example":"{\"slug\": \"awesome-product\", \"page_type\": \"product\", \"path_segment_0\": \"product\", \"path_segment_1\": \"awesome-product\", \"full_path\": \"/product/awesome-product\"}"}],"headers":[],"path":[{"name":"theme_id","in":"path","description":"Id of the theme to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be retrieved.","required":true,"schema":{"type":"string"}}]}""", serverType="application", theme_id=theme_id, page_value=page_value, filters=filters, section_preview_hash=section_preview_hash, company=company, url_params=url_params)
+        query_string = await create_query_string(filters=filters, section_preview_hash=section_preview_hash, company=company, url_params=url_params)
         if query_string:
             url_with_params += "?" + query_string
 
@@ -119,7 +122,7 @@ async def getPage(self, theme_id=None, page_value=None, filters=None, section_pr
             if not key.startswith("x-fp-"):
                 exclude_headers.append(key)
 
-        response = await AiohttpHelper().aiohttp_request("GET", url_with_params, headers=get_headers_with_signature(urlparse(self._urls["getPage"]).netloc, "get", await create_url_without_domain("/service/application/theme/v1.0/{theme_id}/{page_value}", theme_id=theme_id, page_value=page_value, filters=filters, section_preview_hash=section_preview_hash, company=company), query_string, headers, body, exclude_headers=exclude_headers), data=body, cookies=self._conf.cookies, debug=(self._conf.logLevel=="DEBUG"))
+        response = await AiohttpHelper().aiohttp_request("GET", url_with_params, headers=get_headers_with_signature(urlparse(self._urls["getPage"]).netloc, "get", await create_url_without_domain("/service/application/theme/v1.0/{theme_id}/{page_value}", theme_id=theme_id, page_value=page_value, filters=filters, section_preview_hash=section_preview_hash, company=company, url_params=url_params), query_string, headers, body, exclude_headers=exclude_headers), data=body, cookies=self._conf.cookies, debug=(self._conf.logLevel=="DEBUG"))
 
         if 200 <= int(response['status_code']) < 300:
             from .models import AvailablePageSchema

fdk_client/application/theme/client.py

@@ -19,6 +19,7 @@
 
 
 
+        
 
 
 
@@ -49,6 +50,8 @@ class getPage(BaseSchema):
         section_preview_hash = fields.Str(required=False)
 
         company = fields.Int(required=False)
+        
+        url_params = fields.Str(required=False)