@gofynd/fdk-client-javascript 3.22.0 → 3.23.0

package/README.md

@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.22.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.23.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.22.0",
+  "version": "3.23.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/application/Cart/CartApplicationClient.d.ts

@@ -217,9 +217,9 @@ declare class Cart {
      * @returns {Promise<EligibleProductsResult>} - Success response
      * @name getProductsByOfferId
      * @summary: List eligible offer products
-     * @description: List all products eligible for the given offer id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getProductsByOfferId/).
+     * @description: List all products eligible for the given offer. Lookup can be done by offer_code (takes priority) or offer_id. At least one must be provided. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getProductsByOfferId/).
      */
-    getProductsByOfferId({ offerId, page, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<EligibleProductsResult>;
+    getProductsByOfferId({ offerCode, offerId, page, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<EligibleProductsResult>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Cart/CartApplicationClient.js

@@ -934,13 +934,16 @@ class Cart {
    * @returns {Promise<EligibleProductsResult>} - Success response
    * @name getProductsByOfferId
    * @summary: List eligible offer products
-   * @description: List all products eligible for the given offer id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getProductsByOfferId/).
+   * @description: List all products eligible for the given offer. Lookup can be done by offer_code (takes priority) or offer_id. At least one must be provided. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getProductsByOfferId/).
    */
   async getProductsByOfferId(
-    { offerId, page, pageSize, requestHeaders } = { requestHeaders: {} },
+    { offerCode, offerId, page, pageSize, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const query_params = {};
+    query_params["offer_code"] = offerCode;
     query_params["offer_id"] = offerId;
     query_params["page"] = page;
     query_params["page_size"] = pageSize;

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts

@@ -82,6 +82,20 @@ declare class Serviceability {
      * @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoAreaExportJob/).
      */
     createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.CreatePolygonParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>}
+     *   - Success response
+     *
+     * @name createPolygon
+     * @summary: Create polygon-based serviceability for stores
+     * @description: Creates polygon-based serviceability regions for one or more stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPolygon/).
+     */
+    createPolygon({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreatePolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.CreateShipmentsParam} arg
      *   - Arg object
@@ -121,6 +135,18 @@ declare class Serviceability {
      * @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
      */
     createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.CreateZoneProductsBulkPatchJobParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
+     * @name createZoneProductsBulkPatchJob
+     * @summary: Create bulk zone products patch job
+     * @description: Initiates a bulk zone products patch operation by accepting a CSV file URL. The file is validated and a background job is created for processing zone product additions or removals. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZoneProductsBulkPatchJob/).
+     */
+    createZoneProductsBulkPatchJob({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneProductsBulkPatchJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneBulkExport>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam} arg
      *   - Arg object
@@ -161,6 +187,18 @@ declare class Serviceability {
      * @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
      */
     downloadGeoareaSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.DownloadZoneProductsBulkSampleFileParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<string>} - Success response
+     * @name downloadZoneProductsBulkSampleFile
+     * @summary: Download zone products bulk patch sample file
+     * @description: Downloads a CSV sample template file for bulk patching zone products. The template includes headers for zone_id, product_type, products, and action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadZoneProductsBulkSampleFile/).
+     */
+    downloadZoneProductsBulkSampleFile({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.GetApplicationConfigParam} arg
      *   - Arg object
@@ -188,6 +226,20 @@ declare class Serviceability {
      * @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfiguration/).
      */
     getApplicationConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigGetResult>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.GetApplicationCourierPartnersListParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>}
+     *   - Success response
+     *
+     * @name getApplicationCourierPartnersList
+     * @summary: Get available application courier partners
+     * @description: Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details, and delivery rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationCourierPartnersList/).
+     */
+    getApplicationCourierPartnersList({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetApplicationCourierPartnersListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GenerateShipmentsAndCourierPartnerResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.GetBulkExportParam} arg
      *   - Arg object
@@ -363,6 +415,20 @@ declare class Serviceability {
      * @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
      */
     getGeoAreas({ pageSize, isActive, pageNo, type, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetGeoAreasParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaGetResponseBody>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.GetPolygonParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityGetResult>}
+     *   - Success response
+     *
+     * @name getPolygon
+     * @summary: Get polygon-based serviceability for stores
+     * @description: Retrieves polygon-based serviceability configurations for stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPolygon/).
+     */
+    getPolygon({ pageNumber, pageSize, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetPolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityGetResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.GetStoreRuleParam} arg
      *   - Arg object
@@ -400,6 +466,20 @@ declare class Serviceability {
      * @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
      */
     getZone({ zoneId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.GetZoneProductsBulkPatchJobStatusParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.GetZoneProductsBulkPatchResult>}
+     *   - Success response
+     *
+     * @name getZoneProductsBulkPatchJobStatus
+     * @summary: Get bulk zone products patch job status
+     * @description: Retrieves the status and details of a specific bulk zone products patch job by its batch identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZoneProductsBulkPatchJobStatus/).
+     */
+    getZoneProductsBulkPatchJobStatus({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetZoneProductsBulkPatchJobStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneProductsBulkPatchResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -556,6 +636,20 @@ declare class Serviceability {
      * @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeMopView/).
      */
     updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPResult>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.UpdatePolygonParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>}
+     *   - Success response
+     *
+     * @name updatePolygon
+     * @summary: Update polygon-based serviceability for stores
+     * @description: Updates polygon-based serviceability regions for one or more stores for quick commerce. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePolygon/).
+     */
+    updatePolygon({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePolygonParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.StorePolygonServiceabilityResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.UpdateStoreRulePriorityParam} arg
      *   - Arg object