@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.4

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -1,39 +1,5 @@
 const Joi = require("joi");
 
-/**
- * @typedef AppUser
- * @property {string} [_id]
- * @property {boolean} [active]
- * @property {string} [application_id]
- * @property {string} [block_reason]
- * @property {string} [updated_at]
- * @property {string} [updated_by]
- * @property {string} [user_id]
- */
-
-/**
- * @typedef Asset
- * @property {string} [aspect_ratio]
- * @property {string} [id]
- * @property {string} [secure_url]
- */
-
-/**
- * @typedef ConfigurationRequest
- * @property {string} [terms_conditions_link]
- * @property {string[]} [valid_android_packages]
- */
-
-/**
- * @typedef ConfigurationRes
- * @property {string} [application_id]
- * @property {boolean} [success]
- * @property {string} [terms_conditions_link] - A URL that redirects to the
- *   referral information suport page link
- * @property {string[]} [valid_android_packages] - Contains array of string
- *   items, Valid android package names.
- */
-
 /**
  * @typedef E
  * @property {number} [code]
@@ -42,6 +8,12 @@ const Joi = require("joi");
  * @property {string} [message]
  */
 
+/**
+ * @typedef GiveawayResponse
+ * @property {Giveaway[]} [items]
+ * @property {Page} [page]
+ */
+
 /**
  * @typedef Giveaway
  * @property {string} [_id]
@@ -59,16 +31,40 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef GiveawayResponse
- * @property {Giveaway[]} [items]
- * @property {Page} [page]
+ * @typedef Schedule
+ * @property {number} [duration]
+ * @property {string} [end]
+ * @property {string} [start]
+ * @property {string} [cron]
  */
 
 /**
- * @typedef HistoryRes
- * @property {PointsHistory[]} [items] - History is the list of points transaction.
- * @property {Page} [page]
- * @property {number} [points]
+ * @typedef RewardsAudience
+ * @property {string} [header_user_id]
+ * @property {string} [id]
+ */
+
+/**
+ * @typedef Asset
+ * @property {string} [aspect_ratio]
+ * @property {string} [id]
+ * @property {string} [secure_url]
+ */
+
+/**
+ * @typedef RewardsRule
+ * @property {number} [amount]
+ */
+
+/**
+ * @typedef Page
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
+ * @property {string} type
+ * @property {number} [size]
  */
 
 /**
@@ -90,14 +86,22 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
+ * @typedef ShareMessages
+ * @property {number} [email]
+ * @property {string} [facebook]
+ * @property {string} [fallback]
+ * @property {string} [message]
+ * @property {string} [messenger]
+ * @property {string} [sms]
+ * @property {string} [text]
+ * @property {string} [twitter]
+ * @property {string} [whatsapp]
+ */
+
+/**
+ * @typedef UserRes
+ * @property {Points} [points]
+ * @property {RewardUser} [user]
  */
 
 /**
@@ -106,20 +110,14 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef PointsHistory
+ * @typedef RewardUser
  * @property {string} [_id]
- * @property {string} [application_id]
- * @property {boolean} [claimed]
+ * @property {boolean} [active]
  * @property {string} [created_at]
- * @property {string} [expires_on]
- * @property {Object} [meta]
- * @property {number} [points]
- * @property {number} [remaining_points]
- * @property {string} [text_1]
- * @property {string} [text_2]
- * @property {string} [text_3]
- * @property {string} [txn_name]
+ * @property {Referral} [referral]
+ * @property {number} [uid]
  * @property {string} [updated_at]
+ * @property {string} [user_block_reason]
  * @property {string} [user_id]
  */
 
@@ -129,34 +127,49 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef RewardsAudience
- * @property {string} [header_user_id]
- * @property {string} [id]
+ * @typedef AppUser
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {string} [block_reason]
+ * @property {string} [updated_at]
+ * @property {string} [updated_by]
+ * @property {string} [user_id]
  */
 
 /**
- * @typedef RewardsRule
- * @property {number} [amount]
+ * @typedef HistoryRes
+ * @property {PointsHistory[]} [items] - History is the list of points transaction.
+ * @property {Page} [page]
+ * @property {number} [points]
  */
 
 /**
- * @typedef RewardUser
+ * @typedef PointsHistory
  * @property {string} [_id]
- * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {boolean} [claimed]
  * @property {string} [created_at]
- * @property {Referral} [referral]
- * @property {number} [uid]
+ * @property {string} [expires_on]
+ * @property {Object} [meta]
+ * @property {number} [points]
+ * @property {number} [remaining_points]
+ * @property {string} [text_1]
+ * @property {string} [text_2]
+ * @property {string} [text_3]
+ * @property {string} [txn_name]
  * @property {string} [updated_at]
- * @property {string} [user_block_reason]
  * @property {string} [user_id]
  */
 
 /**
- * @typedef Schedule
- * @property {string} [cron]
- * @property {number} [duration]
- * @property {string} [end]
- * @property {string} [start]
+ * @typedef ConfigurationRes
+ * @property {string[]} [valid_android_packages] - Contains array of string
+ *   items, Valid android package names.
+ * @property {string} [terms_conditions_link] - A URL that redirects to the
+ *   referral information suport page link
+ * @property {string} [application_id]
+ * @property {boolean} [success]
  */
 
 /**
@@ -165,65 +178,12 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ShareMessages
- * @property {number} [email]
- * @property {string} [facebook]
- * @property {string} [fallback]
- * @property {string} [message]
- * @property {string} [messenger]
- * @property {string} [sms]
- * @property {string} [text]
- * @property {string} [twitter]
- * @property {string} [whatsapp]
- */
-
-/**
- * @typedef UserRes
- * @property {Points} [points]
- * @property {RewardUser} [user]
+ * @typedef ConfigurationRequest
+ * @property {string[]} [valid_android_packages]
+ * @property {string} [terms_conditions_link]
  */
 
 class RewardsPlatformModel {
-  /** @returns {AppUser} */
-  static AppUser() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      active: Joi.boolean(),
-      application_id: Joi.string().allow(""),
-      block_reason: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      updated_by: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Asset} */
-  static Asset() {
-    return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
-      id: Joi.string().allow(""),
-      secure_url: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ConfigurationRequest} */
-  static ConfigurationRequest() {
-    return Joi.object({
-      terms_conditions_link: Joi.string().allow(""),
-      valid_android_packages: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {ConfigurationRes} */
-  static ConfigurationRes() {
-    return Joi.object({
-      application_id: Joi.string().allow(""),
-      success: Joi.boolean(),
-      terms_conditions_link: Joi.string().allow(""),
-      valid_android_packages: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
   /** @returns {E} */
   static E() {
     return Joi.object({
@@ -234,6 +194,14 @@ class RewardsPlatformModel {
     });
   }
 
+  /** @returns {GiveawayResponse} */
+  static GiveawayResponse() {
+    return Joi.object({
+      items: Joi.array().items(RewardsPlatformModel.Giveaway()),
+      page: RewardsPlatformModel.Page(),
+    });
+  }
+
   /** @returns {Giveaway} */
   static Giveaway() {
     return Joi.object({
@@ -252,20 +220,50 @@ class RewardsPlatformModel {
     });
   }
 
-  /** @returns {GiveawayResponse} */
-  static GiveawayResponse() {
+  /** @returns {Schedule} */
+  static Schedule() {
     return Joi.object({
-      items: Joi.array().items(RewardsPlatformModel.Giveaway()),
-      page: RewardsPlatformModel.Page(),
+      duration: Joi.number(),
+      end: Joi.string().allow(""),
+      start: Joi.string().allow(""),
+      cron: Joi.string().allow(""),
     });
   }
 
-  /** @returns {HistoryRes} */
-  static HistoryRes() {
+  /** @returns {RewardsAudience} */
+  static RewardsAudience() {
     return Joi.object({
-      items: Joi.array().items(RewardsPlatformModel.PointsHistory()),
-      page: RewardsPlatformModel.Page(),
-      points: Joi.number(),
+      header_user_id: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Asset} */
+  static Asset() {
+    return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      secure_url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {RewardsRule} */
+  static RewardsRule() {
+    return Joi.object({
+      amount: Joi.number(),
+    });
+  }
+
+  /** @returns {Page} */
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      has_previous: Joi.boolean(),
+      has_next: Joi.boolean(),
+      current: Joi.number(),
+      type: Joi.string().allow("").required(),
+      size: Joi.number(),
     });
   }
 
@@ -289,16 +287,26 @@ class RewardsPlatformModel {
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
+  /** @returns {ShareMessages} */
+  static ShareMessages() {
     return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
+      email: Joi.number(),
+      facebook: Joi.string().allow(""),
+      fallback: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      messenger: Joi.string().allow(""),
+      sms: Joi.string().allow(""),
+      text: Joi.string().allow(""),
+      twitter: Joi.string().allow(""),
+      whatsapp: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {UserRes} */
+  static UserRes() {
+    return Joi.object({
+      points: RewardsPlatformModel.Points(),
+      user: RewardsPlatformModel.RewardUser(),
     });
   }
 
@@ -309,22 +317,16 @@ class RewardsPlatformModel {
     });
   }
 
-  /** @returns {PointsHistory} */
-  static PointsHistory() {
+  /** @returns {RewardUser} */
+  static RewardUser() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      application_id: Joi.string().allow(""),
-      claimed: Joi.boolean(),
+      active: Joi.boolean(),
       created_at: Joi.string().allow(""),
-      expires_on: Joi.string().allow(""),
-      meta: Joi.any(),
-      points: Joi.number(),
-      remaining_points: Joi.number(),
-      text_1: Joi.string().allow(""),
-      text_2: Joi.string().allow(""),
-      text_3: Joi.string().allow(""),
-      txn_name: Joi.string().allow(""),
+      referral: RewardsPlatformModel.Referral(),
+      uid: Joi.number(),
       updated_at: Joi.string().allow(""),
+      user_block_reason: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
     });
   }
@@ -336,42 +338,55 @@ class RewardsPlatformModel {
     });
   }
 
-  /** @returns {RewardsAudience} */
-  static RewardsAudience() {
+  /** @returns {AppUser} */
+  static AppUser() {
     return Joi.object({
-      header_user_id: Joi.string().allow(""),
-      id: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
+      active: Joi.boolean(),
+      application_id: Joi.string().allow(""),
+      block_reason: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      updated_by: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
     });
   }
 
-  /** @returns {RewardsRule} */
-  static RewardsRule() {
+  /** @returns {HistoryRes} */
+  static HistoryRes() {
     return Joi.object({
-      amount: Joi.number(),
+      items: Joi.array().items(RewardsPlatformModel.PointsHistory()),
+      page: RewardsPlatformModel.Page(),
+      points: Joi.number(),
     });
   }
 
-  /** @returns {RewardUser} */
-  static RewardUser() {
+  /** @returns {PointsHistory} */
+  static PointsHistory() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      active: Joi.boolean(),
+      application_id: Joi.string().allow(""),
+      claimed: Joi.boolean(),
       created_at: Joi.string().allow(""),
-      referral: RewardsPlatformModel.Referral(),
-      uid: Joi.number(),
+      expires_on: Joi.string().allow(""),
+      meta: Joi.any(),
+      points: Joi.number(),
+      remaining_points: Joi.number(),
+      text_1: Joi.string().allow(""),
+      text_2: Joi.string().allow(""),
+      text_3: Joi.string().allow(""),
+      txn_name: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
-      user_block_reason: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Schedule} */
-  static Schedule() {
+  /** @returns {ConfigurationRes} */
+  static ConfigurationRes() {
     return Joi.object({
-      cron: Joi.string().allow(""),
-      duration: Joi.number(),
-      end: Joi.string().allow(""),
-      start: Joi.string().allow(""),
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+      terms_conditions_link: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      success: Joi.boolean(),
     });
   }
 
@@ -382,26 +397,11 @@ class RewardsPlatformModel {
     });
   }
 
-  /** @returns {ShareMessages} */
-  static ShareMessages() {
-    return Joi.object({
-      email: Joi.number(),
-      facebook: Joi.string().allow(""),
-      fallback: Joi.string().allow(""),
-      message: Joi.string().allow(""),
-      messenger: Joi.string().allow(""),
-      sms: Joi.string().allow(""),
-      text: Joi.string().allow(""),
-      twitter: Joi.string().allow(""),
-      whatsapp: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {UserRes} */
-  static UserRes() {
+  /** @returns {ConfigurationRequest} */
+  static ConfigurationRequest() {
     return Joi.object({
-      points: RewardsPlatformModel.Points(),
-      user: RewardsPlatformModel.RewardUser(),
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+      terms_conditions_link: Joi.string().allow(""),
     });
   }
 }

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

@@ -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
@@ -243,7 +244,7 @@ declare class Serviceability {
      * @summary: Shows zones defined at the company level
      * @description: Return the list of zones that are defined at the company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
      */
-    getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
+    getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
     /**
      * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js

@@ -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 }
     );
@@ -1728,7 +1729,7 @@ class Serviceability {
       isActive,
       channelId,
       q,
-      country,
+      countryIsoCode,
       state,
       city,
       pincode,
@@ -1744,7 +1745,7 @@ class Serviceability {
         isActive,
         channelId,
         q,
-        country,
+        countryIsoCode,
         state,
         city,
         pincode,
@@ -1766,7 +1767,7 @@ class Serviceability {
         isActive,
         channelId,
         q,
-        country,
+        countryIsoCode,
         state,
         city,
         pincode,
@@ -1787,7 +1788,7 @@ class Serviceability {
     query_params["is_active"] = isActive;
     query_params["channel_id"] = channelId;
     query_params["q"] = q;
-    query_params["country"] = country;
+    query_params["country_iso_code"] = countryIsoCode;
     query_params["state"] = state;
     query_params["city"] = city;
     query_params["pincode"] = pincode;