@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

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/PaymentPlatformApplicationClient.d.ts

@@ -133,13 +133,12 @@ declare class Payment {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
-     *   Success response
+     * @returns {Promise<PaymentPlatformModel.PaymentModeConfig>} - Success response
      * @name getMerchantAggregatorPaymentModeDetails
      * @summary: Get merchant aggregator and their payment mode
      * @description: Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown.  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
      */
-    getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
+    getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeConfig>;
     /**
      * @param {PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam} arg
      *   - Arg object
@@ -440,6 +439,18 @@ declare class Payment {
      * @description: Store and update configuration settings for brand payment gateways i.e required for payment for a payment gateway like key, secret, merchant salt. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
      */
     saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
+    /**
+     * @param {PaymentPlatformApplicationValidator.SaveTokenForAggregatorParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<PaymentPlatformModel.OperationResponseSchema>} - Success response
+     * @name saveTokenForAggregator
+     * @summary: Save token details for a payment aggregator
+     * @description: Save token and verification status for a specific payment aggregator, such as Apple Pay or others. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/saveTokenForAggregator/).
+     */
+    saveTokenForAggregator({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveTokenForAggregatorParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OperationResponseSchema>;
     /**
      * @param {PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam} arg
      *   - Arg object

package/sdk/platform/Payment/PaymentPlatformApplicationClient.js

@@ -866,8 +866,7 @@ class Payment {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
-   *   Success response
+   * @returns {Promise<PaymentPlatformModel.PaymentModeConfig>} - Success response
    * @name getMerchantAggregatorPaymentModeDetails
    * @summary: Get merchant aggregator and their payment mode
    * @description: Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown.  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
@@ -931,10 +930,10 @@ class Payment {
 
     const {
       error: res_error,
-    } = PaymentPlatformModel.PlatformPaymentModeDetails().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
+    } = PaymentPlatformModel.PaymentModeConfig().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -2979,6 +2978,89 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {PaymentPlatformApplicationValidator.SaveTokenForAggregatorParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PaymentPlatformModel.OperationResponseSchema>} - Success response
+   * @name saveTokenForAggregator
+   * @summary: Save token details for a payment aggregator
+   * @description: Save token and verification status for a specific payment aggregator, such as Apple Pay or others. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/saveTokenForAggregator/).
+   */
+  async saveTokenForAggregator(
+    { aggregatorId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PaymentPlatformApplicationValidator.saveTokenForAggregator().validate(
+      {
+        aggregatorId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentPlatformApplicationValidator.saveTokenForAggregator().validate(
+      {
+        aggregatorId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Payment > saveTokenForAggregator \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/aggregators/${aggregatorId}/token`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = PaymentPlatformModel.OperationResponseSchema().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 > Payment > saveTokenForAggregator \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam} arg
    *   - Arg object

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

@@ -141,7 +141,7 @@ export = PaymentPlatformApplicationValidator;
 /**
  * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
  * @property {number} aggregatorId - Aggregators Id
- * @property {PaymentPlatformModel.PlatformPaymentModeDetails} body
+ * @property {PaymentPlatformModel.PlatformConfigPaymentModeDetails} body
  */
 /**
  * @typedef PatchMerchantPaymentOptionParam
@@ -176,6 +176,17 @@ export = PaymentPlatformApplicationValidator;
  * @typedef SaveBrandPaymentGatewayConfigParam
  * @property {PaymentPlatformModel.PaymentGatewayConfigCreation} body
  */
+/**
+ * @typedef SaveTokenForAggregatorParam
+ * @property {string} aggregatorId - Payment aggregator identifier. Supported values are:
+ *
+ *   - **1**: Razorpay
+ *   - **2**: Juspay
+ *   - **3**: Checkout Extension
+ *   - **4**: PayU India Extension
+ *
+ * @property {PaymentPlatformModel.AggregatorToken} body
+ */
 /**
  * @typedef SetMerchantModeControlRoutesParam
  * @property {string} mode - Offline / advance payment mode
@@ -290,6 +301,8 @@ declare class PaymentPlatformApplicationValidator {
     static revokeOauthToken(): RevokeOauthTokenParam;
     /** @returns {SaveBrandPaymentGatewayConfigParam} */
     static saveBrandPaymentGatewayConfig(): SaveBrandPaymentGatewayConfigParam;
+    /** @returns {SaveTokenForAggregatorParam} */
+    static saveTokenForAggregator(): SaveTokenForAggregatorParam;
     /** @returns {SetMerchantModeControlRoutesParam} */
     static setMerchantModeControlRoutes(): SetMerchantModeControlRoutesParam;
     /** @returns {SetPaymentModeCustomConfigParam} */
@@ -308,7 +321,7 @@ declare class PaymentPlatformApplicationValidator {
     static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
 }
 declare namespace PaymentPlatformApplicationValidator {
-    export { AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, CreatePaymentOrderParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetMerchantAggregatorAppVersionParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeControlRoutesParam, GetPaymentModeCustomConfigParam, GetPaymentModeRoutesParam, GetPaymentSessionParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PatchMerchantPaymentOptionVersionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetMerchantModeControlRoutesParam, SetPaymentModeCustomConfigParam, SetUserCODlimitRoutesParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, ValidateCustomerAndCreditSummaryParam, VerifyCustomerForPaymentParam };
+    export { AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, CreatePaymentOrderParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetMerchantAggregatorAppVersionParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeControlRoutesParam, GetPaymentModeCustomConfigParam, GetPaymentModeRoutesParam, GetPaymentSessionParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PatchMerchantPaymentOptionVersionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SaveTokenForAggregatorParam, SetMerchantModeControlRoutesParam, SetPaymentModeCustomConfigParam, SetUserCODlimitRoutesParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, ValidateCustomerAndCreditSummaryParam, VerifyCustomerForPaymentParam };
 }
 type AddRefundBankAccountUsingOTPParam = {
     body: PaymentPlatformModel.AddBeneficiaryDetailsOTPCreation;
@@ -506,7 +519,7 @@ type PatchMerchantAggregatorPaymentModeDetailsParam = {
      * - Aggregators Id
      */
     aggregatorId: number;
-    body: PaymentPlatformModel.PlatformPaymentModeDetails;
+    body: PaymentPlatformModel.PlatformConfigPaymentModeDetails;
 };
 type PatchMerchantPaymentOptionParam = {
     body: PaymentPlatformModel.MerchnatPaymentModeCreation;
@@ -539,6 +552,18 @@ type RevokeOauthTokenParam = {
 type SaveBrandPaymentGatewayConfigParam = {
     body: PaymentPlatformModel.PaymentGatewayConfigCreation;
 };
+type SaveTokenForAggregatorParam = {
+    /**
+     * - Payment aggregator identifier. Supported values are:
+     *
+     * - **1**: Razorpay
+     * - **2**: Juspay
+     * - **3**: Checkout Extension
+     * - **4**: PayU India Extension
+     */
+    aggregatorId: string;
+    body: PaymentPlatformModel.AggregatorToken;
+};
 type SetMerchantModeControlRoutesParam = {
     /**
      * - Offline / advance payment mode

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -170,7 +170,7 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
 /**
  * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
  * @property {number} aggregatorId - Aggregators Id
- * @property {PaymentPlatformModel.PlatformPaymentModeDetails} body
+ * @property {PaymentPlatformModel.PlatformConfigPaymentModeDetails} body
  */
 
 /**
@@ -214,6 +214,18 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {PaymentPlatformModel.PaymentGatewayConfigCreation} body
  */
 
+/**
+ * @typedef SaveTokenForAggregatorParam
+ * @property {string} aggregatorId - Payment aggregator identifier. Supported values are:
+ *
+ *   - **1**: Razorpay
+ *   - **2**: Juspay
+ *   - **3**: Checkout Extension
+ *   - **4**: PayU India Extension
+ *
+ * @property {PaymentPlatformModel.AggregatorToken} body
+ */
+
 /**
  * @typedef SetMerchantModeControlRoutesParam
  * @property {string} mode - Offline / advance payment mode
@@ -477,7 +489,7 @@ class PaymentPlatformApplicationValidator {
   static patchMerchantAggregatorPaymentModeDetails() {
     return Joi.object({
       aggregatorId: Joi.number().required(),
-      body: PaymentPlatformModel.PlatformPaymentModeDetails().required(),
+      body: PaymentPlatformModel.PlatformConfigPaymentModeDetails().required(),
     }).required();
   }
 
@@ -538,6 +550,14 @@ class PaymentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {SaveTokenForAggregatorParam} */
+  static saveTokenForAggregator() {
+    return Joi.object({
+      aggregatorId: Joi.string().allow("").required(),
+      body: PaymentPlatformModel.AggregatorToken().required(),
+    }).required();
+  }
+
   /** @returns {SetMerchantModeControlRoutesParam} */
   static setMerchantModeControlRoutes() {
     return Joi.object({