@gofynd/fdk-client-javascript 3.16.3 → 3.17.0

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -61,18 +61,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef CreateOrderDeprecatedParam
- * @property {string} xOrderingSource - To uniquely identify the source through
- *   which order has been placed.
- * @property {string} [xApplicationId] - The Application ID is a unique
- *   identifier assigned to a storefront that typically follows a 24-character
- *   hexadecimal string. Either `x-application-id` or `x-extension-id` header is
- *   mandatory. At least one of them must be provided.
- * @property {string} [xExtensionId] - The Extension ID is a unique identifier
- *   assigned to an extension that typically follows a 24-character hexadecimal
- *   string. Either `x-application-id` or `x-extension-id` header is mandatory.
- *   At least one of them must be provided.
- * @property {OrderPlatformModel.CreateOrderAPI} body
+ * @typedef CreateShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier of the shipment.
+ * @property {OrderPlatformModel.PackagesSchema} body
  */
 
 /**
@@ -370,6 +361,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {number} [bagId] - Identifier for a bag or product.
  */
 
+/**
+ * @typedef GetShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier for the shipment whose
+ *   packages are being retrieved.
+ */
+
 /**
  * @typedef GetShipmentReasonsParam
  * @property {string} shipmentId - ID of the shipment. An order may contain
@@ -485,11 +482,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [groupEntity] - Name of group entity
  */
 
-/**
- * @typedef InvalidateShipmentCacheParam
- * @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
- */
-
 /**
  * @typedef JobDetailsParam
  * @property {string} batchId - A unique identifier for the batch associated
@@ -564,6 +556,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
  */
 
+/**
+ * @typedef UpdateShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier for the shipment whose
+ *   packages will be updated.
+ * @property {OrderPlatformModel.PackagesSchema} body
+ */
+
 /**
  * @typedef UpdateShipmentStatusParam
  * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
@@ -650,13 +649,11 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {CreateOrderDeprecatedParam} */
-  static createOrderDeprecated() {
+  /** @returns {CreateShipmentPackagesParam} */
+  static createShipmentPackages() {
     return Joi.object({
-      xOrderingSource: Joi.string().allow("").required(),
-      xApplicationId: Joi.string().allow(""),
-      xExtensionId: Joi.string().allow(""),
-      body: OrderPlatformModel.CreateOrderAPI().required(),
+      shipmentId: Joi.string().allow("").required(),
+      body: OrderPlatformModel.PackagesSchema().required(),
     }).required();
   }
 
@@ -968,6 +965,13 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetShipmentPackagesParam} */
+  static getShipmentPackages() {
+    return Joi.object({
+      shipmentId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetShipmentReasonsParam} */
   static getShipmentReasons() {
     return Joi.object({
@@ -1052,13 +1056,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {InvalidateShipmentCacheParam} */
-  static invalidateShipmentCache() {
-    return Joi.object({
-      body: OrderPlatformModel.InvalidateShipmentCachePayload().required(),
-    }).required();
-  }
-
   /** @returns {JobDetailsParam} */
   static jobDetails() {
     return Joi.object({
@@ -1156,6 +1153,14 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {UpdateShipmentPackagesParam} */
+  static updateShipmentPackages() {
+    return Joi.object({
+      shipmentId: Joi.string().allow("").required(),
+      body: OrderPlatformModel.PackagesSchema().required(),
+    }).required();
+  }
+
   /** @returns {UpdateShipmentStatusParam} */
   static updateShipmentStatus() {
     return Joi.object({

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

@@ -344,15 +344,17 @@ export = PaymentPlatformModel;
  */
 /**
  * @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
  */
 /**
@@ -2061,23 +2063,27 @@ type BankDetailsForOTP = {
     /**
      * - IFSC code of account
      */
-    ifsc_code: string;
+    ifsc_code?: string;
     /**
      * - Account number
      */
-    account_no: string;
+    account_no?: string;
     /**
      * - Branch name of account
      */
-    branch_name: string;
+    branch_name?: string;
     /**
      * - Bank name of account
      */
-    bank_name: string;
+    bank_name?: string;
     /**
      * - Accountg holder name of account
      */
-    account_holder: string;
+    account_holder?: string;
+    /**
+     * - UPI ID of account holder
+     */
+    upi?: string;
 };
 /** @returns {AddBeneficiaryDetailsOTPCreation} */
 declare function AddBeneficiaryDetailsOTPCreation(): AddBeneficiaryDetailsOTPCreation;
@@ -2086,6 +2092,10 @@ type AddBeneficiaryDetailsOTPCreation = {
      * - Order_id for which account will be added
      */
     order_id: string;
+    /**
+     * - Shipment_id for which account will be added
+     */
+    shipment_id?: string;
     details: BankDetailsForOTP;
 };
 /** @returns {IfscCodeDetails} */

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -388,16 +388,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
  */
 
@@ -1778,11 +1780,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 +1793,7 @@ class PaymentPlatformModel {
   static AddBeneficiaryDetailsOTPCreation() {
     return Joi.object({
       order_id: Joi.string().allow("").required(),
+      shipment_id: Joi.string().allow(""),
       details: PaymentPlatformModel.BankDetailsForOTP().required(),
     });
   }

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({