@gofynd/fdk-client-javascript 1.4.15-beta.5 → 1.4.15-beta.6

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: 1.4.15-beta.5' --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.6' --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": "1.4.15-beta.5",
+  "version": "1.4.15-beta.6",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -126,6 +126,16 @@ declare class Serviceability {
      * @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRules/).
      */
     getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResponse>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
+     * @name getZones
+     * @summary: Get zones
+     * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
+     */
+    getZones({ pageNo, pageSize, isActive, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -761,6 +761,124 @@ class Serviceability {
     return response;
   }
 
+  /**
+   * @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
+   * @name getZones
+   * @summary: Get zones
+   * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
+   */
+  async getZones(
+    {
+      pageNo,
+      pageSize,
+      isActive,
+      q,
+      countryIsoCode,
+      state,
+      city,
+      pincode,
+      sector,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ServiceabilityPlatformApplicationValidator.getZones().validate(
+      {
+        pageNo,
+        pageSize,
+        isActive,
+
+        q,
+        countryIsoCode,
+        state,
+        city,
+        pincode,
+        sector,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ServiceabilityPlatformApplicationValidator.getZones().validate(
+      {
+        pageNo,
+        pageSize,
+        isActive,
+
+        q,
+        countryIsoCode,
+        state,
+        city,
+        pincode,
+        sector,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Serviceability > getZones \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["is_active"] = isActive;
+    query_params["application_id"] = applicationId;
+    query_params["q"] = q;
+    query_params["country_iso_code"] = countryIsoCode;
+    query_params["state"] = state;
+    query_params["city"] = city;
+    query_params["pincode"] = pincode;
+    query_params["sector"] = sector;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/logistics/v2.0/company/${this.config.companyId}/zones`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ServiceabilityPlatformModel.ListViewResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Serviceability > getZones \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
    *   - Arg object

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

@@ -31,6 +31,18 @@ export = ServiceabilityPlatformApplicationValidator;
  * @property {number} [pageSize]
  * @property {string} [status]
  */
+/**
+ * @typedef GetZonesParam
+ * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {boolean} [isActive] - Status of Zone (either active or inactive)
+ * @property {string} [q] - Search with name as a free text
+ * @property {string} [countryIsoCode] - ISO2 code of the country
+ * @property {string} [state] - State name
+ * @property {string} [city] - City name
+ * @property {string} [pincode] - Pincode value to search zones
+ * @property {string} [sector] - Sector value to search zones
+ */
 /**
  * @typedef InsertApplicationConfigParam
  * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
@@ -97,6 +109,8 @@ declare class ServiceabilityPlatformApplicationValidator {
     static getStoreRule(): GetStoreRuleParam;
     /** @returns {GetStoreRulesParam} */
     static getStoreRules(): GetStoreRulesParam;
+    /** @returns {GetZonesParam} */
+    static getZones(): GetZonesParam;
     /** @returns {InsertApplicationConfigParam} */
     static insertApplicationConfig(): InsertApplicationConfigParam;
     /** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
@@ -121,7 +135,7 @@ declare class ServiceabilityPlatformApplicationValidator {
     static updateStoreRulesConfig(): UpdateStoreRulesConfigParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetStoreRuleParam, GetStoreRulesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
+    export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetStoreRuleParam, GetStoreRulesParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
 }
 type CreateCourierPartnerRuleParam = {
     body: ServiceabilityPlatformModel.CourierPartnerRule;
@@ -161,6 +175,44 @@ type GetStoreRulesParam = {
     pageSize?: number;
     status?: string;
 };
+type GetZonesParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Status of Zone (either active or inactive)
+     */
+    isActive?: boolean;
+    /**
+     * - Search with name as a free text
+     */
+    q?: string;
+    /**
+     * - ISO2 code of the country
+     */
+    countryIsoCode?: string;
+    /**
+     * - State name
+     */
+    state?: string;
+    /**
+     * - City name
+     */
+    city?: string;
+    /**
+     * - Pincode value to search zones
+     */
+    pincode?: string;
+    /**
+     * - Sector value to search zones
+     */
+    sector?: string;
+};
 type InsertApplicationConfigParam = {
     body: ServiceabilityPlatformModel.StoreRuleConfigData;
 };

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -43,6 +43,19 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} [status]
  */
 
+/**
+ * @typedef GetZonesParam
+ * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {boolean} [isActive] - Status of Zone (either active or inactive)
+ * @property {string} [q] - Search with name as a free text
+ * @property {string} [countryIsoCode] - ISO2 code of the country
+ * @property {string} [state] - State name
+ * @property {string} [city] - City name
+ * @property {string} [pincode] - Pincode value to search zones
+ * @property {string} [sector] - Sector value to search zones
+ */
+
 /**
  * @typedef InsertApplicationConfigParam
  * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
@@ -163,6 +176,22 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetZonesParam} */
+  static getZones() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isActive: Joi.boolean(),
+
+      q: Joi.string().allow(""),
+      countryIsoCode: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      sector: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {InsertApplicationConfigParam} */
   static insertApplicationConfig() {
     return Joi.object({

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

@@ -236,16 +236,6 @@ declare class Serviceability {
      * @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
      */
     getZoneById({ zoneId, requestHeaders }?: ServiceabilityPlatformValidator.GetZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
-    /**
-     * @param {ServiceabilityPlatformValidator.GetZonesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
-     * @name getZones
-     * @summary: Get zones
-     * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
-     */
-    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

@@ -1714,125 +1714,6 @@ class Serviceability {
     return response;
   }
 
-  /**
-   * @param {ServiceabilityPlatformValidator.GetZonesParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.ListViewResponse>} - Success response
-   * @name getZones
-   * @summary: Get zones
-   * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
-   */
-  async getZones(
-    {
-      pageNo,
-      pageSize,
-      isActive,
-      channelId,
-      q,
-      countryIsoCode,
-      state,
-      city,
-      pincode,
-      sector,
-      requestHeaders,
-    } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = ServiceabilityPlatformValidator.getZones().validate(
-      {
-        pageNo,
-        pageSize,
-        isActive,
-        channelId,
-        q,
-        countryIsoCode,
-        state,
-        city,
-        pincode,
-        sector,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ServiceabilityPlatformValidator.getZones().validate(
-      {
-        pageNo,
-        pageSize,
-        isActive,
-        channelId,
-        q,
-        countryIsoCode,
-        state,
-        city,
-        pincode,
-        sector,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Serviceability > getZones \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-    query_params["is_active"] = isActive;
-    query_params["channel_id"] = channelId;
-    query_params["q"] = q;
-    query_params["country_iso_code"] = countryIsoCode;
-    query_params["state"] = state;
-    query_params["city"] = city;
-    query_params["pincode"] = pincode;
-    query_params["sector"] = sector;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/logistics/v2.0/company/${this.config.companyId}/zones`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = ServiceabilityPlatformModel.ListViewResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Serviceability > getZones \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
    *   - Arg object

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

@@ -107,19 +107,6 @@ export = ServiceabilityPlatformValidator;
  * @typedef GetZoneByIdParam
  * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
  */
-/**
- * @typedef GetZonesParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
- * @property {string} [q] - Search with name as a free text
- * @property {string} [countryIsoCode] - ISO2 code of the country
- * @property {string} [state] - State name
- * @property {string} [city] - City name
- * @property {string} [pincode] - Pincode value to search zones
- * @property {string} [sector] - Sector value to search zones
- */
 /**
  * @typedef UpdateCompanyConfigurationParam
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -192,8 +179,6 @@ declare class ServiceabilityPlatformValidator {
     static getServiceability(): GetServiceabilityParam;
     /** @returns {GetZoneByIdParam} */
     static getZoneById(): GetZoneByIdParam;
-    /** @returns {GetZonesParam} */
-    static getZones(): GetZonesParam;
     /** @returns {UpdateCompanyConfigurationParam} */
     static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
     /** @returns {UpdateCourierPartnerAccountParam} */
@@ -208,7 +193,7 @@ declare class ServiceabilityPlatformValidator {
     static updateZoneById(): UpdateZoneByIdParam;
 }
 declare namespace ServiceabilityPlatformValidator {
-    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
+    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
 }
 type BulkServiceabilityParam = {
     /**
@@ -437,48 +422,6 @@ type GetZoneByIdParam = {
      */
     zoneId: string;
 };
-type GetZonesParam = {
-    /**
-     * - Index of the item to start returning with
-     */
-    pageNo?: number;
-    /**
-     * - Determines the items to be displayed in a page
-     */
-    pageSize?: number;
-    /**
-     * - Status of Zone (either active or inactive)
-     */
-    isActive?: boolean;
-    /**
-     * - Zones filtered by an application
-     */
-    channelId?: string;
-    /**
-     * - Search with name as a free text
-     */
-    q?: string;
-    /**
-     * - ISO2 code of the country
-     */
-    countryIsoCode?: string;
-    /**
-     * - State name
-     */
-    state?: string;
-    /**
-     * - City name
-     */
-    city?: string;
-    /**
-     * - Pincode value to search zones
-     */
-    pincode?: string;
-    /**
-     * - Sector value to search zones
-     */
-    sector?: string;
-};
 type UpdateCompanyConfigurationParam = {
     body: ServiceabilityPlatformModel.CompanyConfig;
 };

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -129,20 +129,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
  */
 
-/**
- * @typedef GetZonesParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
- * @property {string} [q] - Search with name as a free text
- * @property {string} [countryIsoCode] - ISO2 code of the country
- * @property {string} [state] - State name
- * @property {string} [city] - City name
- * @property {string} [pincode] - Pincode value to search zones
- * @property {string} [sector] - Sector value to search zones
- */
-
 /**
  * @typedef UpdateCompanyConfigurationParam
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -348,22 +334,6 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetZonesParam} */
-  static getZones() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isActive: Joi.boolean(),
-      channelId: Joi.string().allow(""),
-      q: Joi.string().allow(""),
-      countryIsoCode: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      pincode: Joi.string().allow(""),
-      sector: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {UpdateCompanyConfigurationParam} */
   static updateCompanyConfiguration() {
     return Joi.object({