@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.2

package/README.md

@@ -237,7 +237,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: v1.4.15-beta.1' --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: 1.4.15-beta.2' --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": "v1.4.15-beta.1",
+  "version": "1.4.15-beta.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -533,6 +533,8 @@ export = CartPlatformModel;
  * @property {boolean} is_authenticated - Flag indicating whether the user is
  *   authenticated
  * @property {Article[]} article_ids - The list of article object in the price adjustment
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
  */
@@ -554,6 +556,8 @@ export = CartPlatformModel;
  * @property {boolean} is_authenticated - Flag indicating whether the user is
  *   authenticated
  * @property {Article[]} article_ids - The list of article object in the price adjustment
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
  */
@@ -585,6 +589,8 @@ export = CartPlatformModel;
  * @property {Article[]} article_ids - The list of article object in the price adjustment
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  */
 /**
  * @typedef CartItem
@@ -2505,6 +2511,11 @@ type PriceAdjustmentUpdate = {
      * - The list of article object in the price adjustment
      */
     article_ids: Article[];
+    /**
+     * - This field if set true will remove mop
+     * type price adjustment.
+     */
+    auto_remove?: boolean;
     meta?: any;
     /**
      * - The ID of the cart
@@ -2554,6 +2565,11 @@ type PriceAdjustment = {
      * - The list of article object in the price adjustment
      */
     article_ids: Article[];
+    /**
+     * - This field if set true will remove mop
+     * type price adjustment.
+     */
+    auto_remove?: boolean;
     meta?: any;
     /**
      * - The ID of the cart
@@ -2621,6 +2637,11 @@ type PriceAdjustmentAdd = {
      * - The ID of the cart
      */
     cart_id: string;
+    /**
+     * - This field if set true will remove mop
+     * type price adjustment.
+     */
+    auto_remove?: boolean;
 };
 /** @returns {CartItem} */
 declare function CartItem(): CartItem;

package/sdk/platform/Cart/CartPlatformModel.js

@@ -593,6 +593,8 @@ const Joi = require("joi");
  * @property {boolean} is_authenticated - Flag indicating whether the user is
  *   authenticated
  * @property {Article[]} article_ids - The list of article object in the price adjustment
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
  */
@@ -615,6 +617,8 @@ const Joi = require("joi");
  * @property {boolean} is_authenticated - Flag indicating whether the user is
  *   authenticated
  * @property {Article[]} article_ids - The list of article object in the price adjustment
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
  */
@@ -649,6 +653,8 @@ const Joi = require("joi");
  * @property {Article[]} article_ids - The list of article object in the price adjustment
  * @property {Object} [meta]
  * @property {string} cart_id - The ID of the cart
+ * @property {boolean} [auto_remove] - This field if set true will remove mop
+ *   type price adjustment.
  */
 
 /**
@@ -2647,6 +2653,7 @@ class CartPlatformModel {
       allowed_refund: Joi.boolean(),
       is_authenticated: Joi.boolean().required(),
       article_ids: Joi.array().items(CartPlatformModel.Article()).required(),
+      auto_remove: Joi.boolean(),
       meta: Joi.any(),
       cart_id: Joi.string().allow("").required(),
     });
@@ -2666,6 +2673,7 @@ class CartPlatformModel {
       allowed_refund: Joi.boolean(),
       is_authenticated: Joi.boolean().required(),
       article_ids: Joi.array().items(CartPlatformModel.Article()).required(),
+      auto_remove: Joi.boolean(),
       meta: Joi.any(),
       cart_id: Joi.string().allow("").required(),
     });
@@ -2701,6 +2709,7 @@ class CartPlatformModel {
       article_ids: Joi.array().items(CartPlatformModel.Article()).required(),
       meta: Joi.any(),
       cart_id: Joi.string().allow("").required(),
+      auto_remove: Joi.boolean(),
     });
   }
 

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

@@ -133,11 +133,23 @@ export = ServiceabilityPlatformModel;
  * @property {string} type
  * @property {string[]} tags
  */
+/**
+ * @typedef ZoneMappingDetailType
+ * @property {string} country - Uid for the country.
+ * @property {ZoneMappingRegions[]} [regions] - List of regions with its details.
+ */
 /**
  * @typedef ZoneMappingType
  * @property {string} country
- * @property {string[]} [pincode]
- * @property {string[]} [state]
+ * @property {string[]} regions
+ */
+/**
+ * @typedef ZoneMappingRegions
+ * @property {string} [display_name] - Name of the region that is in proper casing.
+ * @property {string[]} [parent_id]
+ * @property {string} [parent_uid] - Unique identifier for that regions parent.
+ * @property {string} [sub_type] - What type does the region belong to.
+ * @property {string} [uid] - Unique identifier for that region.
  */
 /**
  * @typedef UpdateZoneData
@@ -151,7 +163,6 @@ export = ServiceabilityPlatformModel;
  * @property {number[]} store_ids
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 /**
  * @typedef ZoneUpdateRequest
@@ -175,7 +186,6 @@ export = ServiceabilityPlatformModel;
  * @property {number[]} store_ids
  * @property {string} [region_type]
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  * @property {number} stores_count
  */
 /**
@@ -193,9 +203,7 @@ export = ServiceabilityPlatformModel;
  * @property {ZoneProductTypes} product
  * @property {number[]} store_ids
  * @property {string} region_type
- * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
- * @property {number} stores_count
+ * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
  */
 /**
  * @typedef CreateZoneData
@@ -205,9 +213,9 @@ export = ServiceabilityPlatformModel;
  * @property {boolean} is_active
  * @property {GetZoneDataViewChannels[]} channels
  * @property {number[]} store_ids
+ * @property {ZoneProductTypes} product
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 /**
  * @typedef ZoneResponse
@@ -229,7 +237,6 @@ export = ServiceabilityPlatformModel;
  * @property {string} slug
  * @property {boolean} is_active
  * @property {number[]} store_ids
- * @property {string} assignment_preference
  */
 /**
  * @typedef GetZoneFromPincodeViewResponse
@@ -1027,7 +1034,7 @@ export = ServiceabilityPlatformModel;
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
+    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
 }
 /** @returns {UpdateZoneConfigRequest} */
 declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
@@ -1211,12 +1218,44 @@ type ZoneProductTypes = {
     type: string;
     tags: string[];
 };
+/** @returns {ZoneMappingDetailType} */
+declare function ZoneMappingDetailType(): ZoneMappingDetailType;
+type ZoneMappingDetailType = {
+    /**
+     * - Uid for the country.
+     */
+    country: string;
+    /**
+     * - List of regions with its details.
+     */
+    regions?: ZoneMappingRegions[];
+};
 /** @returns {ZoneMappingType} */
 declare function ZoneMappingType(): ZoneMappingType;
 type ZoneMappingType = {
     country: string;
-    pincode?: string[];
-    state?: string[];
+    regions: string[];
+};
+/** @returns {ZoneMappingRegions} */
+declare function ZoneMappingRegions(): ZoneMappingRegions;
+type ZoneMappingRegions = {
+    /**
+     * - Name of the region that is in proper casing.
+     */
+    display_name?: string;
+    parent_id?: string[];
+    /**
+     * - Unique identifier for that regions parent.
+     */
+    parent_uid?: string;
+    /**
+     * - What type does the region belong to.
+     */
+    sub_type?: string;
+    /**
+     * - Unique identifier for that region.
+     */
+    uid?: string;
 };
 /** @returns {UpdateZoneData} */
 declare function UpdateZoneData(): UpdateZoneData;
@@ -1231,7 +1270,6 @@ type UpdateZoneData = {
     store_ids: number[];
     region_type: string;
     mapping: ZoneMappingType[];
-    assignment_preference?: string;
 };
 /** @returns {ZoneUpdateRequest} */
 declare function ZoneUpdateRequest(): ZoneUpdateRequest;
@@ -1258,7 +1296,6 @@ type GetZoneDataViewItems = {
     store_ids: number[];
     region_type?: string;
     mapping: ZoneMappingType[];
-    assignment_preference?: string;
     stores_count: number;
 };
 /** @returns {GetSingleZoneDataViewResponse} */
@@ -1278,9 +1315,10 @@ type GetZoneByIdSchema = {
     product: ZoneProductTypes;
     store_ids: number[];
     region_type: string;
-    mapping: ZoneMappingType[];
-    assignment_preference?: string;
-    stores_count: number;
+    /**
+     * - Country to region mapping for the zone.
+     */
+    mapping: ZoneMappingDetailType[];
 };
 /** @returns {CreateZoneData} */
 declare function CreateZoneData(): CreateZoneData;
@@ -1291,9 +1329,9 @@ type CreateZoneData = {
     is_active: boolean;
     channels: GetZoneDataViewChannels[];
     store_ids: number[];
+    product: ZoneProductTypes;
     region_type: string;
     mapping: ZoneMappingType[];
-    assignment_preference?: string;
 };
 /** @returns {ZoneResponse} */
 declare function ZoneResponse(): ZoneResponse;
@@ -1318,7 +1356,6 @@ type Zone = {
     slug: string;
     is_active: boolean;
     store_ids: number[];
-    assignment_preference: string;
 };
 /** @returns {GetZoneFromPincodeViewResponse} */
 declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -155,11 +155,25 @@ const Joi = require("joi");
  * @property {string[]} tags
  */
 
+/**
+ * @typedef ZoneMappingDetailType
+ * @property {string} country - Uid for the country.
+ * @property {ZoneMappingRegions[]} [regions] - List of regions with its details.
+ */
+
 /**
  * @typedef ZoneMappingType
  * @property {string} country
- * @property {string[]} [pincode]
- * @property {string[]} [state]
+ * @property {string[]} regions
+ */
+
+/**
+ * @typedef ZoneMappingRegions
+ * @property {string} [display_name] - Name of the region that is in proper casing.
+ * @property {string[]} [parent_id]
+ * @property {string} [parent_uid] - Unique identifier for that regions parent.
+ * @property {string} [sub_type] - What type does the region belong to.
+ * @property {string} [uid] - Unique identifier for that region.
  */
 
 /**
@@ -174,7 +188,6 @@ const Joi = require("joi");
  * @property {number[]} store_ids
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 
 /**
@@ -201,7 +214,6 @@ const Joi = require("joi");
  * @property {number[]} store_ids
  * @property {string} [region_type]
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  * @property {number} stores_count
  */
 
@@ -221,9 +233,7 @@ const Joi = require("joi");
  * @property {ZoneProductTypes} product
  * @property {number[]} store_ids
  * @property {string} region_type
- * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
- * @property {number} stores_count
+ * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
  */
 
 /**
@@ -234,9 +244,9 @@ const Joi = require("joi");
  * @property {boolean} is_active
  * @property {GetZoneDataViewChannels[]} channels
  * @property {number[]} store_ids
+ * @property {ZoneProductTypes} product
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 
 /**
@@ -261,7 +271,6 @@ const Joi = require("joi");
  * @property {string} slug
  * @property {boolean} is_active
  * @property {number[]} store_ids
- * @property {string} assignment_preference
  */
 
 /**
@@ -1365,12 +1374,32 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {ZoneMappingDetailType} */
+  static ZoneMappingDetailType() {
+    return Joi.object({
+      country: Joi.string().allow("").required(),
+      regions: Joi.array().items(
+        ServiceabilityPlatformModel.ZoneMappingRegions()
+      ),
+    });
+  }
+
   /** @returns {ZoneMappingType} */
   static ZoneMappingType() {
     return Joi.object({
       country: Joi.string().allow("").required(),
-      pincode: Joi.array().items(Joi.string().allow("")),
-      state: Joi.array().items(Joi.string().allow("")),
+      regions: Joi.array().items(Joi.string().allow("")).required(),
+    });
+  }
+
+  /** @returns {ZoneMappingRegions} */
+  static ZoneMappingRegions() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      parent_id: Joi.array().items(Joi.string().allow("")),
+      parent_uid: Joi.string().allow(""),
+      sub_type: Joi.string().allow(""),
+      uid: Joi.string().allow(""),
     });
   }
 
@@ -1391,7 +1420,6 @@ class ServiceabilityPlatformModel {
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
     });
   }
 
@@ -1428,7 +1456,6 @@ class ServiceabilityPlatformModel {
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
       stores_count: Joi.number().required(),
     });
   }
@@ -1455,10 +1482,8 @@ class ServiceabilityPlatformModel {
       store_ids: Joi.array().items(Joi.number()).required(),
       region_type: Joi.string().allow("").required(),
       mapping: Joi.array()
-        .items(ServiceabilityPlatformModel.ZoneMappingType())
+        .items(ServiceabilityPlatformModel.ZoneMappingDetailType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
-      stores_count: Joi.number().required(),
     });
   }
 
@@ -1473,11 +1498,11 @@ class ServiceabilityPlatformModel {
         .items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
         .required(),
       store_ids: Joi.array().items(Joi.number()).required(),
+      product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
       region_type: Joi.string().allow("").required(),
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
     });
   }
 
@@ -1508,7 +1533,6 @@ class ServiceabilityPlatformModel {
       slug: Joi.string().allow("").required(),
       is_active: Joi.boolean().required(),
       store_ids: Joi.array().items(Joi.number()).required(),
-      assignment_preference: Joi.string().allow("").required(),
     });
   }