@gofynd/fdk-client-javascript 1.3.4-beta.1 → 1.3.4

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

@@ -240,7 +240,7 @@ declare class Order {
      *   will be used as the target for the search operation
      * @param {string} [arg.bagStatus] - Bag_status refers to status of the
      *   entity. Filters orders based on the status.
-     * @param {string} [arg.timeToDispatch] - Time_to_dispatch refers to
+     * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
      *   estimated SLA time.
      * @param {string} [arg.paymentMethods] -
      * @param {string} [arg.tags] - Tags refers to additional descriptive labels
@@ -268,7 +268,7 @@ declare class Order {
         lane?: string;
         searchType?: string;
         bagStatus?: string;
-        timeToDispatch?: string;
+        timeToDispatch?: number;
         paymentMethods?: string;
         tags?: string;
         searchValue?: string;

package/sdk/platform/Order/OrderPlatformClient.js

@@ -1936,7 +1936,7 @@ class Order {
    *   will be used as the target for the search operation
    * @param {string} [arg.bagStatus] - Bag_status refers to status of the
    *   entity. Filters orders based on the status.
-   * @param {string} [arg.timeToDispatch] - Time_to_dispatch refers to
+   * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
    *   estimated SLA time.
    * @param {string} [arg.paymentMethods] -
    * @param {string} [arg.tags] - Tags refers to additional descriptive labels

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

@@ -1180,7 +1180,7 @@ export = OrderPlatformModel;
 /**
  * @typedef OrderBrandName
  * @property {string} [brand_name]
- * @property {number} company
+ * @property {number} [company]
  * @property {string} [created_on]
  * @property {number} id
  * @property {string} [logo]
@@ -1879,6 +1879,7 @@ export = OrderPlatformModel;
  * @property {Formatted} [formatted]
  * @property {string} [fulfilment_priority_text]
  * @property {boolean} [is_international]
+ * @property {boolean} [is_self_ship]
  * @property {LockData} [lock_data]
  * @property {string} [order_type]
  * @property {string} [packaging_name]
@@ -1927,12 +1928,14 @@ export = OrderPlatformModel;
  * @property {string} [dp_sort_key]
  * @property {string} [due_date]
  * @property {EinvoiceInfo} [einvoice_info]
+ * @property {string} [estimated_delivery_date]
  * @property {Object} [ewaybill_info]
  * @property {Object} [external]
  * @property {Formatted} [formatted]
  * @property {string} [forward_affiliate_order_id]
  * @property {string} [forward_affiliate_shipment_id]
  * @property {string} [fulfilment_priority_text]
+ * @property {boolean} [is_self_ship]
  * @property {LockData} [lock_data]
  * @property {string} [marketplace_store_id]
  * @property {string} [order_type]
@@ -1951,6 +1954,7 @@ export = OrderPlatformModel;
  * @property {number} [shipment_weight]
  * @property {string} [store_invoice_updated_date]
  * @property {ShipmentTimeStamp} [timestamp]
+ * @property {string} [tracking_url]
  * @property {number} weight
  */
 /**
@@ -3836,7 +3840,7 @@ type OrderBags = {
 declare function OrderBrandName(): OrderBrandName;
 type OrderBrandName = {
     brand_name?: string;
-    company: number;
+    company?: number;
     created_on?: string;
     id: number;
     logo?: string;
@@ -4661,6 +4665,7 @@ type ShipmentItemMeta = {
     formatted?: Formatted;
     fulfilment_priority_text?: string;
     is_international?: boolean;
+    is_self_ship?: boolean;
     lock_data?: LockData;
     order_type?: string;
     packaging_name?: string;
@@ -4712,12 +4717,14 @@ type ShipmentMeta = {
     dp_sort_key?: string;
     due_date?: string;
     einvoice_info?: EinvoiceInfo;
+    estimated_delivery_date?: string;
     ewaybill_info?: any;
     external?: any;
     formatted?: Formatted;
     forward_affiliate_order_id?: string;
     forward_affiliate_shipment_id?: string;
     fulfilment_priority_text?: string;
+    is_self_ship?: boolean;
     lock_data?: LockData;
     marketplace_store_id?: string;
     order_type?: string;
@@ -4736,6 +4743,7 @@ type ShipmentMeta = {
     shipment_weight?: number;
     store_invoice_updated_date?: string;
     timestamp?: ShipmentTimeStamp;
+    tracking_url?: string;
     weight: number;
 };
 /** @returns {ShipmentPayments} */

package/sdk/platform/Order/OrderPlatformModel.js

@@ -1309,7 +1309,7 @@ const Joi = require("joi");
 /**
  * @typedef OrderBrandName
  * @property {string} [brand_name]
- * @property {number} company
+ * @property {number} [company]
  * @property {string} [created_on]
  * @property {number} id
  * @property {string} [logo]
@@ -2083,6 +2083,7 @@ const Joi = require("joi");
  * @property {Formatted} [formatted]
  * @property {string} [fulfilment_priority_text]
  * @property {boolean} [is_international]
+ * @property {boolean} [is_self_ship]
  * @property {LockData} [lock_data]
  * @property {string} [order_type]
  * @property {string} [packaging_name]
@@ -2134,12 +2135,14 @@ const Joi = require("joi");
  * @property {string} [dp_sort_key]
  * @property {string} [due_date]
  * @property {EinvoiceInfo} [einvoice_info]
+ * @property {string} [estimated_delivery_date]
  * @property {Object} [ewaybill_info]
  * @property {Object} [external]
  * @property {Formatted} [formatted]
  * @property {string} [forward_affiliate_order_id]
  * @property {string} [forward_affiliate_shipment_id]
  * @property {string} [fulfilment_priority_text]
+ * @property {boolean} [is_self_ship]
  * @property {LockData} [lock_data]
  * @property {string} [marketplace_store_id]
  * @property {string} [order_type]
@@ -2158,6 +2161,7 @@ const Joi = require("joi");
  * @property {number} [shipment_weight]
  * @property {string} [store_invoice_updated_date]
  * @property {ShipmentTimeStamp} [timestamp]
+ * @property {string} [tracking_url]
  * @property {number} weight
  */
 
@@ -4183,7 +4187,7 @@ class OrderPlatformModel {
   static OrderBrandName() {
     return Joi.object({
       brand_name: Joi.string().allow("").allow(null),
-      company: Joi.number().allow(null).required(),
+      company: Joi.number().allow(null),
       created_on: Joi.string().allow("").allow(null),
       id: Joi.number().required(),
       logo: Joi.string().allow("").allow(null),
@@ -5119,6 +5123,7 @@ class OrderPlatformModel {
       formatted: OrderPlatformModel.Formatted(),
       fulfilment_priority_text: Joi.string().allow("").allow(null),
       is_international: Joi.boolean().allow(null),
+      is_self_ship: Joi.boolean().allow(null),
       lock_data: OrderPlatformModel.LockData(),
       order_type: Joi.string().allow("").allow(null),
       packaging_name: Joi.string().allow("").allow(null),
@@ -5176,12 +5181,14 @@ class OrderPlatformModel {
       dp_sort_key: Joi.string().allow("").allow(null),
       due_date: Joi.string().allow("").allow(null),
       einvoice_info: OrderPlatformModel.EinvoiceInfo(),
+      estimated_delivery_date: Joi.string().allow("").allow(null),
       ewaybill_info: Joi.any().allow(null),
       external: Joi.any().allow(null),
       formatted: OrderPlatformModel.Formatted(),
       forward_affiliate_order_id: Joi.string().allow("").allow(null),
       forward_affiliate_shipment_id: Joi.string().allow("").allow(null),
       fulfilment_priority_text: Joi.string().allow("").allow(null),
+      is_self_ship: Joi.boolean().allow(null),
       lock_data: OrderPlatformModel.LockData(),
       marketplace_store_id: Joi.string().allow("").allow(null),
       order_type: Joi.string().allow("").allow(null),
@@ -5200,6 +5207,7 @@ class OrderPlatformModel {
       shipment_weight: Joi.number().allow(null),
       store_invoice_updated_date: Joi.string().allow("").allow(null),
       timestamp: OrderPlatformModel.ShipmentTimeStamp(),
+      tracking_url: Joi.string().allow("").allow(null),
       weight: Joi.number().required(),
     });
   }

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

@@ -112,7 +112,7 @@ export = OrderPlatformValidator;
  * @property {string} [searchType]
  * @property {string} [searchValue]
  * @property {string} [tags]
- * @property {string} [timeToDispatch]
+ * @property {number} [timeToDispatch]
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
@@ -131,7 +131,7 @@ export = OrderPlatformValidator;
  *   be used as the target for the search operation
  * @property {string} [bagStatus] - Bag_status refers to status of the entity.
  *   Filters orders based on the status.
- * @property {string} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
  * @property {string} [paymentMethods]
  * @property {string} [tags] - Tags refers to additional descriptive labels
  *   associated with the order
@@ -588,7 +588,7 @@ type GetLaneConfigParam = {
     searchType?: string;
     searchValue?: string;
     tags?: string;
-    timeToDispatch?: string;
+    timeToDispatch?: number;
     paymentMethods?: string;
     myOrders?: boolean;
     /**
@@ -620,7 +620,7 @@ type GetOrdersParam = {
     /**
      * - Time_to_dispatch refers to estimated SLA time.
      */
-    timeToDispatch?: string;
+    timeToDispatch?: number;
     paymentMethods?: string;
     /**
      * - Tags refers to additional descriptive labels

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -134,7 +134,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [searchType]
  * @property {string} [searchValue]
  * @property {string} [tags]
- * @property {string} [timeToDispatch]
+ * @property {number} [timeToDispatch]
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
@@ -155,7 +155,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  *   be used as the target for the search operation
  * @property {string} [bagStatus] - Bag_status refers to status of the entity.
  *   Filters orders based on the status.
- * @property {string} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
  * @property {string} [paymentMethods]
  * @property {string} [tags] - Tags refers to additional descriptive labels
  *   associated with the order
@@ -505,7 +505,7 @@ class OrderPlatformValidator {
       searchType: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),
       tags: Joi.string().allow(""),
-      timeToDispatch: Joi.string().allow(""),
+      timeToDispatch: Joi.number(),
       paymentMethods: Joi.string().allow(""),
       myOrders: Joi.boolean(),
       showCrossCompanyData: Joi.boolean(),
@@ -526,7 +526,7 @@ class OrderPlatformValidator {
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
-      timeToDispatch: Joi.string().allow(""),
+      timeToDispatch: Joi.number(),
       paymentMethods: Joi.string().allow(""),
       tags: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),

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

@@ -62,6 +62,20 @@ declare class Payment {
      * @description: Use this API to confirm payment after payment gateway accepted payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/confirmPayment/).
      */
     confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationResponse>;
+    /**
+     * @param {PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+     *   - Success response
+     *
+     * @name createMerchantRefundPriority
+     * @summary: API to create merchant refund priority
+     * @description: API to update merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
+     */
+    createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
     /**
      * @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
      *   - Arg object
@@ -171,6 +185,20 @@ declare class Payment {
      * @description: This api fetches all the available PGs for merchant and its offline payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantPaymentOption/).
      */
     getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
+    /**
+     * @param {PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+     *   - Success response
+     *
+     * @name getMerchantRefundPriority
+     * @summary: API to get merchant refund priority
+     * @description: API to get merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
+     */
+    getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
     /**
      * @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
      *   - Arg object
@@ -438,6 +466,20 @@ declare class Payment {
      * @description: Use this API to map new edc device to the terminal - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateEdcDevice/).
      */
     updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddResponse>;
+    /**
+     * @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+     *   - Success response
+     *
+     * @name updateMerchantRefundPriority
+     * @summary: API to update merchant refund priority
+     * @description: API to update merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateMerchantRefundPriority/).
+     */
+    updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
     /**
      * @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
      *   - Arg object

package/sdk/platform/Payment/PaymentPlatformApplicationClient.js

@@ -398,6 +398,87 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+   *   - Success response
+   *
+   * @name createMerchantRefundPriority
+   * @summary: API to create merchant refund priority
+   * @description: API to update merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
+   */
+  async createMerchantRefundPriority(
+    { configType, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PaymentPlatformApplicationValidator.createMerchantRefundPriority().validate(
+      {
+        configType,
+        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.createMerchantRefundPriority().validate(
+      {
+        configType,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Payment > createMerchantRefundPriority \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}/refund_priority/config/${configType}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = PaymentPlatformModel.RefundPriorityResponseSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Payment > createMerchantRefundPriority \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
    *   - Arg object
@@ -1113,6 +1194,85 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+   *   - Success response
+   *
+   * @name getMerchantRefundPriority
+   * @summary: API to get merchant refund priority
+   * @description: API to get merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
+   */
+  async getMerchantRefundPriority(
+    { configType, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PaymentPlatformApplicationValidator.getMerchantRefundPriority().validate(
+      {
+        configType,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentPlatformApplicationValidator.getMerchantRefundPriority().validate(
+      {
+        configType,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Payment > getMerchantRefundPriority \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/refund_priority/config/${configType}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = PaymentPlatformModel.RefundPriorityResponseSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Payment > getMerchantRefundPriority \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
    *   - Arg object
@@ -2848,6 +3008,87 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
+   *   - Success response
+   *
+   * @name updateMerchantRefundPriority
+   * @summary: API to update merchant refund priority
+   * @description: API to update merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateMerchantRefundPriority/).
+   */
+  async updateMerchantRefundPriority(
+    { configType, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PaymentPlatformApplicationValidator.updateMerchantRefundPriority().validate(
+      {
+        configType,
+        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.updateMerchantRefundPriority().validate(
+      {
+        configType,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Payment > updateMerchantRefundPriority \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/refund_priority/config/${configType}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = PaymentPlatformModel.RefundPriorityResponseSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Payment > updateMerchantRefundPriority \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
    *   - Arg object