@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -1,5 +1,21 @@
 const Joi = require("joi");
 
+/**
+ * @typedef AggregatorToken
+ * @property {number} payment_mode_id - Payment mode identifier Supported values are:
+ *
+ *   - **4**: Wallet
+ *   - **3**: Net Banking
+ *   - **2**: Card
+ *   - **1**: Pay Later
+ *
+ * @property {string} sub_payment_mode_code - Sub-payment method code
+ * @property {string} token - Token value to be saved for the aggregator
+ * @property {string} status - Status of the token verification
+ * @property {boolean} is_active - Enable or Disable Flag
+ * @property {string} domain - Name of domain
+ */
+
 /**
  * @typedef PaymentGatewayConfigDetails
  * @property {Object[]} [aggregators] - List of all config specific to the
@@ -388,16 +404,18 @@ const Joi = require("joi");
 
 /**
  * @typedef BankDetailsForOTP
- * @property {string} ifsc_code - IFSC code of account
- * @property {string} account_no - Account number
- * @property {string} branch_name - Branch name of account
- * @property {string} bank_name - Bank name of account
- * @property {string} account_holder - Accountg holder name of account
+ * @property {string} [ifsc_code] - IFSC code of account
+ * @property {string} [account_no] - Account number
+ * @property {string} [branch_name] - Branch name of account
+ * @property {string} [bank_name] - Bank name of account
+ * @property {string} [account_holder] - Accountg holder name of account
+ * @property {string} [upi] - UPI ID of account holder
  */
 
 /**
  * @typedef AddBeneficiaryDetailsOTPCreation
  * @property {string} order_id - Order_id for which account will be added
+ * @property {string} [shipment_id] - Shipment_id for which account will be added
  * @property {BankDetailsForOTP} details
  */
 
@@ -822,6 +840,100 @@ const Joi = require("joi");
  * @property {boolean} success - Response is successful or not.
  */
 
+/**
+ * @typedef PaymentModeConfig
+ * @property {string} [business_unit] - Business unit for which the configuration applies.
+ * @property {string} [device] - Device type for which the configuration applies.
+ * @property {boolean} [is_active] - Indicates if the payment configuration is
+ *   currently active.
+ * @property {PaymentModeItems[]} [items] - List of payment modes available for
+ *   the given business unit and device. This list is dynamic and can contain
+ *   one or more payment modes.
+ */
+
+/**
+ * @typedef PaymentModeItems
+ * @property {number} [id] - Unique identifier for the payment mode.
+ * @property {string} [name] - Display name of the payment mode.
+ * @property {string} [short_code] - Short code for the payment mode.
+ * @property {LogoSet} [logos]
+ * @property {boolean} [is_active] - Indicates if this payment mode is active in
+ *   the system.
+ * @property {SubPaymentMode[]} [sub_payment_mode] - Dynamic list of sub-payment
+ *   modes under this payment mode.
+ * @property {boolean} [is_active_at_pg] - Indicates if this payment mode is
+ *   active at the payment gateway (PG) side.
+ * @property {Object} [fulfillment_options] - Fulfillment options applicable for
+ *   these payment modes. Keys are option slugs and values indicate whether the
+ *   option is enabled.
+ */
+
+/**
+ * @typedef SubPaymentMode
+ * @property {string} [code] - Unique code of the sub-payment mode.
+ * @property {boolean} [is_active] - Indicates if this sub-payment mode is
+ *   active in the system.
+ * @property {number} [priority] - Priority used for ordering in UI. Lower
+ *   numbers can represent higher priority, depending on implementation.
+ * @property {LogoSet} [logos]
+ * @property {string} [name] - Human-readable name of the sub-payment mode.
+ * @property {boolean} [is_active_at_pg] - Indicates if this sub-payment mode is
+ *   active at the payment gateway (PG) side.
+ */
+
+/**
+ * @typedef LogoSet
+ * @property {string} [large] - URL of the large-sized logo.
+ * @property {string} [small] - URL of the small-sized logo.
+ */
+
+/**
+ * @typedef PlatformLogoSet
+ * @property {string} [large] - URL of the large-sized logo.
+ * @property {string} [small] - URL of the small-sized logo.
+ */
+
+/**
+ * @typedef PlatformConfigPaymentModeDetails
+ * @property {string} [business_unit] - Business unit for which the
+ *   configuration applies (e.g. "storefront", "pos").
+ * @property {string} [device] - Device or channel for which the configuration
+ *   applies (e.g. "desktop", "android", "ios").
+ * @property {Object} [fulfillment_options] - Fulfillment options applicable for
+ *   these payment modes. Keys are option slugs (e.g. "self-pickup", "delivery")
+ *   and values indicate whether the option is enabled.
+ * @property {boolean} [is_active] - Overall active status for this aggregator
+ *   payment configuration for the given application and device.
+ * @property {PlatformPaymentModeItem[]} [items] - List of payment modes and
+ *   their configuration.
+ */
+
+/**
+ * @typedef PlatformPaymentModeItem
+ * @property {number} [id] - Unique identifier of the payment mode.
+ * @property {string} [name] - Human readable name of the payment mode.
+ * @property {string} [short_code] - Short code representing the payment mode.
+ * @property {PlatformLogoSet} [logos]
+ * @property {boolean} [is_active] - Indicates if the payment mode is enabled on
+ *   the platform.
+ * @property {boolean} [is_active_at_pg] - Indicates if the payment mode is
+ *   active at the payment gateway.
+ * @property {PlatformSubPaymentMode[]} [sub_payment_mode] - List of sub payment
+ *   modes (e.g. card networks like VISA, MASTERCARD).
+ */
+
+/**
+ * @typedef PlatformSubPaymentMode
+ * @property {string} [code] - Code of the sub payment mode (e.g. "VISA", "AMEX").
+ * @property {string} [name] - Human readable name of the sub payment mode.
+ * @property {boolean} [is_active] - Indicates if the sub payment mode is enabled.
+ * @property {boolean} [is_active_at_pg] - Indicates if the sub payment mode is
+ *   active at payment gateway.
+ * @property {number} [priority] - Display priority for the sub payment mode.
+ *   Lower numbers indicate higher priority.
+ * @property {PlatformLogoSet} [logos]
+ */
+
 /**
  * @typedef MerchnatPaymentModeCreation
  * @property {Object} [offline] - Details to be updated for online payment configuration.
@@ -1291,7 +1403,26 @@ const Joi = require("joi");
  * @property {CreditAccountSummary} [account]
  */
 
+/**
+ * @typedef OperationResponseSchema
+ * @property {boolean} success - Indicates if the operation was successful
+ * @property {string} [message] - Optional message providing additional
+ *   information about the operation
+ */
+
 class PaymentPlatformModel {
+  /** @returns {AggregatorToken} */
+  static AggregatorToken() {
+    return Joi.object({
+      payment_mode_id: Joi.number().required(),
+      sub_payment_mode_code: Joi.string().allow("").required(),
+      token: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+      is_active: Joi.boolean().required(),
+      domain: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {PaymentGatewayConfigDetails} */
   static PaymentGatewayConfigDetails() {
     return Joi.object({
@@ -1778,11 +1909,12 @@ class PaymentPlatformModel {
   /** @returns {BankDetailsForOTP} */
   static BankDetailsForOTP() {
     return Joi.object({
-      ifsc_code: Joi.string().allow("").required(),
-      account_no: Joi.string().allow("").required(),
-      branch_name: Joi.string().allow("").required(),
-      bank_name: Joi.string().allow("").required(),
-      account_holder: Joi.string().allow("").required(),
+      ifsc_code: Joi.string().allow(""),
+      account_no: Joi.string().allow(""),
+      branch_name: Joi.string().allow(""),
+      bank_name: Joi.string().allow(""),
+      account_holder: Joi.string().allow(""),
+      upi: Joi.string().allow("").allow(null),
     });
   }
 
@@ -1790,6 +1922,7 @@ class PaymentPlatformModel {
   static AddBeneficiaryDetailsOTPCreation() {
     return Joi.object({
       order_id: Joi.string().allow("").required(),
+      shipment_id: Joi.string().allow(""),
       details: PaymentPlatformModel.BankDetailsForOTP().required(),
     });
   }
@@ -2301,6 +2434,98 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {PaymentModeConfig} */
+  static PaymentModeConfig() {
+    return Joi.object({
+      business_unit: Joi.string().allow(""),
+      device: Joi.string().allow(""),
+      is_active: Joi.boolean(),
+      items: Joi.array().items(PaymentPlatformModel.PaymentModeItems()),
+    });
+  }
+
+  /** @returns {PaymentModeItems} */
+  static PaymentModeItems() {
+    return Joi.object({
+      id: Joi.number(),
+      name: Joi.string().allow(""),
+      short_code: Joi.string().allow(""),
+      logos: PaymentPlatformModel.LogoSet(),
+      is_active: Joi.boolean(),
+      sub_payment_mode: Joi.array().items(
+        PaymentPlatformModel.SubPaymentMode()
+      ),
+      is_active_at_pg: Joi.boolean(),
+      fulfillment_options: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
+  /** @returns {SubPaymentMode} */
+  static SubPaymentMode() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      is_active: Joi.boolean(),
+      priority: Joi.number(),
+      logos: PaymentPlatformModel.LogoSet(),
+      name: Joi.string().allow(""),
+      is_active_at_pg: Joi.boolean(),
+    });
+  }
+
+  /** @returns {LogoSet} */
+  static LogoSet() {
+    return Joi.object({
+      large: Joi.string().allow(""),
+      small: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PlatformLogoSet} */
+  static PlatformLogoSet() {
+    return Joi.object({
+      large: Joi.string().allow(""),
+      small: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PlatformConfigPaymentModeDetails} */
+  static PlatformConfigPaymentModeDetails() {
+    return Joi.object({
+      business_unit: Joi.string().allow(""),
+      device: Joi.string().allow(""),
+      fulfillment_options: Joi.object().pattern(/\S/, Joi.any()),
+      is_active: Joi.boolean(),
+      items: Joi.array().items(PaymentPlatformModel.PlatformPaymentModeItem()),
+    });
+  }
+
+  /** @returns {PlatformPaymentModeItem} */
+  static PlatformPaymentModeItem() {
+    return Joi.object({
+      id: Joi.number(),
+      name: Joi.string().allow(""),
+      short_code: Joi.string().allow(""),
+      logos: PaymentPlatformModel.PlatformLogoSet(),
+      is_active: Joi.boolean(),
+      is_active_at_pg: Joi.boolean(),
+      sub_payment_mode: Joi.array().items(
+        PaymentPlatformModel.PlatformSubPaymentMode()
+      ),
+    });
+  }
+
+  /** @returns {PlatformSubPaymentMode} */
+  static PlatformSubPaymentMode() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      is_active: Joi.boolean(),
+      is_active_at_pg: Joi.boolean(),
+      priority: Joi.number(),
+      logos: PaymentPlatformModel.PlatformLogoSet(),
+    });
+  }
+
   /** @returns {MerchnatPaymentModeCreation} */
   static MerchnatPaymentModeCreation() {
     return Joi.object({
@@ -2827,5 +3052,13 @@ class PaymentPlatformModel {
       account: PaymentPlatformModel.CreditAccountSummary(),
     });
   }
+
+  /** @returns {OperationResponseSchema} */
+  static OperationResponseSchema() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+      message: Joi.string().allow(""),
+    });
+  }
 }
 module.exports = PaymentPlatformModel;

package/sdk/platform/PlatformApplicationClient.d.ts

@@ -27,7 +27,6 @@ declare class PlatformApplicationClient {
     order: Order;
     partner: Partner;
     payment: Payment;
-    rewards: Rewards;
     share: Share;
     theme: Theme;
     user: User;
@@ -51,7 +50,6 @@ import Serviceability = require("./Serviceability/ServiceabilityPlatformApplicat
 import Order = require("./Order/OrderPlatformApplicationClient");
 import Partner = require("./Partner/PartnerPlatformApplicationClient");
 import Payment = require("./Payment/PaymentPlatformApplicationClient");
-import Rewards = require("./Rewards/RewardsPlatformApplicationClient");
 import Share = require("./Share/SharePlatformApplicationClient");
 import Theme = require("./Theme/ThemePlatformApplicationClient");
 import User = require("./User/UserPlatformApplicationClient");

package/sdk/platform/PlatformApplicationClient.js

@@ -22,8 +22,6 @@ const Partner = require("./Partner/PartnerPlatformApplicationClient");
 
 const Payment = require("./Payment/PaymentPlatformApplicationClient");
 
-const Rewards = require("./Rewards/RewardsPlatformApplicationClient");
-
 const Share = require("./Share/SharePlatformApplicationClient");
 
 const Theme = require("./Theme/ThemePlatformApplicationClient");
@@ -73,8 +71,6 @@ class PlatformApplicationClient {
 
     this.payment = new Payment(config, applicationId);
 
-    this.rewards = new Rewards(config, applicationId);
-
     this.share = new Share(config, applicationId);
 
     this.theme = new Theme(config, applicationId);

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

@@ -450,19 +450,6 @@ declare class Serviceability {
      * @description: Updates the details of an existing fulfillment option for the specified company and application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/putFulfillmentOption/).
      */
     putFulfillmentOption({ slug, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
-    /**
-     * @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigPut>} -
-     *   Success response
-     * @name updateApplicationConfiguration
-     * @summary: Apply configuration to an application
-     * @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateApplicationConfiguration/).
-     */
-    updateApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPut>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -2917,88 +2917,6 @@ class Serviceability {
     return response;
   }
 
-  /**
-   * @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ServiceabilityPlatformModel.ApplicationConfigPut>} -
-   *   Success response
-   * @name updateApplicationConfiguration
-   * @summary: Apply configuration to an application
-   * @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateApplicationConfiguration/).
-   */
-  async updateApplicationConfiguration(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = ServiceabilityPlatformApplicationValidator.updateApplicationConfiguration().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ServiceabilityPlatformApplicationValidator.updateApplicationConfiguration().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Serviceability > updateApplicationConfiguration \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "put",
-      `/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/configuration`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = ServiceabilityPlatformModel.ApplicationConfigPut().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 > updateApplicationConfiguration \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {ServiceabilityPlatformApplicationValidator.UpdateBulkGeoAreaParam} arg
    *   - Arg object

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

@@ -164,10 +164,6 @@ export = ServiceabilityPlatformApplicationValidator;
  * @property {string} slug - Slug of the fulfillment option for retrieving details.
  * @property {ServiceabilityPlatformModel.FulfillmentOption} body
  */
-/**
- * @typedef UpdateApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
- */
 /**
  * @typedef UpdateBulkGeoAreaParam
  * @property {string} geoareaId - A unique identifier for the GeoArea.
@@ -304,8 +300,6 @@ declare class ServiceabilityPlatformApplicationValidator {
     static patchApplicationConfiguration(): PatchApplicationConfigurationParam;
     /** @returns {PutFulfillmentOptionParam} */
     static putFulfillmentOption(): PutFulfillmentOptionParam;
-    /** @returns {UpdateApplicationConfigurationParam} */
-    static updateApplicationConfiguration(): UpdateApplicationConfigurationParam;
     /** @returns {UpdateBulkGeoAreaParam} */
     static updateBulkGeoArea(): UpdateBulkGeoAreaParam;
     /** @returns {UpdateCourierPartnerRulePriorityParam} */
@@ -336,7 +330,7 @@ declare class ServiceabilityPlatformApplicationValidator {
     static validateBulkFulfillmentOptions(): ValidateBulkFulfillmentOptionsParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
+    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
 }
 type CreateBulkExportParam = {
     body: ServiceabilityPlatformModel.BulkCreateZoneExport;
@@ -622,9 +616,6 @@ type PutFulfillmentOptionParam = {
     slug: string;
     body: ServiceabilityPlatformModel.FulfillmentOption;
 };
-type UpdateApplicationConfigurationParam = {
-    body: ServiceabilityPlatformModel.ApplicationConfigPutDetail;
-};
 type UpdateBulkGeoAreaParam = {
     /**
      * - A unique identifier for the GeoArea.

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -201,11 +201,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.FulfillmentOption} body
  */
 
-/**
- * @typedef UpdateApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
- */
-
 /**
  * @typedef UpdateBulkGeoAreaParam
  * @property {string} geoareaId - A unique identifier for the GeoArea.
@@ -553,13 +548,6 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {UpdateApplicationConfigurationParam} */
-  static updateApplicationConfiguration() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.ApplicationConfigPutDetail().required(),
-    }).required();
-  }
-
   /** @returns {UpdateBulkGeoAreaParam} */
   static updateBulkGeoArea() {
     return Joi.object({