@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1

package/sdk/platform/Finance/FinancePlatformClient.js

@@ -21,7 +21,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
    *   Success response
    * @name channelDisplayName
-   * @summary: Get channel display name.
+   * @summary: Get channel display name
    * @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
    */
   async channelDisplayName(
@@ -105,7 +105,7 @@ class Finance {
    *   - Success response
    *
    * @name createSellerCreditNoteConfig
-   * @summary: Create seller credit note config.
+   * @summary: Create seller credit note config
    * @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
    */
   async createSellerCreditNoteConfig(
@@ -187,7 +187,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
    *   Success response
    * @name creditNoteDetails
-   * @summary: Get credit note details.
+   * @summary: Get credit note details
    * @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
    */
   async creditNoteDetails(
@@ -268,7 +268,7 @@ class Finance {
    *   - Success response
    *
    * @name creditlineDataplatform
-   * @summary: Access credit line data platform.
+   * @summary: Access credit line data platform
    * @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
    */
   async creditlineDataplatform(
@@ -349,7 +349,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
    * @name deleteConfig
-   * @summary: Deletes credit note config.
+   * @summary: Deletes credit note config
    * @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
    */
   async deleteConfig(
@@ -430,7 +430,7 @@ class Finance {
    *   - Success response
    *
    * @name downloadCreditDebitNote
-   * @summary: Download credit/debit note.
+   * @summary: Download credit/debit note
    * @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
    */
   async downloadCreditDebitNote(
@@ -511,7 +511,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
    * @name downloadReport
-   * @summary: Download financial report.
+   * @summary: Download financial report
    * @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
    */
   async downloadReport(
@@ -592,7 +592,7 @@ class Finance {
    *   - Success response
    *
    * @name downloadReportCustomerCn
-   * @summary: Download customer credit note report.
+   * @summary: Download customer credit note report
    * @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
    */
   async downloadReportCustomerCn(
@@ -673,7 +673,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
    * @name generateReport
-   * @summary: Generate financial report.
+   * @summary: Generate financial report
    * @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
    */
   async generateReport(
@@ -754,7 +754,7 @@ class Finance {
    *   - Success response
    *
    * @name generateReportCustomerCn
-   * @summary: Generate customer credit note report.
+   * @summary: Generate customer credit note report
    * @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
    */
   async generateReportCustomerCn(
@@ -835,7 +835,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
    * @name getAffiliate
-   * @summary: Get affiliate details.
+   * @summary: Get affiliate details
    * @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
    */
   async getAffiliate(
@@ -914,7 +914,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
    * @name getCnConfig
-   * @summary: Get credit note configuration.
+   * @summary: Get credit note configuration
    * @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
    */
   async getCnConfig(
@@ -993,7 +993,7 @@ class Finance {
    *   - Success response
    *
    * @name getCustomerCreditBalance
-   * @summary: Get customer credit balance.
+   * @summary: Get customer credit balance
    * @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
    */
   async getCustomerCreditBalance(
@@ -1074,7 +1074,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
    * @name getData
-   * @summary: Get financial data.
+   * @summary: Get financial data
    * @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
    */
   async getData(
@@ -1151,7 +1151,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
    * @name getPdfUrlView
-   * @summary: Get PDF URL view.
+   * @summary: Get PDF URL view
    * @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
    */
   async getPdfUrlView(
@@ -1230,7 +1230,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
    * @name getReason
-   * @summary: Get transaction reason.
+   * @summary: Get transaction reason
    * @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
    */
   async getReason(
@@ -1307,7 +1307,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
    * @name getReportList
-   * @summary: Get report list.
+   * @summary: Get report list
    * @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
    */
   async getReportList(
@@ -1387,7 +1387,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
    *   Success response
    * @name getReportingFilters
-   * @summary: Get reporting filters.
+   * @summary: Get reporting filters
    * @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
    */
   async getReportingFilters(
@@ -1471,7 +1471,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
    *   Success response
    * @name invoiceActivityLogs
-   * @summary: Display activity log details of an invoice.
+   * @summary: Display activity log details of an invoice
    * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
    */
   async invoiceActivityLogs(
@@ -1550,8 +1550,8 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
    * @name invoiceListing
-   * @summary: Gives list of invoices.
-   * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
+   * @summary: List invoices
+   * @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
    */
   async invoiceListing(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1629,7 +1629,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
    * @name invoicePDF
-   * @summary: Get invoice PDF.
+   * @summary: Get invoice PDF
    * @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
    */
   async invoicePDF(
@@ -1707,7 +1707,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
    *   Success response
    * @name invoicePaymentDetails
-   * @summary: Display payment details of an invoice.
+   * @summary: Display payment details of an invoice
    * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
    */
   async invoicePaymentDetails(
@@ -1866,7 +1866,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
    * @name invoiceType
-   * @summary: Get invoice types.
+   * @summary: Get invoice types
    * @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
    */
   async invoiceType(
@@ -1944,7 +1944,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
    *   Success response
    * @name isCnRefundMethod
-   * @summary: Check CN refund method.
+   * @summary: Check refund method
    * @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
    */
   async isCnRefundMethod(
@@ -2024,7 +2024,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
    *   Success response
    * @name isCreditlinePlatform
-   * @summary: Check credit line platform status.
+   * @summary: Check credit line platform status
    * @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
    */
   async isCreditlinePlatform(
@@ -2176,7 +2176,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
    * @name paymentProcess
-   * @summary: Process payments.
+   * @summary: Process payments
    * @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
    */
   async paymentProcess(
@@ -2256,7 +2256,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
    *   Success response
    * @name unlockCreditNote
-   * @summary: Unlocks credit notes.
+   * @summary: Unlock credit notes
    * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
    */
   async unlockCreditNote(

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

@@ -93,7 +93,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
      * @name downloadBulkActionTemplate
      * @summary: Download bulk action template.
-     * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
+     * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
      */
     downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
     /**
@@ -104,7 +104,7 @@ declare class Order {
      *   Success response
      * @name downloadLanesReport
      * @summary: Downloads lanes shipment/orders.
-     * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
+     * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
      */
     downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
     /**
@@ -136,7 +136,7 @@ declare class Order {
      *
      * @name fetchCreditBalanceDetail
      * @summary: Fetch credit balance detail.
-     * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
+     * @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
      */
     fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
     /**
@@ -147,7 +147,7 @@ declare class Order {
      *   Success response
      * @name fetchRefundModeConfig
      * @summary: Fetch refund mode config.
-     * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
+     * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
      */
     fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
     /**
@@ -158,7 +158,7 @@ declare class Order {
      *   Success response
      * @name generatePOSReceiptByOrderId
      * @summary: Generate POS receipt by order ID.
-     * @description: Generate POS recipt by order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
+     * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
      */
     generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
     /**
@@ -189,7 +189,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
      * @name getAnnouncements
      * @summary: Get announcements.
-     * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
+     * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
      */
     getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
     /**
@@ -221,7 +221,7 @@ declare class Order {
      *   Success response
      * @name getBulkActionTemplate
      * @summary: Get bulk action template.
-     * @description: Get Bulk Action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
+     * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
      */
     getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
     /**
@@ -231,7 +231,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
      * @name getBulkShipmentExcelFile
      * @summary: Get bulk shipment Excel file.
-     * @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
+     * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
      */
     getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
     /**
@@ -250,8 +250,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
      * @name getFileByStatus
-     * @summary: Get the file URL consisting Records of the provided status.
-     * @description: Get the file URL consisting Records of the provided status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
+     * @summary: Get the file download URL used for performing bulk operation
+     * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
      */
     getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
     /**
@@ -404,7 +404,7 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.GetRefundStates>} - Success response
      * @name getRefundEnableStateList
-     * @summary: Refund State Configuration
+     * @summary: Refund State Configurationb
      * @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundEnableStateList/).
      */
     getRefundEnableStateList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetRefundStates>;
@@ -438,7 +438,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
      * @name getRoleBasedActions
      * @summary: Get role-based actions.
-     * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
+     * @description: Retrieve permissible actions based on user roles such as company_admin,  company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
      */
     getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
     /**
@@ -588,7 +588,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
      * @name getStateTransitionMap
      * @summary: Get state transition map.
-     * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
+     * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
      */
     getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
     /**
@@ -597,8 +597,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
      * @name getTemplate
-     * @summary: Get the Excel file URL for the Template.
-     * @description: Get the Excel file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
+     * @summary: Get the Excel or CSV file URL for the Template.
+     * @description: Get the Excel or CSV file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
      */
     getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
     /**
@@ -618,7 +618,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
      * @name getfilters
      * @summary: Get filters.
-     * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
+     * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
      */
     getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
     /**
@@ -628,8 +628,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
      *   Success response
      * @name invalidateShipmentCache
-     * @summary: Invalidate shipment cache.
-     * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
+     * @summary: Invalidate shipment cache
+     * @description: Clear the existing shipment cache data stored in Redis  and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
      */
     invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
     /**
@@ -648,8 +648,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
      * @name orderUpdate
-     * @summary: Order update.
-     * @description: Modify the details and status of an order.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
+     * @summary: Update an order
+     * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
      */
     orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
     /**
@@ -703,7 +703,7 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.SendSmsResponse>} - Success response
      * @name sendSmsNinja
      * @summary: Send SMS via Ninja.
-     * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
+     * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
      */
     sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendSmsResponse>;
     /**

package/sdk/platform/Order/OrderPlatformClient.js

@@ -695,7 +695,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
    * @name downloadBulkActionTemplate
    * @summary: Download bulk action template.
-   * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
+   * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
    */
   async downloadBulkActionTemplate(
     { templateSlug, requestHeaders } = { requestHeaders: {} },
@@ -778,7 +778,7 @@ class Order {
    *   Success response
    * @name downloadLanesReport
    * @summary: Downloads lanes shipment/orders.
-   * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
+   * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
    */
   async downloadLanesReport(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1015,7 +1015,7 @@ class Order {
    *
    * @name fetchCreditBalanceDetail
    * @summary: Fetch credit balance detail.
-   * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
+   * @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
    */
   async fetchCreditBalanceDetail(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1097,7 +1097,7 @@ class Order {
    *   Success response
    * @name fetchRefundModeConfig
    * @summary: Fetch refund mode config.
-   * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
+   * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
    */
   async fetchRefundModeConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1177,7 +1177,7 @@ class Order {
    *   Success response
    * @name generatePOSReceiptByOrderId
    * @summary: Generate POS receipt by order ID.
-   * @description: Generate POS recipt by order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
+   * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
    */
   async generatePOSReceiptByOrderId(
     { orderId, shipmentId, documentType, requestHeaders } = {
@@ -1429,7 +1429,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
    * @name getAnnouncements
    * @summary: Get announcements.
-   * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
+   * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
    */
   async getAnnouncements(
     { date, requestHeaders } = { requestHeaders: {} },
@@ -1708,7 +1708,7 @@ class Order {
    *   Success response
    * @name getBulkActionTemplate
    * @summary: Get bulk action template.
-   * @description: Get Bulk Action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
+   * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
    */
   async getBulkActionTemplate(
     { requestHeaders } = { requestHeaders: {} },
@@ -1783,7 +1783,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
    * @name getBulkShipmentExcelFile
    * @summary: Get bulk shipment Excel file.
-   * @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
+   * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
    */
   async getBulkShipmentExcelFile(
     {
@@ -2002,8 +2002,8 @@ class Order {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
    * @name getFileByStatus
-   * @summary: Get the file URL consisting Records of the provided status.
-   * @description: Get the file URL consisting Records of the provided status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
+   * @summary: Get the file download URL used for performing bulk operation
+   * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
    */
   async getFileByStatus(
     { batchId, status, fileType, reportType, requestHeaders } = {
@@ -2889,7 +2889,7 @@ class Order {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.GetRefundStates>} - Success response
    * @name getRefundEnableStateList
-   * @summary: Refund State Configuration
+   * @summary: Refund State Configurationb
    * @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundEnableStateList/).
    */
   async getRefundEnableStateList(
@@ -3156,7 +3156,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
    * @name getRoleBasedActions
    * @summary: Get role-based actions.
-   * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
+   * @description: Retrieve permissible actions based on user roles such as company_admin,  company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
    */
   async getRoleBasedActions(
     { requestHeaders } = { requestHeaders: {} },
@@ -3869,7 +3869,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
    * @name getStateTransitionMap
    * @summary: Get state transition map.
-   * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
+   * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
    */
   async getStateTransitionMap(
     { requestHeaders } = { requestHeaders: {} },
@@ -3943,8 +3943,8 @@ class Order {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
    * @name getTemplate
-   * @summary: Get the Excel file URL for the Template.
-   * @description: Get the Excel file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
+   * @summary: Get the Excel or CSV file URL for the Template.
+   * @description: Get the Excel or CSV file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
    */
   async getTemplate(
     { templateName, requestHeaders } = { requestHeaders: {} },
@@ -4099,7 +4099,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
    * @name getfilters
    * @summary: Get filters.
-   * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
+   * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
    */
   async getfilters(
     { view, groupEntity, requestHeaders } = { requestHeaders: {} },
@@ -4180,8 +4180,8 @@ class Order {
    * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
    *   Success response
    * @name invalidateShipmentCache
-   * @summary: Invalidate shipment cache.
-   * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
+   * @summary: Invalidate shipment cache
+   * @description: Clear the existing shipment cache data stored in Redis  and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
    */
   async invalidateShipmentCache(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4336,8 +4336,8 @@ class Order {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
    * @name orderUpdate
-   * @summary: Order update.
-   * @description: Modify the details and status of an order.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
+   * @summary: Update an order
+   * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
    */
   async orderUpdate(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4742,7 +4742,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.SendSmsResponse>} - Success response
    * @name sendSmsNinja
    * @summary: Send SMS via Ninja.
-   * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
+   * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
    */
   async sendSmsNinja(
     { body, requestHeaders } = { requestHeaders: {} },