@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.5

package/sdk/application/Order/OrderApplicationClient.js

@@ -62,8 +62,8 @@ class Order {
    * @returns {Promise<OrderApplicationModel.CustomerDetailsResponse>} -
    *   Success response
    * @name getCustomerDetailsByShipmentId
-   * @summary: Get Customer Details by Shipment Id
-   * @description: Use this API to retrieve customer details such as mobileno using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
+   * @summary: Retrieves shipment customer.
+   * @description: Retrieve customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
    */
   async getCustomerDetailsByShipmentId(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -143,8 +143,8 @@ class Order {
    * @returns {Promise<OrderApplicationModel.ResponseGetInvoiceShipment>} -
    *   Success response
    * @name getInvoiceByShipmentId
-   * @summary: Get Invoice of a shipment
-   * @description: Use this API to retrieve shipment invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
+   * @summary: Retrieves invoice for shipment.
+   * @description: Retrieve the invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
    */
   async getInvoiceByShipmentId(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -223,8 +223,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
    * @name getOrderById
-   * @summary: Get details of an order
-   * @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
+   * @summary: Fetches order by ID.
+   * @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
    */
   async getOrderById(
     { orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -302,8 +302,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.OrderList>} - Success response
    * @name getOrders
-   * @summary: Get all orders
-   * @description: Use this API to retrieve all the orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
+   * @summary: Lists customer orders.
+   * @description: Retrieves all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
    */
   async getOrders(
     {
@@ -414,8 +414,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
    * @name getPosOrderById
-   * @summary: Get POS Order
-   * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
+   * @summary: Retrieves POS order details.
+   * @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
    */
   async getPosOrderById(
     { orderId, requestHeaders } = { requestHeaders: {} },
@@ -492,8 +492,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
    * @name getShipmentBagReasons
-   * @summary: Get reasons behind full or partial cancellation of a shipment
-   * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
+   * @summary: Lists bag reasons.
+   * @description: Retrieves reasons that led to the cancellation for the status of shipment bags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
    */
   async getShipmentBagReasons(
     { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
@@ -572,8 +572,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
    * @name getShipmentById
-   * @summary: Get details of a shipment
-   * @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
+   * @summary: Fetches shipment by ID.
+   * @description: Retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
    */
   async getShipmentById(
     { shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -651,8 +651,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
    * @name getShipmentReasons
-   * @summary: Get reasons behind full or partial cancellation of a shipment
-   * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
+   * @summary: Lists shipment reasons.
+   * @description: Retrieve reasons explaining various shipment statuses. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
    */
   async getShipmentReasons(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -730,8 +730,8 @@ class Order {
    * @returns {Promise<OrderApplicationModel.SendOtpToCustomerResponse>} -
    *   Success response
    * @name sendOtpToShipmentCustomer
-   * @summary: Send and Resend Otp code to Order-Shipment customer
-   * @description: Use this API to send OTP to the customer of the mapped Shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
+   * @summary: Sends OTP to customer.
+   * @description: Sends a one-time password (OTP) to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
    */
   async sendOtpToShipmentCustomer(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -810,8 +810,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.ShipmentTrack>} - Success response
    * @name trackShipment
-   * @summary: Track shipment
-   * @description: Track Shipment by shipment id, for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
+   * @summary: Tracks shipment status.
+   * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
    */
   async trackShipment(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -890,8 +890,8 @@ class Order {
    *   - Success response
    *
    * @name updateShipmentStatus
-   * @summary: Update the shipment status
-   * @description: Use this API to update the status of a shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
+   * @summary: Updates shipment status.
+   * @description: Modifies the current status of a specific shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
    */
   async updateShipmentStatus(
     { shipmentId, body, requestHeaders } = { requestHeaders: {} },
@@ -968,8 +968,8 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.VerifyOtpResponse>} - Success response
    * @name verifyOtpShipmentCustomer
-   * @summary: Verify Otp code
-   * @description: Use this API to verify OTP and create a session token with custom payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
+   * @summary: Verifies OTP.
+   * @description: Confirms the OTP sent to the shipment customer for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
    */
   async verifyOtpShipmentCustomer(
     { orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },

package/sdk/application/Order/OrderApplicationModel.d.ts

@@ -119,6 +119,7 @@ export = OrderApplicationModel;
  * @property {number} [refund_amount]
  * @property {string} [currency_code]
  * @property {number} [fynd_credits]
+ * @property {number} [amount_to_be_collected]
  */
 /**
  * @typedef ItemBrand
@@ -191,6 +192,7 @@ export = OrderApplicationModel;
  * @property {number} [gst_fee]
  * @property {number} [refund_amount]
  * @property {number} [fynd_credits]
+ * @property {number} [amount_to_be_collected]
  */
 /**
  * @typedef CurrentStatus
@@ -218,12 +220,17 @@ export = OrderApplicationModel;
  * @property {string} [currency_code]
  * @property {string} [seller_identifier]
  * @property {CurrentStatus} [current_status]
+ * @property {Article} [article]
  */
 /**
  * @typedef FulfillingCompany
  * @property {number} [id]
  * @property {string} [name]
  */
+/**
+ * @typedef Article
+ * @property {string[]} [tags]
+ */
 /**
  * @typedef DeliveryAddress
  * @property {string} [pincode]
@@ -253,6 +260,7 @@ export = OrderApplicationModel;
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
+ * @property {ShipmentPayment[]} [payment_info]
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -289,6 +297,7 @@ export = OrderApplicationModel;
  * @property {string} [need_help_url]
  * @property {Object} [return_meta]
  * @property {string} [delivery_date]
+ * @property {OrderRequest} [order]
  */
 /**
  * @typedef BagsForReorderArticleAssignment
@@ -496,6 +505,10 @@ export = OrderApplicationModel;
  * @property {string} [exclude_bags_next_state]
  * @property {string} [status]
  */
+/**
+ * @typedef OrderRequest
+ * @property {Object} [meta]
+ */
 /**
  * @typedef UpdateShipmentStatusRequest
  * @property {StatuesRequest[]} [statuses]
@@ -523,7 +536,7 @@ export = OrderApplicationModel;
 declare class OrderApplicationModel {
 }
 declare namespace OrderApplicationModel {
-    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, DeliveryAddress, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
+    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, DeliveryAddress, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
 }
 /** @returns {OrderPage} */
 declare function OrderPage(): OrderPage;
@@ -659,6 +672,7 @@ type Prices = {
     refund_amount?: number;
     currency_code?: string;
     fynd_credits?: number;
+    amount_to_be_collected?: number;
 };
 /** @returns {ItemBrand} */
 declare function ItemBrand(): ItemBrand;
@@ -737,6 +751,7 @@ type FinancialBreakup = {
     gst_fee?: number;
     refund_amount?: number;
     fynd_credits?: number;
+    amount_to_be_collected?: number;
 };
 /** @returns {CurrentStatus} */
 declare function CurrentStatus(): CurrentStatus;
@@ -766,6 +781,7 @@ type Bags = {
     currency_code?: string;
     seller_identifier?: string;
     current_status?: CurrentStatus;
+    article?: Article;
 };
 /** @returns {FulfillingCompany} */
 declare function FulfillingCompany(): FulfillingCompany;
@@ -773,6 +789,11 @@ type FulfillingCompany = {
     id?: number;
     name?: string;
 };
+/** @returns {Article} */
+declare function Article(): Article;
+type Article = {
+    tags?: string[];
+};
 /** @returns {DeliveryAddress} */
 declare function DeliveryAddress(): DeliveryAddress;
 type DeliveryAddress = {
@@ -804,6 +825,7 @@ type DeliveryAddress = {
 declare function Shipments(): Shipments;
 type Shipments = {
     payment?: ShipmentPayment;
+    payment_info?: ShipmentPayment[];
     order_type?: string;
     show_download_invoice?: boolean;
     can_cancel?: boolean;
@@ -840,6 +862,7 @@ type Shipments = {
     need_help_url?: string;
     return_meta?: any;
     delivery_date?: string;
+    order?: OrderRequest;
 };
 /** @returns {BagsForReorderArticleAssignment} */
 declare function BagsForReorderArticleAssignment(): BagsForReorderArticleAssignment;
@@ -1082,6 +1105,11 @@ type StatuesRequest = {
     exclude_bags_next_state?: string;
     status?: string;
 };
+/** @returns {OrderRequest} */
+declare function OrderRequest(): OrderRequest;
+type OrderRequest = {
+    meta?: any;
+};
 /** @returns {UpdateShipmentStatusRequest} */
 declare function UpdateShipmentStatusRequest(): UpdateShipmentStatusRequest;
 type UpdateShipmentStatusRequest = {

package/sdk/application/Order/OrderApplicationModel.js

@@ -133,6 +133,7 @@ const Joi = require("joi");
  * @property {number} [refund_amount]
  * @property {string} [currency_code]
  * @property {number} [fynd_credits]
+ * @property {number} [amount_to_be_collected]
  */
 
 /**
@@ -211,6 +212,7 @@ const Joi = require("joi");
  * @property {number} [gst_fee]
  * @property {number} [refund_amount]
  * @property {number} [fynd_credits]
+ * @property {number} [amount_to_be_collected]
  */
 
 /**
@@ -240,6 +242,7 @@ const Joi = require("joi");
  * @property {string} [currency_code]
  * @property {string} [seller_identifier]
  * @property {CurrentStatus} [current_status]
+ * @property {Article} [article]
  */
 
 /**
@@ -248,6 +251,11 @@ const Joi = require("joi");
  * @property {string} [name]
  */
 
+/**
+ * @typedef Article
+ * @property {string[]} [tags]
+ */
+
 /**
  * @typedef DeliveryAddress
  * @property {string} [pincode]
@@ -278,6 +286,7 @@ const Joi = require("joi");
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
+ * @property {ShipmentPayment[]} [payment_info]
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -314,6 +323,7 @@ const Joi = require("joi");
  * @property {string} [need_help_url]
  * @property {Object} [return_meta]
  * @property {string} [delivery_date]
+ * @property {OrderRequest} [order]
  */
 
 /**
@@ -557,6 +567,11 @@ const Joi = require("joi");
  * @property {string} [status]
  */
 
+/**
+ * @typedef OrderRequest
+ * @property {Object} [meta]
+ */
+
 /**
  * @typedef UpdateShipmentStatusRequest
  * @property {StatuesRequest[]} [statuses]
@@ -748,6 +763,7 @@ class OrderApplicationModel {
       refund_amount: Joi.number(),
       currency_code: Joi.string().allow(""),
       fynd_credits: Joi.number(),
+      amount_to_be_collected: Joi.number(),
     });
   }
 
@@ -840,6 +856,7 @@ class OrderApplicationModel {
       gst_fee: Joi.number(),
       refund_amount: Joi.number(),
       fynd_credits: Joi.number(),
+      amount_to_be_collected: Joi.number(),
     });
   }
 
@@ -875,6 +892,7 @@ class OrderApplicationModel {
       currency_code: Joi.string().allow(""),
       seller_identifier: Joi.string().allow(""),
       current_status: OrderApplicationModel.CurrentStatus(),
+      article: OrderApplicationModel.Article(),
     });
   }
 
@@ -886,6 +904,13 @@ class OrderApplicationModel {
     });
   }
 
+  /** @returns {Article} */
+  static Article() {
+    return Joi.object({
+      tags: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
   /** @returns {DeliveryAddress} */
   static DeliveryAddress() {
     return Joi.object({
@@ -919,6 +944,7 @@ class OrderApplicationModel {
   static Shipments() {
     return Joi.object({
       payment: OrderApplicationModel.ShipmentPayment(),
+      payment_info: Joi.array().items(OrderApplicationModel.ShipmentPayment()),
       order_type: Joi.string().allow("").allow(null),
       show_download_invoice: Joi.boolean(),
       can_cancel: Joi.boolean(),
@@ -957,6 +983,7 @@ class OrderApplicationModel {
       need_help_url: Joi.string().allow(""),
       return_meta: Joi.any(),
       delivery_date: Joi.string().allow("").allow(null),
+      order: OrderApplicationModel.OrderRequest(),
     });
   }
 
@@ -1277,6 +1304,13 @@ class OrderApplicationModel {
     });
   }
 
+  /** @returns {OrderRequest} */
+  static OrderRequest() {
+    return Joi.object({
+      meta: Joi.any(),
+    });
+  }
+
   /** @returns {UpdateShipmentStatusRequest} */
   static UpdateShipmentStatusRequest() {
     return Joi.object({