@gofynd/fdk-client-javascript 3.16.2 → 3.17.0

package/README.md

@@ -234,7 +234,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: 3.16.2' --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: 3.17.0' --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": "3.16.2",
+  "version": "3.17.0",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -42,4 +42,4 @@
     "!dist",
     "!cypress"
   ]
-}
+}

package/sdk/application/ApplicationClient.d.ts

@@ -20,7 +20,6 @@ declare class ApplicationClient {
     logistic: Logistic;
     order: Order;
     payment: Payment;
-    rewards: Rewards;
     share: Share;
     theme: Theme;
     user: User;
@@ -78,7 +77,6 @@ import Lead = require("./Lead/LeadApplicationClient");
 import Logistic = require("./Logistic/LogisticApplicationClient");
 import Order = require("./Order/OrderApplicationClient");
 import Payment = require("./Payment/PaymentApplicationClient");
-import Rewards = require("./Rewards/RewardsApplicationClient");
 import Share = require("./Share/ShareApplicationClient");
 import Theme = require("./Theme/ThemeApplicationClient");
 import User = require("./User/UserApplicationClient");

package/sdk/application/ApplicationClient.js

@@ -10,7 +10,6 @@ const Lead = require("./Lead/LeadApplicationClient");
 const Logistic = require("./Logistic/LogisticApplicationClient");
 const Order = require("./Order/OrderApplicationClient");
 const Payment = require("./Payment/PaymentApplicationClient");
-const Rewards = require("./Rewards/RewardsApplicationClient");
 const Share = require("./Share/ShareApplicationClient");
 const Theme = require("./Theme/ThemeApplicationClient");
 const User = require("./User/UserApplicationClient");
@@ -47,7 +46,6 @@ class ApplicationClient {
     this.logistic = new Logistic(this.config);
     this.order = new Order(this.config);
     this.payment = new Payment(this.config);
-    this.rewards = new Rewards(this.config);
     this.share = new Share(this.config);
     this.theme = new Theme(this.config);
     this.user = new User(this.config);

package/sdk/application/Content/ContentApplicationClient.d.ts

@@ -8,6 +8,7 @@ declare class Content {
         getAnnouncements: string;
         getBlog: string;
         getBlogs: string;
+        getBulkCustomFieldsByResource: string;
         getCustomFieldsByResourceId: string;
         getCustomObjectBySlug: string;
         getDataLoaders: string;
@@ -75,6 +76,15 @@ declare class Content {
      * @description: List all the blogs against an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlogs/).
      */
     getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetDetails>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<BulkCustomFieldsResponseByResourceSchema>} - Success response
+     * @name getBulkCustomFieldsByResource
+     * @summary: Get bulk list of custom fields of given resource
+     * @description: Retrieves a bulk list of custom fields attached to a particular resource by using the resource and resource IDs. The resource_ids query parameter is required and can accept multiple comma-separated values. Optional filters for keys and namespaces can also be applied. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBulkCustomFieldsByResource/).
+     */
+    getBulkCustomFieldsByResource({ resource, resourceIds, keys, namespaces, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BulkCustomFieldsResponseByResourceSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Content/ContentApplicationClient.js

@@ -19,6 +19,8 @@ class Content {
       getAnnouncements: "/service/application/content/v1.0/announcements",
       getBlog: "/service/application/content/v1.0/blogs/{slug}",
       getBlogs: "/service/application/content/v1.0/blogs",
+      getBulkCustomFieldsByResource:
+        "/service/application/content/v2.0/customfields/resource/{resource}",
       getCustomFieldsByResourceId:
         "/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}",
       getCustomObjectBySlug:
@@ -280,6 +282,57 @@ class Content {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<BulkCustomFieldsResponseByResourceSchema>} - Success response
+   * @name getBulkCustomFieldsByResource
+   * @summary: Get bulk list of custom fields of given resource
+   * @description: Retrieves a bulk list of custom fields attached to a particular resource by using the resource and resource IDs. The resource_ids query parameter is required and can accept multiple comma-separated values. Optional filters for keys and namespaces can also be applied. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBulkCustomFieldsByResource/).
+   */
+  async getBulkCustomFieldsByResource(
+    { resource, resourceIds, keys, namespaces, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const errors = validateRequiredParams(arguments[0], ["resource"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["resource_ids"] = resourceIds;
+    query_params["keys"] = keys;
+    query_params["namespaces"] = namespaces;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getBulkCustomFieldsByResource"],
+        params: { resource },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Logistic/LogisticApplicationClient.d.ts

@@ -6,12 +6,11 @@ declare class Logistic {
         getAllCountries: string;
         getCountries: string;
         getCountry: string;
-        getCourierPartners: string;
         getDeliveryPromise: string;
+        getFulfillmentOptionStores: string;
         getFulfillmentOptions: string;
         getLocalities: string;
         getLocality: string;
-        getPincodeCity: string;
         validateAddress: string;
     };
     _urls: {};
@@ -46,21 +45,21 @@ declare class Logistic {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ShipmentCourierPartnerResult>} - Success response
-     * @name getCourierPartners
-     * @summary: Serviceable Courier Partners
-     * @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
+     * @returns {Promise<GetPromiseDetails>} - Success response
+     * @name getDeliveryPromise
+     * @summary: Get delivery promise
+     * @description: Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
      */
-    getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentCourierPartnerResult>;
+    getDeliveryPromise({ xLocationDetail, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<GetPromiseDetails>} - Success response
-     * @name getDeliveryPromise
-     * @summary: Get delivery promise
-     * @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
+     * @returns {Promise<FulfillmentOptionStores>} - Success response
+     * @name getFulfillmentOptionStores
+     * @summary: Get Fulfillment Option Stores
+     * @description: Fetches a paginated list of stores associated with a given fulfillment option slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptionStores/).
      */
-    getDeliveryPromise({ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
+    getFulfillmentOptionStores({ slug, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FulfillmentOptionStores>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -88,15 +87,6 @@ declare class Logistic {
      * @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocality/).
      */
     getLocality({ localityType, localityValue, country, state, city, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalityApp>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PincodeDetailsResult>} - Success response
-     * @name getPincodeCity
-     * @summary: Get pincode details
-     * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
-     */
-    getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeDetailsResult>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Logistic/LogisticApplicationClient.js

@@ -16,17 +16,16 @@ class Logistic {
       getCountries: "/service/application/logistics/v2.0/countries",
       getCountry:
         "/service/application/logistics/v1.0/countries/{country_iso_code}",
-      getCourierPartners:
-        "/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
       getDeliveryPromise:
         "/service/application/logistics/v1.0/delivery-promise",
+      getFulfillmentOptionStores:
+        "/service/application/logistics/v1.0/fulfillment-options/{slug}/stores",
       getFulfillmentOptions:
         "/service/application/logistics/v1.0/fulfillment-options",
       getLocalities:
         "/service/application/logistics/v1.0/localities/{locality_type}",
       getLocality:
         "/service/application/logistics/v1.0/localities/{locality_type}/{locality_value}",
-      getPincodeCity: "/service/application/logistics/v1.0/pincode/{pincode}",
       validateAddress:
         "/service/application/logistics/v1.0/country/{country_iso_code}/address/templates/{template_name}/validate",
     };
@@ -183,40 +182,33 @@ class Logistic {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ShipmentCourierPartnerResult>} - Success response
-   * @name getCourierPartners
-   * @summary: Serviceable Courier Partners
-   * @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
+   * @returns {Promise<GetPromiseDetails>} - Success response
+   * @name getDeliveryPromise
+   * @summary: Get delivery promise
+   * @description: Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
    */
-  async getCourierPartners(
-    { companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
+  async getDeliveryPromise(
+    { xLocationDetail, pageNo, pageSize, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const errors = validateRequiredParams(arguments[0], [
-      "companyId",
-      "applicationId",
-    ]);
-    if (errors.length > 0) {
-      const error = new FDKClientValidationError({
-        message: "Missing required field",
-        details: errors,
-      });
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
 
     const xHeaders = {};
+    xHeaders["x-location-detail"] = xLocationDetail;
 
     const response = await ApplicationAPIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["getCourierPartners"],
-        params: { companyId, applicationId },
+        url: this._urls["getDeliveryPromise"],
+        params: {},
       }),
       query_params,
-      body,
+      undefined,
       { ...xHeaders, ...requestHeaders },
       { responseHeaders }
     );
@@ -232,31 +224,36 @@ class Logistic {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<GetPromiseDetails>} - Success response
-   * @name getDeliveryPromise
-   * @summary: Get delivery promise
-   * @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
+   * @returns {Promise<FulfillmentOptionStores>} - Success response
+   * @name getFulfillmentOptionStores
+   * @summary: Get Fulfillment Option Stores
+   * @description: Fetches a paginated list of stores associated with a given fulfillment option slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptionStores/).
    */
-  async getDeliveryPromise(
-    { xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders } = {
-      requestHeaders: {},
-    },
+  async getFulfillmentOptionStores(
+    { slug, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    const errors = validateRequiredParams(arguments[0], ["slug"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
     const xHeaders = {};
-    xHeaders["x-location-detail"] = xLocationDetail;
-    xHeaders["x-application-data"] = xApplicationData;
 
     const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getDeliveryPromise"],
-        params: {},
+        url: this._urls["getFulfillmentOptionStores"],
+        params: { slug },
       }),
       query_params,
       undefined,
@@ -438,52 +435,6 @@ class Logistic {
     return response;
   }
 
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PincodeDetailsResult>} - Success response
-   * @name getPincodeCity
-   * @summary: Get pincode details
-   * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
-   */
-  async getPincodeCity(
-    { pincode, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const errors = validateRequiredParams(arguments[0], ["pincode"]);
-    if (errors.length > 0) {
-      const error = new FDKClientValidationError({
-        message: "Missing required field",
-        details: errors,
-      });
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getPincodeCity"],
-        params: { pincode },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Order/OrderApplicationClient.d.ts

@@ -8,6 +8,7 @@ declare class Order {
         getOrderById: string;
         getOrders: string;
         getPosOrderById: string;
+        getRefundModes: string;
         getShipmentBagReasons: string;
         getShipmentById: string;
         getShipmentReasons: string;
@@ -64,6 +65,16 @@ declare class Order {
      * @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
      */
     getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RefundOptions>} - Success response
+     * @name getRefundModes
+     * @summary: Get refund modes for a shipment
+     * @description: Returns a list of available refund options for the given company and shipment.
+     *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getRefundModes/).
+     */
+    getRefundModes({ shipmentId, lineNumbers, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<RefundOptions>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Order/OrderApplicationClient.js

@@ -20,6 +20,8 @@ class Order {
       getOrders: "/service/application/order/v1.0/orders",
       getPosOrderById:
         "/service/application/order/v1.0/orders/pos-order/{order_id}",
+      getRefundModes:
+        "/service/application/order-manage/v1.0/shipment/{shipment_id}/refund/modes",
       getShipmentBagReasons:
         "/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons",
       getShipmentById:
@@ -298,6 +300,54 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RefundOptions>} - Success response
+   * @name getRefundModes
+   * @summary: Get refund modes for a shipment
+   * @description: Returns a list of available refund options for the given company and shipment.
+   *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getRefundModes/).
+   */
+  async getRefundModes(
+    { shipmentId, lineNumbers, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["line_numbers"] = lineNumbers;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getRefundModes"],
+        params: { shipmentId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Payment/PaymentApplicationClient.d.ts

@@ -310,21 +310,21 @@ declare class Payment {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<RefundBeneficiaries>} - Success response
+     * @returns {Promise<GetRefundBeneficiary>} - Success response
      * @name getRefundBeneficiaries
      * @summary: Get Refund Beneficiaries
      * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user.   Both `order_id` and `shipment_id` are optional query parameters.   Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
      */
-    getRefundBeneficiaries({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundBeneficiaries>;
+    getRefundBeneficiaries({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetRefundBeneficiary>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<RefundBeneficiaries>} - Success response
+     * @returns {Promise<GetRefundBeneficiary>} - Success response
      * @name getRefundBeneficiariesUsingOTPSession
      * @summary: Get Refund Beneficiaries using OTP session
      * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).
      */
-    getRefundBeneficiariesUsingOTPSession({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundBeneficiaries>;
+    getRefundBeneficiariesUsingOTPSession({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetRefundBeneficiary>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Payment/PaymentApplicationClient.js

@@ -1219,19 +1219,18 @@ class Payment {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<RefundBeneficiaries>} - Success response
+   * @returns {Promise<GetRefundBeneficiary>} - Success response
    * @name getRefundBeneficiaries
    * @summary: Get Refund Beneficiaries
    * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user.   Both `order_id` and `shipment_id` are optional query parameters.   Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
    */
   async getRefundBeneficiaries(
-    { orderId, shipmentId, filterBy, requestHeaders } = { requestHeaders: {} },
+    { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const query_params = {};
     query_params["order_id"] = orderId;
     query_params["shipment_id"] = shipmentId;
-    query_params["filter_by"] = filterBy;
 
     const xHeaders = {};
 
@@ -1259,7 +1258,7 @@ class Payment {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<RefundBeneficiaries>} - Success response
+   * @returns {Promise<GetRefundBeneficiary>} - Success response
    * @name getRefundBeneficiariesUsingOTPSession
    * @summary: Get Refund Beneficiaries using OTP session
    * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).

package/sdk/application/User/UserApplicationClient.d.ts

@@ -9,6 +9,7 @@ declare class User {
         deleteMobileNumber: string;
         deleteUser: string;
         forgotPassword: string;
+        getAttributesDefinition: string;
         getListOfActiveSessions: string;
         getLoggedInUser: string;
         getPlatformConfig: string;
@@ -107,6 +108,15 @@ declare class User {
      * @description: Reset a password using the code sent on email or sms the login. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/forgotPassword/).
      */
     forgotPassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name getAttributesDefinition
+     * @summary: Get User Attribute Definitions
+     * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getAttributesDefinition/).
+     */
+    getAttributesDefinition({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, registrationEnabled, registrationType, pageSize, pageNo, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<any>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/User/UserApplicationClient.js

@@ -19,6 +19,8 @@ class User {
       deleteUser: "/service/application/user/authentication/v1.0/delete",
       forgotPassword:
         "/service/application/user/authentication/v1.0/login/password/reset/forgot",
+      getAttributesDefinition:
+        "/service/application/user/profile/v1.0/attributes/definition",
       getListOfActiveSessions:
         "/service/application/user/authentication/v1.0/sessions",
       getLoggedInUser: "/service/application/user/authentication/v1.0/session",
@@ -353,6 +355,71 @@ class User {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<Object>} - Success response
+   * @name getAttributesDefinition
+   * @summary: Get User Attribute Definitions
+   * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getAttributesDefinition/).
+   */
+  async getAttributesDefinition(
+    {
+      excludingIds,
+      slug,
+      type,
+      customerEditable,
+      encrypted,
+      pinned,
+      pinOrder,
+      isLocked,
+      name,
+      registrationEnabled,
+      registrationType,
+      pageSize,
+      pageNo,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const query_params = {};
+    query_params["excluding_ids"] = excludingIds;
+    query_params["slug"] = slug;
+    query_params["type"] = type;
+    query_params["customer_editable"] = customerEditable;
+    query_params["encrypted"] = encrypted;
+    query_params["pinned"] = pinned;
+    query_params["pin_order"] = pinOrder;
+    query_params["is_locked"] = isLocked;
+    query_params["name"] = name;
+    query_params["registration_enabled"] = registrationEnabled;
+    query_params["registration_type"] = registrationType;
+    query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getAttributesDefinition"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options