@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.5

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -1182,8 +1182,8 @@ class Serviceability {
    *   - Success response
    *
    * @name updatePincodeAuditHistory
-   * @summary: Auditlog configuration of application.
-   * @description: This API returns Audit logs of Pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
+   * @summary: Update pincode audit history.
+   * @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
    */
   async updatePincodeAuditHistory(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1265,8 +1265,8 @@ class Serviceability {
    *   - Success response
    *
    * @name updatePincodeBulkView
-   * @summary: Bulk Update of pincode in the application.
-   * @description: This API constructs bulk write operations to update the MOP data for each pincode in the payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
+   * @summary: Update pincode bulk view.
+   * @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
    */
   async updatePincodeBulkView(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1348,8 +1348,8 @@ class Serviceability {
    *   - Success response
    *
    * @name updatePincodeCoDListing
-   * @summary: Pincode count view of application.
-   * @description: This API returns count of active pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
+   * @summary: Update pincode CoD (Cash on Delivery) listing.
+   * @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
    */
   async updatePincodeCoDListing(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1430,8 +1430,8 @@ class Serviceability {
    * @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
    *   Success response
    * @name updatePincodeMopView
-   * @summary: PincodeView update of MOP.
-   * @description: This API updates Pincode method of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
+   * @summary: Update pincode MOP (Mode of Payment) view.
+   * @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
    */
   async updatePincodeMopView(
     { body, requestHeaders } = { requestHeaders: {} },

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

@@ -71,8 +71,8 @@ declare class Serviceability {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
      * @name createZone
-     * @summary: Creates a new Zone
-     * @description: Creates a new zone with the specified mapping. A zone enables serviceability based on given regions. By creating a zone and including specific regions, you can ensure that the stores associated with the zone are serviceable for those added regions. This functionality is particularly useful when you need to ensure serviceability for multiple regions by grouping them into a single zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
+     * @summary: Create zone.
+     * @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
      */
     createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResponse>;
     /**
@@ -82,8 +82,8 @@ declare class Serviceability {
      * @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
      *   Success response
      * @name getAllStores
-     * @summary: GET stores data
-     * @description: This API returns stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
+     * @summary: Get all stores.
+     * @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
      */
     getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResponse>;
     /**
@@ -153,13 +153,14 @@ declare class Serviceability {
      * @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>} -
-     *   Success response
+     * @returns {Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>}
+     *   - Success response
+     *
      * @name getOptimalLocations
-     * @summary: Get serviceable store of the item
-     * @description: This API returns serviceable store of the item. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
+     * @summary: Retrieve optimal locations
+     * @description: Retrieve optimal locations based on the specific criteria - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
      */
-    getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>;
+    getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>;
     /**
      * @param {ServiceabilityPlatformValidator.GetPackageMaterialListParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js

@@ -444,8 +444,8 @@ class Serviceability {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
    * @name createZone
-   * @summary: Creates a new Zone
-   * @description: Creates a new zone with the specified mapping. A zone enables serviceability based on given regions. By creating a zone and including specific regions, you can ensure that the stores associated with the zone are serviceable for those added regions. This functionality is particularly useful when you need to ensure serviceability for multiple regions by grouping them into a single zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
+   * @summary: Create zone.
+   * @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
    */
   async createZone(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -524,8 +524,8 @@ class Serviceability {
    * @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
    *   Success response
    * @name getAllStores
-   * @summary: GET stores data
-   * @description: This API returns stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
+   * @summary: Get all stores.
+   * @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
    */
   async getAllStores(
     { requestHeaders } = { requestHeaders: {} },
@@ -1108,11 +1108,12 @@ class Serviceability {
    * @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>} -
-   *   Success response
+   * @returns {Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>}
+   *   - Success response
+   *
    * @name getOptimalLocations
-   * @summary: Get serviceable store of the item
-   * @description: This API returns serviceable store of the item. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
+   * @summary: Retrieve optimal locations
+   * @description: Retrieve optimal locations based on the specific criteria - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
    */
   async getOptimalLocations(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1153,7 +1154,7 @@ class Serviceability {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/logistics/v1.0/company/${this.config.companyId}/reassign`,
+      `/service/platform/logistics/v1.0/company/${this.config.companyId}/optimal-locations`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1167,7 +1168,7 @@ class Serviceability {
 
     const {
       error: res_error,
-    } = ServiceabilityPlatformModel.ReAssignStoreResponse().validate(
+    } = ServiceabilityPlatformModel.OptimalLocationsResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );

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

@@ -382,21 +382,6 @@ export = ServiceabilityPlatformModel;
  * @property {ServiceabilityPageResponse} page
  * @property {ItemResponse[]} [items]
  */
-/**
- * @typedef ReAssignStoreRequest
- * @property {string} to_pincode
- * @property {string} identifier
- * @property {Object} configuration
- * @property {string[]} ignored_locations
- * @property {Object[]} articles
- */
-/**
- * @typedef ReAssignStoreResponse
- * @property {string} to_pincode
- * @property {boolean} success
- * @property {Object} error
- * @property {Object[]} [articles]
- */
 /**
  * @typedef PincodeMopData
  * @property {number[]} pincodes
@@ -937,10 +922,77 @@ export = ServiceabilityPlatformModel;
  * @typedef RulePriorityResponse
  * @property {boolean} [success]
  */
+/**
+ * @typedef ArticleAssignment
+ * @property {string} [level]
+ * @property {string} [strategy] - The strategy parameter allows users to
+ *   specify the desired approach or criteria for selecting optimal locations.
+ */
+/**
+ * @typedef ServiceabilityLocation
+ * @property {string} longitude - The longitude of the serviceability location.
+ * @property {string} latitude - The latitude of the serviceability location.
+ */
+/**
+ * @typedef LocationDetailsServiceability
+ * @property {string} [pincode] - The pincode of the serviceability location.
+ * @property {string} [sector] - The sector of the serviceability location.
+ * @property {string} [state] - The state of the serviceability location.
+ * @property {string} country - The country of the serviceability location.
+ * @property {string} [city] - The city of the serviceability location.
+ * @property {string} country_iso_code - The ISO code of the country.
+ * @property {ServiceabilityLocation} [location]
+ */
+/**
+ * @typedef OptimalLocationsArticles
+ * @property {number} item_id
+ * @property {string} size
+ * @property {string} quantity
+ * @property {string} [group_id]
+ * @property {boolean} [is_primary_item]
+ * @property {Object} [meta]
+ * @property {ArticleAssignment} article_assignment
+ * @property {number[]} ignore_locations
+ * @property {number[]} assign_locations
+ * @property {number} [seller_id]
+ */
+/**
+ * @typedef OptimlLocationsRequestSchema
+ * @property {string} channel_id
+ * @property {string} channel_type
+ * @property {LocationDetailsServiceability} to_serviceability
+ * @property {OptimalLocationsArticles} [article]
+ */
+/**
+ * @typedef OptimalLocationArticlesResponse
+ * @property {number} item_id
+ * @property {string} size
+ * @property {number} quantity
+ * @property {string} [group_id]
+ * @property {boolean} [is_primary_item]
+ * @property {Object} [meta]
+ * @property {ArticleAssignment} article_assignment
+ * @property {number} [seller_id]
+ * @property {number[]} ignore_locations
+ * @property {number[]} assign_locations
+ * @property {number} price_effective
+ * @property {number} mto_quantity
+ * @property {string} _id
+ * @property {string} uid
+ */
+/**
+ * @typedef OptimalLocationAssignedStoresResponse
+ * @property {number} store_id
+ * @property {OptimalLocationArticlesResponse[]} articles
+ */
+/**
+ * @typedef OptimalLocationsResponse
+ * @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
+ */
 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, ReAssignStoreRequest, ReAssignStoreResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, ErrorResponse, CourierPartnerAccountFailureResponse, Page, 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 };
+    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, ErrorResponse, CourierPartnerAccountFailureResponse, Page, 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;
@@ -1379,23 +1431,6 @@ type GetStoresViewResponse = {
     page: ServiceabilityPageResponse;
     items?: ItemResponse[];
 };
-/** @returns {ReAssignStoreRequest} */
-declare function ReAssignStoreRequest(): ReAssignStoreRequest;
-type ReAssignStoreRequest = {
-    to_pincode: string;
-    identifier: string;
-    configuration: any;
-    ignored_locations: string[];
-    articles: any[];
-};
-/** @returns {ReAssignStoreResponse} */
-declare function ReAssignStoreResponse(): ReAssignStoreResponse;
-type ReAssignStoreResponse = {
-    to_pincode: string;
-    success: boolean;
-    error: any;
-    articles?: any[];
-};
 /** @returns {PincodeMopData} */
 declare function PincodeMopData(): PincodeMopData;
 type PincodeMopData = {
@@ -2004,3 +2039,105 @@ declare function RulePriorityResponse(): RulePriorityResponse;
 type RulePriorityResponse = {
     success?: boolean;
 };
+/** @returns {ArticleAssignment} */
+declare function ArticleAssignment(): ArticleAssignment;
+type ArticleAssignment = {
+    level?: string;
+    /**
+     * - The strategy parameter allows users to
+     * specify the desired approach or criteria for selecting optimal locations.
+     */
+    strategy?: string;
+};
+/** @returns {ServiceabilityLocation} */
+declare function ServiceabilityLocation(): ServiceabilityLocation;
+type ServiceabilityLocation = {
+    /**
+     * - The longitude of the serviceability location.
+     */
+    longitude: string;
+    /**
+     * - The latitude of the serviceability location.
+     */
+    latitude: string;
+};
+/** @returns {LocationDetailsServiceability} */
+declare function LocationDetailsServiceability(): LocationDetailsServiceability;
+type LocationDetailsServiceability = {
+    /**
+     * - The pincode of the serviceability location.
+     */
+    pincode?: string;
+    /**
+     * - The sector of the serviceability location.
+     */
+    sector?: string;
+    /**
+     * - The state of the serviceability location.
+     */
+    state?: string;
+    /**
+     * - The country of the serviceability location.
+     */
+    country: string;
+    /**
+     * - The city of the serviceability location.
+     */
+    city?: string;
+    /**
+     * - The ISO code of the country.
+     */
+    country_iso_code: string;
+    location?: ServiceabilityLocation;
+};
+/** @returns {OptimalLocationsArticles} */
+declare function OptimalLocationsArticles(): OptimalLocationsArticles;
+type OptimalLocationsArticles = {
+    item_id: number;
+    size: string;
+    quantity: string;
+    group_id?: string;
+    is_primary_item?: boolean;
+    meta?: any;
+    article_assignment: ArticleAssignment;
+    ignore_locations: number[];
+    assign_locations: number[];
+    seller_id?: number;
+};
+/** @returns {OptimlLocationsRequestSchema} */
+declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
+type OptimlLocationsRequestSchema = {
+    channel_id: string;
+    channel_type: string;
+    to_serviceability: LocationDetailsServiceability;
+    article?: OptimalLocationsArticles;
+};
+/** @returns {OptimalLocationArticlesResponse} */
+declare function OptimalLocationArticlesResponse(): OptimalLocationArticlesResponse;
+type OptimalLocationArticlesResponse = {
+    item_id: number;
+    size: string;
+    quantity: number;
+    group_id?: string;
+    is_primary_item?: boolean;
+    meta?: any;
+    article_assignment: ArticleAssignment;
+    seller_id?: number;
+    ignore_locations: number[];
+    assign_locations: number[];
+    price_effective: number;
+    mto_quantity: number;
+    _id: string;
+    uid: string;
+};
+/** @returns {OptimalLocationAssignedStoresResponse} */
+declare function OptimalLocationAssignedStoresResponse(): OptimalLocationAssignedStoresResponse;
+type OptimalLocationAssignedStoresResponse = {
+    store_id: number;
+    articles: OptimalLocationArticlesResponse[];
+};
+/** @returns {OptimalLocationsResponse} */
+declare function OptimalLocationsResponse(): OptimalLocationsResponse;
+type OptimalLocationsResponse = {
+    assigned_stores: OptimalLocationAssignedStoresResponse[];
+};

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -437,23 +437,6 @@ const Joi = require("joi");
  * @property {ItemResponse[]} [items]
  */
 
-/**
- * @typedef ReAssignStoreRequest
- * @property {string} to_pincode
- * @property {string} identifier
- * @property {Object} configuration
- * @property {string[]} ignored_locations
- * @property {Object[]} articles
- */
-
-/**
- * @typedef ReAssignStoreResponse
- * @property {string} to_pincode
- * @property {boolean} success
- * @property {Object} error
- * @property {Object[]} [articles]
- */
-
 /**
  * @typedef PincodeMopData
  * @property {number[]} pincodes
@@ -1062,6 +1045,81 @@ const Joi = require("joi");
  * @property {boolean} [success]
  */
 
+/**
+ * @typedef ArticleAssignment
+ * @property {string} [level]
+ * @property {string} [strategy] - The strategy parameter allows users to
+ *   specify the desired approach or criteria for selecting optimal locations.
+ */
+
+/**
+ * @typedef ServiceabilityLocation
+ * @property {string} longitude - The longitude of the serviceability location.
+ * @property {string} latitude - The latitude of the serviceability location.
+ */
+
+/**
+ * @typedef LocationDetailsServiceability
+ * @property {string} [pincode] - The pincode of the serviceability location.
+ * @property {string} [sector] - The sector of the serviceability location.
+ * @property {string} [state] - The state of the serviceability location.
+ * @property {string} country - The country of the serviceability location.
+ * @property {string} [city] - The city of the serviceability location.
+ * @property {string} country_iso_code - The ISO code of the country.
+ * @property {ServiceabilityLocation} [location]
+ */
+
+/**
+ * @typedef OptimalLocationsArticles
+ * @property {number} item_id
+ * @property {string} size
+ * @property {string} quantity
+ * @property {string} [group_id]
+ * @property {boolean} [is_primary_item]
+ * @property {Object} [meta]
+ * @property {ArticleAssignment} article_assignment
+ * @property {number[]} ignore_locations
+ * @property {number[]} assign_locations
+ * @property {number} [seller_id]
+ */
+
+/**
+ * @typedef OptimlLocationsRequestSchema
+ * @property {string} channel_id
+ * @property {string} channel_type
+ * @property {LocationDetailsServiceability} to_serviceability
+ * @property {OptimalLocationsArticles} [article]
+ */
+
+/**
+ * @typedef OptimalLocationArticlesResponse
+ * @property {number} item_id
+ * @property {string} size
+ * @property {number} quantity
+ * @property {string} [group_id]
+ * @property {boolean} [is_primary_item]
+ * @property {Object} [meta]
+ * @property {ArticleAssignment} article_assignment
+ * @property {number} [seller_id]
+ * @property {number[]} ignore_locations
+ * @property {number[]} assign_locations
+ * @property {number} price_effective
+ * @property {number} mto_quantity
+ * @property {string} _id
+ * @property {string} uid
+ */
+
+/**
+ * @typedef OptimalLocationAssignedStoresResponse
+ * @property {number} store_id
+ * @property {OptimalLocationArticlesResponse[]} articles
+ */
+
+/**
+ * @typedef OptimalLocationsResponse
+ * @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
+ */
+
 class ServiceabilityPlatformModel {
   /** @returns {UpdateZoneConfigRequest} */
   static UpdateZoneConfigRequest() {
@@ -1644,27 +1702,6 @@ class ServiceabilityPlatformModel {
     });
   }
 
-  /** @returns {ReAssignStoreRequest} */
-  static ReAssignStoreRequest() {
-    return Joi.object({
-      to_pincode: Joi.string().allow("").required(),
-      identifier: Joi.string().allow("").required(),
-      configuration: Joi.any().required(),
-      ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
-      articles: Joi.array().items(Joi.any()).required(),
-    });
-  }
-
-  /** @returns {ReAssignStoreResponse} */
-  static ReAssignStoreResponse() {
-    return Joi.object({
-      to_pincode: Joi.string().allow("").required(),
-      success: Joi.boolean().required(),
-      error: Joi.any().required(),
-      articles: Joi.array().items(Joi.any()),
-    });
-  }
-
   /** @returns {PincodeMopData} */
   static PincodeMopData() {
     return Joi.object({
@@ -2450,5 +2487,101 @@ class ServiceabilityPlatformModel {
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {ArticleAssignment} */
+  static ArticleAssignment() {
+    return Joi.object({
+      level: Joi.string().allow(""),
+      strategy: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ServiceabilityLocation} */
+  static ServiceabilityLocation() {
+    return Joi.object({
+      longitude: Joi.string().allow("").required(),
+      latitude: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {LocationDetailsServiceability} */
+  static LocationDetailsServiceability() {
+    return Joi.object({
+      pincode: Joi.string().allow(""),
+      sector: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+      country: Joi.string().allow("").required(),
+      city: Joi.string().allow(""),
+      country_iso_code: Joi.string().allow("").required(),
+      location: ServiceabilityPlatformModel.ServiceabilityLocation(),
+    });
+  }
+
+  /** @returns {OptimalLocationsArticles} */
+  static OptimalLocationsArticles() {
+    return Joi.object({
+      item_id: Joi.number().required(),
+      size: Joi.string().allow("").required(),
+      quantity: Joi.string().allow("").required(),
+      group_id: Joi.string().allow(""),
+      is_primary_item: Joi.boolean(),
+      meta: Joi.any(),
+      article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
+      ignore_locations: Joi.array().items(Joi.number()).required(),
+      assign_locations: Joi.array().items(Joi.number()).required(),
+      seller_id: Joi.number(),
+    });
+  }
+
+  /** @returns {OptimlLocationsRequestSchema} */
+  static OptimlLocationsRequestSchema() {
+    return Joi.object({
+      channel_id: Joi.string().allow("").required(),
+      channel_type: Joi.string().allow("").required(),
+      to_serviceability: ServiceabilityPlatformModel.LocationDetailsServiceability().required(),
+      article: ServiceabilityPlatformModel.OptimalLocationsArticles(),
+    });
+  }
+
+  /** @returns {OptimalLocationArticlesResponse} */
+  static OptimalLocationArticlesResponse() {
+    return Joi.object({
+      item_id: Joi.number().required(),
+      size: Joi.string().allow("").required(),
+      quantity: Joi.number().required(),
+      group_id: Joi.string().allow(""),
+      is_primary_item: Joi.boolean(),
+      meta: Joi.any(),
+      article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
+      seller_id: Joi.number(),
+      ignore_locations: Joi.array().items(Joi.number()).required(),
+      assign_locations: Joi.array().items(Joi.number()).required(),
+      price_effective: Joi.number().required(),
+      mto_quantity: Joi.number().required(),
+      _id: Joi.string().allow("").required(),
+      uid: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {OptimalLocationAssignedStoresResponse} */
+  static OptimalLocationAssignedStoresResponse() {
+    return Joi.object({
+      store_id: Joi.number().required(),
+      articles: Joi.array()
+        .items(ServiceabilityPlatformModel.OptimalLocationArticlesResponse())
+        .required(),
+    });
+  }
+
+  /** @returns {OptimalLocationsResponse} */
+  static OptimalLocationsResponse() {
+    return Joi.object({
+      assigned_stores: Joi.array()
+        .items(
+          ServiceabilityPlatformModel.OptimalLocationAssignedStoresResponse()
+        )
+        .required(),
+    });
+  }
 }
 module.exports = ServiceabilityPlatformModel;

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

@@ -71,7 +71,7 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
  */
 /**
  * @typedef GetPackageMaterialListParam
@@ -365,7 +365,7 @@ type GetCourierPartnerAccountsParam = {
     transportType?: string;
 };
 type GetOptimalLocationsParam = {
-    body: ServiceabilityPlatformModel.ReAssignStoreRequest;
+    body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
 };
 type GetPackageMaterialListParam = {
     /**

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -86,7 +86,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
  */
 
 /**
@@ -294,7 +294,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ReAssignStoreRequest().required(),
+      body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
     }).required();
   }