@gofynd/fdk-client-javascript 3.17.0 → 3.17.2

package/sdk/platform/Order/OrderPlatformClient.js

@@ -604,7 +604,7 @@ class Order {
    * @returns {Promise<Object>} - Success response
    * @name createOrder
    * @summary: Create Order
-   * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+   * @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order.  Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
    */
   async createOrder(
     { xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders } = {
@@ -5765,7 +5765,7 @@ class Order {
    *
    * @name updateShipmentStatus
    * @summary: Update a shipment's status
-   * @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the example payload. Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS States</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
+   * @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
    */
   async updateShipmentStatus(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -382,7 +382,9 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef StatuesRequestSchema
- * @property {string} [status] - The new status to be assigned to the shipment(s).
+ * @property {string} [status] - The new status to be assigned to a shipment.
+ *   Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS
+ *   States</a> for the complete status list.
  * @property {ShipmentsRequestSchema[]} [shipments] - A list of shipments to
  *   which the new status will be applied.
  * @property {string} [exclude_bags_next_state] - Specifies the state to which
@@ -2852,6 +2854,8 @@ export = OrderPlatformModel;
  * @property {string} [external_shipment_id] - Unique identifier for the
  *   shipment as assigned by an external system. Use this to map the external ID
  *   to Fynd's generated ID.
+ * @property {string} [invoice_id] - Indicates whether the order was created in
+ *   offline mode. Used to enable offline-specific processing and sync behavior.
  * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
  * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
  * @property {number} [location_id] - The location ID from which this shipment
@@ -3041,6 +3045,8 @@ export = OrderPlatformModel;
  *   placed. Required when the order is placed from one company but fulfilled by another.
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
  *   Draft orders will be moved to upcoming state instead of placed status.
+ * @property {boolean} [is_offline_order] - Indicates whether the order is an
+ *   offline order placed through a physical store or offline channel.
  * @property {Object} [meta] - Metadata related to the order may include
  *   additional, dynamic information that provides further context about the
  *   order. This information can also be viewed on the Order or Shipment Details page.
@@ -6433,7 +6439,9 @@ type UpdateAddressRequestBody = {
 declare function StatuesRequestSchema(): StatuesRequestSchema;
 type StatuesRequestSchema = {
     /**
-     * - The new status to be assigned to the shipment(s).
+     * - The new status to be assigned to a shipment.
+     * Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS
+     * States</a> for the complete status list.
      */
     status?: string;
     /**
@@ -11325,6 +11333,11 @@ type CreateOrderShipmentSchema = {
      * to Fynd's generated ID.
      */
     external_shipment_id?: string;
+    /**
+     * - Indicates whether the order was created in
+     * offline mode. Used to enable offline-specific processing and sync behavior.
+     */
+    invoice_id?: string;
     /**
      * - A list of items included in the shipment.
      */
@@ -11783,6 +11796,11 @@ type CreateOrderRequestSchema = {
      * Draft orders will be moved to upcoming state instead of placed status.
      */
     is_draft?: boolean;
+    /**
+     * - Indicates whether the order is an
+     * offline order placed through a physical store or offline channel.
+     */
+    is_offline_order?: boolean;
     /**
      * - Metadata related to the order may include
      * additional, dynamic information that provides further context about the

package/sdk/platform/Order/OrderPlatformModel.js

@@ -420,7 +420,9 @@ const Joi = require("joi");
 
 /**
  * @typedef StatuesRequestSchema
- * @property {string} [status] - The new status to be assigned to the shipment(s).
+ * @property {string} [status] - The new status to be assigned to a shipment.
+ *   Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS
+ *   States</a> for the complete status list.
  * @property {ShipmentsRequestSchema[]} [shipments] - A list of shipments to
  *   which the new status will be applied.
  * @property {string} [exclude_bags_next_state] - Specifies the state to which
@@ -3111,6 +3113,8 @@ const Joi = require("joi");
  * @property {string} [external_shipment_id] - Unique identifier for the
  *   shipment as assigned by an external system. Use this to map the external ID
  *   to Fynd's generated ID.
+ * @property {string} [invoice_id] - Indicates whether the order was created in
+ *   offline mode. Used to enable offline-specific processing and sync behavior.
  * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
  * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
  * @property {number} [location_id] - The location ID from which this shipment
@@ -3311,6 +3315,8 @@ const Joi = require("joi");
  *   placed. Required when the order is placed from one company but fulfilled by another.
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
  *   Draft orders will be moved to upcoming state instead of placed status.
+ * @property {boolean} [is_offline_order] - Indicates whether the order is an
+ *   offline order placed through a physical store or offline channel.
  * @property {Object} [meta] - Metadata related to the order may include
  *   additional, dynamic information that provides further context about the
  *   order. This information can also be viewed on the Order or Shipment Details page.
@@ -8889,6 +8895,7 @@ class OrderPlatformModel {
       type: Joi.string().allow(""),
       fulfillment_option: OrderPlatformModel.FulfillmentOptionSchema(),
       external_shipment_id: Joi.string().allow(""),
+      invoice_id: Joi.string().allow(""),
       line_items: Joi.array().items(OrderPlatformModel.LineItemSchema()),
       order_fulfillment_timeline: OrderPlatformModel.OrderFulfillmentTimelineSchema(),
       location_id: Joi.number(),
@@ -9064,6 +9071,7 @@ class OrderPlatformModel {
       b2b_gstin_number: Joi.string().allow(""),
       channel_company_id: Joi.string().allow(""),
       is_draft: Joi.boolean(),
+      is_offline_order: Joi.boolean(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }

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