@gofynd/fdk-client-javascript 3.3.5 → 3.3.6

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

@@ -24,7 +24,7 @@ declare class Order {
      * @returns {Promise<CustomerDetailsResponseSchema>} - Success response
      * @name getCustomerDetailsByShipmentId
      * @summary: Get shipment's customer
-     * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
+     * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getCustomerDetailsByShipmentId/).
      */
     getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomerDetailsResponseSchema>;
     /**
@@ -33,7 +33,7 @@ declare class Order {
      * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
      * @name getInvoiceByShipmentId
      * @summary: Retrieves invoice for shipment
-     * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
+     * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getInvoiceByShipmentId/).
      */
     getInvoiceByShipmentId({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ResponseGetInvoiceShipment>;
     /**
@@ -42,7 +42,7 @@ declare class Order {
      * @returns {Promise<OrderById>} - Success response
      * @name getOrderById
      * @summary: Get an order
-     * @description: Get 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/).
+     * @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrderById/).
      */
     getOrderById({ orderId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
     /**
@@ -51,7 +51,7 @@ declare class Order {
      * @returns {Promise<OrderList>} - Success response
      * @name getOrders
      * @summary: List customer orders
-     * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
+     * @description: Get all orders associated with a customer account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrders/).
      */
     getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderList>;
     /**
@@ -60,7 +60,7 @@ declare class Order {
      * @returns {Promise<OrderById>} - Success response
      * @name 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/).
+     * @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://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
      */
     getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
     /**
@@ -69,7 +69,7 @@ declare class Order {
      * @returns {Promise<ShipmentBagReasons>} - Success response
      * @name getShipmentBagReasons
      * @summary: Retrieve Reasons for Cancellation and Return journey
-     * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
+     * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentBagReasons/).
      */
     getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentBagReasons>;
     /**
@@ -78,7 +78,7 @@ declare class Order {
      * @returns {Promise<ShipmentById>} - Success response
      * @name getShipmentById
      * @summary: Get a Shipment
-     * @description: Get 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/).
+     * @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentById/).
      */
     getShipmentById({ shipmentId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentById>;
     /**
@@ -87,7 +87,7 @@ declare class Order {
      * @returns {Promise<ShipmentReasons>} - Success response
      * @name getShipmentReasons
      * @summary: List shipment cancellation reasons
-     * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
+     * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentReasons/).
      */
     getShipmentReasons({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentReasons>;
     /**
@@ -96,7 +96,7 @@ declare class Order {
      * @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
      * @name sendOtpToShipmentCustomer
      * @summary: Send OTP to customer
-     * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
+     * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/sendOtpToShipmentCustomer/).
      */
     sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpToCustomerResponseSchema>;
     /**
@@ -105,7 +105,7 @@ declare class Order {
      * @returns {Promise<ShipmentTrack>} - Success response
      * @name trackShipment
      * @summary: Track 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/).
+     * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/trackShipment/).
      */
     trackShipment({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentTrack>;
     /**
@@ -114,7 +114,7 @@ declare class Order {
      * @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
      * @name updateShipmentStatus
      * @summary: Updates shipment status
-     * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
+     * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/updateShipmentStatus/).
      */
     updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentApplicationStatusResponseSchema>;
     /**
@@ -123,7 +123,7 @@ declare class Order {
      * @returns {Promise<VerifyOtpResponseSchema>} - Success response
      * @name verifyOtpShipmentCustomer
      * @summary: Verifies OTP
-     * @description: Verify OTP for getting shipment details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
+     * @description: Verify OTP for getting shipment details - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/verifyOtpShipmentCustomer/).
      */
     verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpResponseSchema>;
 }

package/sdk/application/Order/OrderApplicationClient.js

@@ -57,7 +57,7 @@ class Order {
    * @returns {Promise<CustomerDetailsResponseSchema>} - Success response
    * @name getCustomerDetailsByShipmentId
    * @summary: Get shipment's customer
-   * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
+   * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getCustomerDetailsByShipmentId/).
    */
   async getCustomerDetailsByShipmentId(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -106,7 +106,7 @@ class Order {
    * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
    * @name getInvoiceByShipmentId
    * @summary: Retrieves invoice for shipment
-   * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
+   * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getInvoiceByShipmentId/).
    */
   async getInvoiceByShipmentId(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -152,7 +152,7 @@ class Order {
    * @returns {Promise<OrderById>} - Success response
    * @name getOrderById
    * @summary: Get an order
-   * @description: Get 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/).
+   * @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrderById/).
    */
   async getOrderById(
     { orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -199,7 +199,7 @@ class Order {
    * @returns {Promise<OrderList>} - Success response
    * @name getOrders
    * @summary: List customer orders
-   * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
+   * @description: Get all orders associated with a customer account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrders/).
    */
   async getOrders(
     {
@@ -256,7 +256,7 @@ class Order {
    * @returns {Promise<OrderById>} - Success response
    * @name 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/).
+   * @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://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
    */
   async getPosOrderById(
     { orderId, requestHeaders } = { requestHeaders: {} },
@@ -302,7 +302,7 @@ class Order {
    * @returns {Promise<ShipmentBagReasons>} - Success response
    * @name getShipmentBagReasons
    * @summary: Retrieve Reasons for Cancellation and Return journey
-   * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
+   * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentBagReasons/).
    */
   async getShipmentBagReasons(
     { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
@@ -351,7 +351,7 @@ class Order {
    * @returns {Promise<ShipmentById>} - Success response
    * @name getShipmentById
    * @summary: Get a Shipment
-   * @description: Get 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/).
+   * @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentById/).
    */
   async getShipmentById(
     { shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -398,7 +398,7 @@ class Order {
    * @returns {Promise<ShipmentReasons>} - Success response
    * @name getShipmentReasons
    * @summary: List shipment cancellation reasons
-   * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
+   * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentReasons/).
    */
   async getShipmentReasons(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -444,7 +444,7 @@ class Order {
    * @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
    * @name sendOtpToShipmentCustomer
    * @summary: Send OTP to customer
-   * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
+   * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/sendOtpToShipmentCustomer/).
    */
   async sendOtpToShipmentCustomer(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -493,7 +493,7 @@ class Order {
    * @returns {Promise<ShipmentTrack>} - Success response
    * @name trackShipment
    * @summary: Track 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/).
+   * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/trackShipment/).
    */
   async trackShipment(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -539,7 +539,7 @@ class Order {
    * @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
    * @name updateShipmentStatus
    * @summary: Updates shipment status
-   * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
+   * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/updateShipmentStatus/).
    */
   async updateShipmentStatus(
     { shipmentId, body, requestHeaders } = { requestHeaders: {} },
@@ -585,7 +585,7 @@ class Order {
    * @returns {Promise<VerifyOtpResponseSchema>} - Success response
    * @name verifyOtpShipmentCustomer
    * @summary: Verifies OTP
-   * @description: Verify OTP for getting shipment details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
+   * @description: Verify OTP for getting shipment details - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/verifyOtpShipmentCustomer/).
    */
   async verifyOtpShipmentCustomer(
     { orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },