@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -633,11 +633,17 @@ export = PaymentPlatformModel;
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {Object} [extra_meta]
- * @property {string} [order_id]
- * @property {string} [payment_id]
- * @property {string} [current_status]
+ * @property {string} [order_id] - Fynd Platform order ID
+ * @property {string} [payment_id] - A unique identifier associated with a
+ *   specific payment transaction
+ * @property {string} [current_status] - Represents the current state or
+ *   condition of an object, such as an order or payment.
  * @property {string} [payment_gateway]
- * @property {string} [key]
+ * @property {string} [key] - Specifies the name or identifier of the payment
+ *   gateway. This will deprecated in future version. We recommend switching to
+ *   `payment_gateway_slug` to ensure uninterrupted payment processing.
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
+ *   that represents the name of the payment gateway and it will used for refund PG.
  */
 /**
  * @typedef MultiTenderPaymentMethod
@@ -3443,11 +3449,32 @@ type OrderBeneficiaryResponse = {
 declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
 type MultiTenderPaymentMeta = {
     extra_meta?: any;
+    /**
+     * - Fynd Platform order ID
+     */
     order_id?: string;
+    /**
+     * - A unique identifier associated with a
+     * specific payment transaction
+     */
     payment_id?: string;
+    /**
+     * - Represents the current state or
+     * condition of an object, such as an order or payment.
+     */
     current_status?: string;
     payment_gateway?: string;
+    /**
+     * - Specifies the name or identifier of the payment
+     * gateway. This will deprecated in future version. We recommend switching to
+     * `payment_gateway_slug` to ensure uninterrupted payment processing.
+     */
     key?: string;
+    /**
+     * - A simplified, URL-friendly string
+     * that represents the name of the payment gateway and it will used for refund PG.
+     */
+    payment_gateway_slug?: string;
 };
 /** @returns {MultiTenderPaymentMethod} */
 declare function MultiTenderPaymentMethod(): MultiTenderPaymentMethod;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -704,11 +704,17 @@ const Joi = require("joi");
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {Object} [extra_meta]
- * @property {string} [order_id]
- * @property {string} [payment_id]
- * @property {string} [current_status]
+ * @property {string} [order_id] - Fynd Platform order ID
+ * @property {string} [payment_id] - A unique identifier associated with a
+ *   specific payment transaction
+ * @property {string} [current_status] - Represents the current state or
+ *   condition of an object, such as an order or payment.
  * @property {string} [payment_gateway]
- * @property {string} [key]
+ * @property {string} [key] - Specifies the name or identifier of the payment
+ *   gateway. This will deprecated in future version. We recommend switching to
+ *   `payment_gateway_slug` to ensure uninterrupted payment processing.
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
+ *   that represents the name of the payment gateway and it will used for refund PG.
  */
 
 /**
@@ -3301,6 +3307,7 @@ class PaymentPlatformModel {
       current_status: Joi.string().allow(""),
       payment_gateway: Joi.string().allow(""),
       key: Joi.string().allow(""),
+      payment_gateway_slug: Joi.string().allow(""),
     });
   }
 

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

@@ -369,7 +369,7 @@ declare class Serviceability {
      * @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({ stage, type, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponseV2>;
+    getZones({ stage, type, accessLevel, status, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponseV2>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -2280,6 +2280,8 @@ class Serviceability {
     {
       stage,
       type,
+      accessLevel,
+      status,
       pageSize,
       pageNo,
       isActive,
@@ -2299,6 +2301,8 @@ class Serviceability {
       {
         stage,
         type,
+        accessLevel,
+        status,
         pageSize,
         pageNo,
         isActive,
@@ -2322,6 +2326,8 @@ class Serviceability {
       {
         stage,
         type,
+        accessLevel,
+        status,
         pageSize,
         pageNo,
         isActive,
@@ -2344,6 +2350,8 @@ class Serviceability {
     const query_params = {};
     query_params["stage"] = stage;
     query_params["type"] = type;
+    query_params["access_level"] = accessLevel;
+    query_params["status"] = status;
     query_params["page_size"] = pageSize;
     query_params["page_no"] = pageNo;
     query_params["is_active"] = isActive;

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

@@ -115,6 +115,10 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef GetZonesParam
  * @property {string} [stage] - Identifies the specific stage of zone bing requested.
  * @property {string} [type] - Using type, you can filter custom or default zones
+ * @property {string} [accessLevel] - Using access level, you can filter public
+ *   and private zones as marketplace owner
+ * @property {string} [status] - Using status zones listing can be filttered for
+ *   marketplace owner and 3p sellers
  * @property {number} [pageSize] - Defines the number of items displayed per page.
  * @property {number} [pageNo] - Current page number.
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
@@ -454,6 +458,16 @@ type GetZonesParam = {
      * - Using type, you can filter custom or default zones
      */
     type?: string;
+    /**
+     * - Using access level, you can filter public
+     * and private zones as marketplace owner
+     */
+    accessLevel?: string;
+    /**
+     * - Using status zones listing can be filttered for
+     * marketplace owner and 3p sellers
+     */
+    status?: string;
     /**
      * - Defines the number of items displayed per page.
      */

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -145,6 +145,10 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @typedef GetZonesParam
  * @property {string} [stage] - Identifies the specific stage of zone bing requested.
  * @property {string} [type] - Using type, you can filter custom or default zones
+ * @property {string} [accessLevel] - Using access level, you can filter public
+ *   and private zones as marketplace owner
+ * @property {string} [status] - Using status zones listing can be filttered for
+ *   marketplace owner and 3p sellers
  * @property {number} [pageSize] - Defines the number of items displayed per page.
  * @property {number} [pageNo] - Current page number.
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
@@ -437,6 +441,8 @@ class ServiceabilityPlatformApplicationValidator {
     return Joi.object({
       stage: Joi.string().allow(""),
       type: Joi.string().allow(""),
+      accessLevel: Joi.string().allow(""),
+      status: Joi.string().allow(""),
       pageSize: Joi.number(),
       pageNo: Joi.number(),
       isActive: Joi.boolean(),

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

@@ -174,6 +174,30 @@ declare class Serviceability {
         q?: string;
         name?: string;
     }): Paginator<ServiceabilityPlatformModel.GetLocalities>;
+    /**
+     * @param {ServiceabilityPlatformValidator.GetLocalitiesByPrefixParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.GetLocalities>} - Success response
+     * @name getLocalitiesByPrefix
+     * @summary: Get Localities by Name Prefix
+     * @description: Get localities that start with a specified prefix. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getLocalitiesByPrefix/).
+     */
+    getLocalitiesByPrefix({ pageNo, pageSize, q, requestHeaders }?: ServiceabilityPlatformValidator.GetLocalitiesByPrefixParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetLocalities>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Number of items per page.
+     * @param {string} [arg.q] - Localities starting with the specified prefix.
+     * @returns {Paginator<ServiceabilityPlatformModel.GetLocalities>}
+     * @summary: Get Localities by Name Prefix
+     * @description: Get localities that start with a specified prefix.
+     */
+    getLocalitiesByPrefixPaginator({ pageSize, q }?: {
+        pageSize?: number;
+        q?: string;
+    }): Paginator<ServiceabilityPlatformModel.GetLocalities>;
     /**
      * @param {ServiceabilityPlatformValidator.GetLocalityParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js

@@ -1148,6 +1148,125 @@ class Serviceability {
     return paginator;
   }
 
+  /**
+   * @param {ServiceabilityPlatformValidator.GetLocalitiesByPrefixParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ServiceabilityPlatformModel.GetLocalities>} - Success response
+   * @name getLocalitiesByPrefix
+   * @summary: Get Localities by Name Prefix
+   * @description: Get localities that start with a specified prefix. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getLocalitiesByPrefix/).
+   */
+  async getLocalitiesByPrefix(
+    { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ServiceabilityPlatformValidator.getLocalitiesByPrefix().validate(
+      {
+        pageNo,
+        pageSize,
+        q,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ServiceabilityPlatformValidator.getLocalitiesByPrefix().validate(
+      {
+        pageNo,
+        pageSize,
+        q,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Serviceability > getLocalitiesByPrefix \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["q"] = q;
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/logistics/v1.0/company/${this.config.companyId}/localities`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ServiceabilityPlatformModel.GetLocalities().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 > getLocalitiesByPrefix \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] - Number of items per page.
+   * @param {string} [arg.q] - Localities starting with the specified prefix.
+   * @returns {Paginator<ServiceabilityPlatformModel.GetLocalities>}
+   * @summary: Get Localities by Name Prefix
+   * @description: Get localities that start with a specified prefix.
+   */
+  getLocalitiesByPrefixPaginator({ pageSize, q } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getLocalitiesByPrefix({
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {ServiceabilityPlatformValidator.GetLocalityParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`