@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.8

package/sdk/platform/Finance/FinancePlatformModel.js

@@ -2,31 +2,37 @@ const Joi = require("joi");
 
 /**
  * @typedef OrederFreezeResponse
- * @property {boolean} [success]
- * @property {boolean} [oms_freeze]
- * @property {string} [source]
+ * @property {boolean} [success] - Indicates whether the operation was successful or not.
+ * @property {boolean} [oms_freeze] - Flag indicating if the system is frozen
+ *   for order management.
+ * @property {string} [source] - Optional field indicating the data source of
+ *   the information.
  */
 
 /**
  * @typedef GenerateReportMeta
- * @property {string} [brand]
- * @property {string} [company]
- * @property {string} [channel]
+ * @property {string} [brand] - The brand name associated with the report meta
+ *   information.
+ * @property {string} [company] - The company name associated with the report
+ *   meta information.
+ * @property {string} [channel] - The sale channel name associated with seller.
  */
 
 /**
  * @typedef GenerateReportFilters
- * @property {string[]} [brand]
- * @property {string[]} [company]
- * @property {string[]} [channel]
+ * @property {string[]} [brand] - An array of brand names to filter the report data.
+ * @property {string[]} [company] - An array of company id to filter the report data.
+ * @property {string[]} [channel] - An array of sale channel names associated
+ *   with seller to filter the report data.
  */
 
 /**
  * @typedef GenerateReportPlatform
- * @property {string} [start_date]
- * @property {string} [end_date]
+ * @property {string} [start_date] - The start date to generate report specific preiod.
+ * @property {string} [end_date] - The end date to generate report specific preiod.
  * @property {GenerateReportMeta} [meta]
- * @property {string} [report_id]
+ * @property {string} [report_id] - The unique identifier of the generate report
+ *   where different report configure.
  * @property {GenerateReportFilters} [filters]
  */
 
@@ -37,31 +43,32 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**
  * @typedef Currency
- * @property {string} [code]
- * @property {string} [symbol]
- * @property {string} [name]
+ * @property {string} [code] - The unique currency code.
+ * @property {string} [symbol] - The unique currency symbol.
+ * @property {string} [name] - The unique currency name.
  */
 
 /**
  * @typedef GenerateReportJson
  * @property {Object} [data]
- * @property {number} [item_count]
+ * @property {number} [item_count] - Total number of items in the report.
  * @property {Page} [page]
- * @property {string} [end_date]
- * @property {string} [start_date]
- * @property {string[][]} [items]
- * @property {string[]} [headers]
+ * @property {string} [end_date] - The end date to generate report specific preiod.
+ * @property {string} [start_date] - The start date to generate report specific preiod.
+ * @property {string[][]} [items] - Nested array structure representing report
+ *   items or data.
+ * @property {string[]} [headers] - Headers describing each item in the report data.
  */
 
 /**
@@ -96,47 +103,50 @@ const Joi = require("joi");
 
 /**
  * @typedef DownloadReportData
- * @property {number} [page]
- * @property {number} [page_size]
- * @property {string} [start_date]
- * @property {string} [end_date]
+ * @property {number} [page] - The current page number of the report.
+ * @property {number} [page_size] - The number of items displayed per page.
+ * @property {string} [start_date] - The start date for fetching the report
+ *   history for download.
+ * @property {string} [end_date] - The end date for fetching the report history
+ *   for download.
  */
 
 /**
  * @typedef DownloadReportItems
- * @property {string} [start_date]
- * @property {string} [end_date]
+ * @property {string} [start_date] - The start date for the report item.
+ * @property {string} [end_date] - The end date for the report item.
  * @property {GenerateReportMeta} [meta]
- * @property {string} [report_id]
+ * @property {string} [report_id] - The unique identifier of the report item.
  * @property {GenerateReportFilters} [filters]
- * @property {string} [type_of_request]
  */
 
 /**
  * @typedef DownloadReportList
- * @property {DownloadReportItems[]} [items]
+ * @property {DownloadReportItems[]} [items] - A list of report items available
+ *   for download.
  * @property {Page} [page]
- * @property {number} [item_count]
+ * @property {number} [item_count] - The total number of items in the report list.
  */
 
 /**
  * @typedef GetEngineFilters
- * @property {string} [config_field]
- * @property {string} [status]
- * @property {boolean} [is_active]
- * @property {string} [seller_id]
+ * @property {string} [config_field] - The configuration field used for filtering.
+ * @property {string} [status] - The status used for filtering.
+ * @property {boolean} [is_active] - Flag indicating if the filter is active.
+ * @property {string} [seller_id] - The seller ID used for filtering.
  */
 
 /**
  * @typedef GetEngineData
- * @property {string} [status]
+ * @property {string} [status] - Status of the request.
  * @property {GetEngineFilters} [filters]
- * @property {string[]} [project]
- * @property {string} [table_name]
- * @property {Object} [search]
- * @property {number} [page]
- * @property {number} [page_size]
- * @property {string} [order_by]
+ * @property {string[]} [project] - A list of fields to get data from tables.
+ * @property {string} [table_name] - The name of the table from which to retrieve data.
+ * @property {Object} [search] - Search criteria for querying on given table
+ *   specific fields.
+ * @property {number} [page] - The current page number for pagination.
+ * @property {number} [page_size] - The number of items displayed per page.
+ * @property {string} [order_by] - The field by which to order the results.
  */
 
 /**
@@ -146,15 +156,15 @@ const Joi = require("joi");
 
 /**
  * @typedef GetEngineResponse
- * @property {boolean} [success]
- * @property {Object[]} [items]
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {Object[]} [items] - A list of items returned by the request.
  * @property {Page} [page]
- * @property {number} [item_count]
+ * @property {number} [item_count] - The total number of items returned by the request.
  */
 
 /**
  * @typedef GetReason
- * @property {string} [reason_type]
+ * @property {string} [reason_type] - The type of reason associated with the request.
  */
 
 /**
@@ -164,23 +174,24 @@ const Joi = require("joi");
 
 /**
  * @typedef ReasonItem
- * @property {string} [id]
- * @property {string} [name]
- * @property {string} [display_name]
+ * @property {string} [id] - Id of the reason for reason_type.
+ * @property {string} [name] - Code of the reason for reason_type.
+ * @property {string} [display_name] - Display name of the reason for reason_type.
  */
 
 /**
  * @typedef GetReasonResponse
- * @property {boolean} [success]
- * @property {ReasonItem[]} [item_list]
- * @property {number} [item_count]
+ * @property {boolean} [success] - Indicates whether the request was successfull.
+ * @property {ReasonItem[]} [item_list] - The list of items returned in the response.
+ * @property {number} [item_count] - The number of items in the response.
  * @property {Page} [page]
  */
 
 /**
  * @typedef GetReportListData
- * @property {string} [role_name]
- * @property {boolean} [listing_enabled]
+ * @property {string} [role_name] - The name of the role requesting the report list.
+ * @property {boolean} [listing_enabled] - Indicates whether listing is enabled
+ *   for the role.
  */
 
 /**
@@ -188,40 +199,43 @@ const Joi = require("joi");
  * @property {GetReportListData} [data]
  */
 
-/**
- * @typedef GetAffiliate
- * @property {number} [company_id]
- */
-
 /**
  * @typedef GetReportListResponse
- * @property {boolean} [success]
- * @property {ReportItem[]} [items]
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {ReportItem[]} [items] - The list of report items.
  * @property {Page} [page]
- * @property {number} [total_count]
+ * @property {number} [total_count] - The total number of items in the report list.
  */
 
 /**
  * @typedef ReportItem
- * @property {string} [id]
- * @property {string} [name]
- * @property {string} [description]
- * @property {string[]} [allowed_filters]
- * @property {Object} [config_meta]
- * @property {string} [report_type]
- * @property {string} [display_date]
+ * @property {string} [id] - The unique identifier for the report item.
+ * @property {string} [name] - The name of the report item.
+ * @property {string} [description] - A brief description of the report item.
+ * @property {string[]} [allowed_filters] - The filters that can be applied to
+ *   the report item.
+ * @property {Object} [config_meta] - Metadata related to the report item configuration.
+ * @property {string} [report_type] - The type of the report item.
+ * @property {string} [display_date] - The display date of the report item, if applicable.
+ */
+
+/**
+ * @typedef GetAffiliate
+ * @property {number} [company_id] - The unique identifier of the company
+ *   associated with the affiliate.
  */
 
 /**
  * @typedef GetAffiliateResponse
- * @property {string} [reason]
- * @property {boolean} [success]
- * @property {Object[]} [docs]
+ * @property {string} [reason] - The reason for the response, if applicable.
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {Object[]} [docs] - List of items or data related to the affiliate.
  */
 
 /**
  * @typedef DownloadCreditDebitNote
- * @property {string[]} [note_id]
+ * @property {string[]} [note_id] - List of unique identifiers for the
+ *   credit/debit notes to be download.
  */
 
 /**
@@ -231,33 +245,38 @@ const Joi = require("joi");
 
 /**
  * @typedef DownloadCreditDebitNoteResponseData
- * @property {string} [id]
- * @property {string} [pdf_s3_url]
+ * @property {string} [id] - The unique identifier of the download credit/debit note.
+ * @property {string} [pdf_s3_url] - The URL where the PDF of the credit/debit
+ *   note is stored.
  */
 
 /**
  * @typedef DownloadCreditDebitNoteResponse
- * @property {boolean} [success]
- * @property {DownloadCreditDebitNoteResponseData[]} [data]
+ * @property {boolean} [success] - Indicates whether the request to download the
+ *   credit/debit notes was successful.
+ * @property {DownloadCreditDebitNoteResponseData[]} [data] - List of
+ *   credit/debit notes download data.
  */
 
 /**
  * @typedef InvoiceBillingItem
- * @property {string} [invoice_number]
- * @property {number} [amount]
+ * @property {string} [invoice_number] - The number of the invoice associated
+ *   with the billing item.
+ * @property {number} [amount] - The amount of the billing item.
  */
 
 /**
  * @typedef PaymentProcessPayload
- * @property {string} [platform]
- * @property {number} [amount]
- * @property {string} [transaction_type]
- * @property {string} [source_reference]
- * @property {number} [total_amount]
- * @property {Object} [meta]
- * @property {string} [currency]
- * @property {string} [seller_id]
- * @property {string} [mode_of_payment]
+ * @property {string} [platform] - The platform through which the payment is processed.
+ * @property {number} [amount] - The total amount to be processed in the payment.
+ * @property {string} [transaction_type] - The type of transaction (e.g., seller_online).
+ * @property {string} [source_reference] - The reference for the source of the payment.
+ * @property {number} [total_amount] - The total amount to be processed in the payment.
+ * @property {Object} [meta] - Additional metadata related to the payment.
+ * @property {string} [currency] - The currency in which the payment is made.
+ * @property {string} [seller_id] - The unique identifier for the seller
+ *   receiving the payment.
+ * @property {string} [mode_of_payment] - The mode of payment (e.g., online).
  * @property {InvoiceBillingItem[]} [invoice_billing_items]
  */
 
@@ -268,20 +287,24 @@ const Joi = require("joi");
 
 /**
  * @typedef PaymentProcessResponse
- * @property {number} [code]
- * @property {string} [message]
- * @property {Object} [meta]
- * @property {string} [transaction_id]
- * @property {string} [redirect_url]
+ * @property {number} [code] - Response code indicating the status of the payment process.
+ * @property {string} [message] - A message providing additional information
+ *   about the payment process response.
+ * @property {Object} [meta] - Additional metadata related to the payment
+ *   process response.
+ * @property {string} [transaction_id] - The unique identifier for the payment
+ *   transaction.
+ * @property {string} [redirect_url] - URL to redirect the user to complete the
+ *   payment process, if applicable.
  */
 
 /**
  * @typedef CreditlineDataPlatformPayload
- * @property {number} [page]
- * @property {string} [seller_id]
- * @property {string} [end_date]
- * @property {string} [start_date]
- * @property {number} [page_size]
+ * @property {number} [page] - The page number for pagination.
+ * @property {string} [seller_id] - The unique identifier for the seller.
+ * @property {string} [end_date] - The end date for the query.
+ * @property {string} [start_date] - The start date for the query.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -291,18 +314,20 @@ const Joi = require("joi");
 
 /**
  * @typedef CreditlineDataPlatformResponse
- * @property {Object[]} [items]
- * @property {number} [code]
- * @property {boolean} [show_mr]
+ * @property {Object[]} [items] - The list of items in the response.
+ * @property {number} [code] - The response status code.
+ * @property {boolean} [show_mr] - A flag indicating whether to show MR (some
+ *   specific field).
  * @property {Page} [page]
- * @property {string} [message]
- * @property {string[]} [headers]
- * @property {number} [item_count]
+ * @property {string} [message] - The response message.
+ * @property {string[]} [headers] - The list of response headers.
+ * @property {number} [item_count] - The total number of items.
  */
 
 /**
  * @typedef IsCreditlinePayload
- * @property {string} [seller_id]
+ * @property {string} [seller_id] - The unique identifier for the seller to
+ *   check for credit line eligibility.
  */
 
 /**
@@ -312,13 +337,15 @@ const Joi = require("joi");
 
 /**
  * @typedef IsCreditlinePlatformResponse
- * @property {boolean} [is_creditline_opted]
- * @property {number} [code]
+ * @property {boolean} [is_creditline_opted] - Indicates whether the seller has
+ *   opted for a credit line.
+ * @property {number} [code] - Response code indicating the status of the credit
+ *   line check.
  */
 
 /**
  * @typedef InvoiceTypePayloadData
- * @property {boolean} [is_active]
+ * @property {boolean} [is_active] - Indicates if the invoice type is active.
  */
 
 /**
@@ -328,31 +355,33 @@ const Joi = require("joi");
 
 /**
  * @typedef InvoiceTypeResponseItems
- * @property {string} [text]
- * @property {string} [value]
+ * @property {string} [text] - The text description of the invoice type.
+ * @property {string} [value] - The value or code representing the invoice type.
  */
 
 /**
  * @typedef InvoiceTypeResponse
- * @property {boolean} [success]
- * @property {InvoiceTypeResponseItems[]} [invoice_type_list]
- * @property {InvoiceTypeResponseItems[]} [payment_status_list]
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {InvoiceTypeResponseItems[]} [invoice_type_list] - List of invoice
+ *   types available.
+ * @property {InvoiceTypeResponseItems[]} [payment_status_list] - List of
+ *   payment statuses available.
  */
 
 /**
  * @typedef InoviceListingPayloadDataFilters
- * @property {string[]} [payment_status]
- * @property {string[]} [invoice_type]
- * @property {string[]} [company_id]
+ * @property {string[]} [payment_status] - List of payment statuses to filter by.
+ * @property {string[]} [invoice_type] - List of invoice types to filter by.
+ * @property {string[]} [company_id] - List of company IDs to filter by.
  */
 
 /**
  * @typedef InvoiceListingPayloadData
- * @property {number} [page_size]
- * @property {number} [page]
- * @property {string} [start_date]
- * @property {string} [end_date]
- * @property {string} [search]
+ * @property {number} [page_size] - The number of items per page for pagination.
+ * @property {number} [page] - The page number for pagination.
+ * @property {string} [start_date] - The start date for the invoice listing filter.
+ * @property {string} [end_date] - The end date for the invoice listing filter.
+ * @property {string} [search] - Search term for filtering invoices.
  * @property {InoviceListingPayloadDataFilters} [filters]
  */
 
@@ -363,39 +392,43 @@ const Joi = require("joi");
 
 /**
  * @typedef UnpaidInvoiceDataItems
- * @property {number} [total_unpaid_invoice_count]
- * @property {string} [currency]
- * @property {number} [total_unpaid_amount]
+ * @property {number} [total_unpaid_invoice_count] - The total count of unpaid invoices.
+ * @property {string} [currency] - The currency used for unpaid invoices.
+ * @property {number} [total_unpaid_amount] - The total amount of unpaid invoices.
  */
 
 /**
  * @typedef InvoiceListingResponseItems
- * @property {number} [amount]
- * @property {string} [company]
- * @property {string} [status]
- * @property {string} [due_date]
- * @property {string} [invoice_date]
- * @property {string} [invoice_type]
- * @property {string} [period]
- * @property {string} [invoice_number]
- * @property {boolean} [is_downloadable]
- * @property {string} [invoice_id]
+ * @property {number} [amount] - The amount of the invoice.
+ * @property {string} [company] - The name of the company associated with the invoice.
+ * @property {string} [status] - The current status of the invoice (e.g.,
+ *   'paid', 'unpaid').
+ * @property {string} [due_date] - The due date of the invoice.
+ * @property {string} [invoice_date] - The date when the invoice was issued.
+ * @property {string} [invoice_type] - The type of invoice.
+ * @property {string} [period] - The period covered by the invoice.
+ * @property {string} [invoice_number] - The invoice number.
+ * @property {boolean} [is_downloadable] - Indicates if the invoice is available
+ *   for download.
+ * @property {string} [invoice_id] - The unique identifier of the invoice.
  * @property {Currency} [currency]
  */
 
 /**
  * @typedef InvoiceListingResponse
- * @property {boolean} [success]
- * @property {string[]} [headers]
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {string[]} [headers] - Headers related to the invoice listing response.
  * @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
- * @property {InvoiceListingResponseItems[]} [items]
+ * @property {InvoiceListingResponseItems[]} [items] - List of invoice items in
+ *   the response.
  * @property {Page} [page]
- * @property {number} [item_count]
+ * @property {number} [item_count] - The total number of invoice items in the response.
  */
 
 /**
  * @typedef InvoicePdfPayloadData
- * @property {string[]} [invoice_number]
+ * @property {string[]} [invoice_number] - List of invoice numbers for which
+ *   PDFs are requested.
  */
 
 /**
@@ -405,16 +438,19 @@ const Joi = require("joi");
 
 /**
  * @typedef InvoicePdfResponse
- * @property {boolean} [success]
- * @property {string[]} [data]
- * @property {string[]} [error]
+ * @property {boolean} [success] - Indicates whether the PDF generation request
+ *   was successful.
+ * @property {string[]} [data] - List of URLs or paths to the generated PDF files.
+ * @property {string[]} [error] - List of errors encountered while generating the PDFs.
  */
 
 /**
  * @typedef IsCnRefundMethodData
- * @property {string} [affiliate_id]
- * @property {boolean} [toggle_edit_required]
- * @property {number} [seller_id]
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {boolean} [toggle_edit_required] - Indicates whether editing the
+ *   refund method is required.
+ * @property {number} [seller_id] - Unique identifier for the seller.
  */
 
 /**
@@ -424,32 +460,40 @@ const Joi = require("joi");
 
 /**
  * @typedef IsCnRefundMethodResponseData
- * @property {boolean} [is_first_time_user]
+ * @property {boolean} [is_first_time_user] - Indicates whether the seller for
+ *   specific sale channel is using the refund method for the first time.
  */
 
 /**
  * @typedef IsCnRefundMethodResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates whether the request to determine
+ *   the refund method was successful.
  * @property {IsCnRefundMethodResponseData} [data]
  */
 
 /**
  * @typedef CreditNoteConfigNotificationEvents
- * @property {number} [expiration_reminder_to_customer]
+ * @property {number} [expiration_reminder_to_customer] - Number of days before
+ *   the expiration date to send a reminder notification to the customer.
  */
 
 /**
  * @typedef CreateSellerCreditNoteConfig
- * @property {boolean} [is_cn_as_refund_method]
- * @property {string} [affiliate_id]
- * @property {string[]} [source_channel]
- * @property {number} [seller_id]
+ * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
+ *   is used as a refund method.
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string[]} [source_channel] - List of source channels associated
+ *   with the credit note configuration.
+ * @property {number} [seller_id] - Unique identifier for the seller.
  * @property {CreditNoteConfigNotificationEvents} [notification_events]
- * @property {string} [sales_channel_name]
- * @property {string[]} [ordering_channel]
- * @property {number} [validity]
- * @property {string} [currency_type]
- * @property {string[]} [slug_values]
+ * @property {string} [sales_channel_name] - Name of the sales channel.
+ * @property {string[]} [ordering_channel] - List of ordering channels
+ *   associated with the credit note configuration.
+ * @property {number} [validity] - Validity period of the credit note in days.
+ * @property {string} [currency_type] - Type of currency used for the credit note.
+ * @property {string[]} [slug_values] - List of slug values associated with the
+ *   credit note configuration.
  */
 
 /**
@@ -459,15 +503,19 @@ const Joi = require("joi");
 
 /**
  * @typedef CreateSellerCreditNoteConfigResponse
- * @property {boolean} [success]
- * @property {string} [message]
+ * @property {boolean} [success] - Indicates if the credit note configuration
+ *   creation was successful.
+ * @property {string} [message] - Additional information or message about the
+ *   credit note configuration creation process.
  */
 
 /**
  * @typedef DeleteConfig
- * @property {string} [affiliate_id]
- * @property {string[]} [slug_values]
- * @property {number} [seller_id]
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string[]} [slug_values] - List of slug values associated with the
+ *   credit note configuration.
+ * @property {number} [seller_id] - Unique identifier for the seller.
  */
 
 /**
@@ -477,25 +525,29 @@ const Joi = require("joi");
 
 /**
  * @typedef DeleteConfigResponse
- * @property {boolean} [success]
- * @property {string} [message]
+ * @property {boolean} [success] - Indicates if the configuration deletion was successful.
+ * @property {string} [message] - Additional information or message about the
+ *   configuration deletion process.
  */
 
 /**
  * @typedef ChannelDisplayNameItems
- * @property {string} [key]
- * @property {string} [value]
+ * @property {string} [key] - The unique key identifying the channel.
+ * @property {string} [value] - The display name of the channel associated with the key.
  */
 
 /**
  * @typedef ChannelDisplayNameResponse
- * @property {boolean} [success]
- * @property {ChannelDisplayNameItems[]} [items]
+ * @property {boolean} [success] - Indicates if the retrieval of channel display
+ *   names was successful.
+ * @property {ChannelDisplayNameItems[]} [items] - List of items containing
+ *   key-value pairs for channel display names.
  */
 
 /**
  * @typedef CnReferenceNumber
- * @property {string} [cn_reference_number]
+ * @property {string} [cn_reference_number] - The unique reference number of the
+ *   credit note.
  */
 
 /**
@@ -505,13 +557,16 @@ const Joi = require("joi");
 
 /**
  * @typedef GetPdfUrlViewResponseData
- * @property {string} [s3_pdf_link]
- * @property {string} [cn_reference_number]
+ * @property {string} [s3_pdf_link] - The URL link where credit nore pdf stored
+ *   to view and download.
+ * @property {string} [cn_reference_number] - The unique reference number of the
+ *   credit note.
  */
 
 /**
  * @typedef GetPdfUrlViewResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates if the retrieval of the pdf URL was
+ *   successful.
  * @property {GetPdfUrlViewResponseData} [data]
  */
 
@@ -522,55 +577,65 @@ const Joi = require("joi");
 
 /**
  * @typedef CnDetails
- * @property {string} [staff_id]
- * @property {string} [expiry_date]
- * @property {string} [channel_of_issuance]
- * @property {string} [order_id]
- * @property {string} [date_issued]
- * @property {string} [ordering_channel]
- * @property {string} [shipment_id]
- * @property {string} [store_id]
- * @property {string} [invoice_number]
+ * @property {string} [staff_id] - ID of the staff member associated with the credit note.
+ * @property {string} [expiry_date] - Expiry date of the credit note.
+ * @property {string} [channel_of_issuance] - Channel through which the credit
+ *   note was issued.
+ * @property {string} [order_id] - Order ID of order for which credit note created.
+ * @property {string} [date_issued] - Date when the credit note was issued.
+ * @property {string} [ordering_channel] - Ordering channel associated with the
+ *   credit note.
+ * @property {string} [shipment_id] - Shipment Id associated with the credit note.
+ * @property {string} [store_id] - Store Id associated with the credit note.
+ * @property {string} [invoice_number] - Invoice number associated with the credit note.
  */
 
 /**
  * @typedef RedemptionDetails
- * @property {Object} [meta]
- * @property {string} [staff_id]
- * @property {string} [created_at]
- * @property {string} [order_id]
- * @property {string} [store_id]
- * @property {string} [shipment_id]
- * @property {string} [ordering_channel]
- * @property {number} [amount_debited]
- * @property {string} [invoice_number]
+ * @property {Object} [meta] - Additional metadata related to the redemption details.
+ * @property {string} [staff_id] - ID of the staff member who processed the redemption.
+ * @property {string} [created_at] - Date and time when the redemption was processed.
+ * @property {string} [order_id] - Order Id of the order associated with the redemption.
+ * @property {string} [store_id] - Store Id of the order associated with the redemption.
+ * @property {string} [shipment_id] - Shipment Id of the order associated with
+ *   the redemption.
+ * @property {string} [ordering_channel] - Ordering channel associated with the
+ *   redemption.
+ * @property {number} [amount_debited] - Amount debited from the credit note
+ *   during redemption.
+ * @property {string} [invoice_number] - Invoice number associated with the redemption.
  */
 
 /**
  * @typedef CreditNoteDetails
- * @property {string} [currency]
- * @property {number} [current_amount_used]
- * @property {string} [cn_status]
- * @property {string} [customer_mobile_number]
- * @property {string} [cn_reference_number]
+ * @property {string} [currency] - Currency in which the credit note is issued.
+ * @property {number} [current_amount_used] - Current amount used from the credit note.
+ * @property {string} [cn_status] - Status of the credit note.
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   associated with the credit note.
+ * @property {string} [cn_reference_number] - Unique Credit number of the credit note.
  * @property {CnDetails} [cn_details]
- * @property {RedemptionDetails[]} [redemption_details]
- * @property {number} [remaining_cn_amount]
- * @property {number} [available_cn_balance]
- * @property {number} [cn_amount]
+ * @property {RedemptionDetails[]} [redemption_details] - List of redemption
+ *   details associated with the credit note.
+ * @property {number} [remaining_cn_amount] - Remaining amount left in the credit note.
+ * @property {number} [available_cn_balance] - Available balance in the credit note.
+ * @property {number} [cn_amount] - Total amount of the credit note.
  */
 
 /**
  * @typedef CreditNoteDetailsResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates if the retrieval of credit note
+ *   details was successful.
  * @property {CreditNoteDetails} [data]
  */
 
 /**
  * @typedef GetCustomerCreditBalance
- * @property {string} [affiliate_id]
- * @property {number} [seller_id]
- * @property {string} [customer_mobile_number]
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {number} [seller_id] - Unique identifier for the seller.
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   for whom the credit balance is requested.
  */
 
 /**
@@ -580,13 +645,15 @@ const Joi = require("joi");
 
 /**
  * @typedef GetCustomerCreditBalanceResponseData
- * @property {string} [customer_mobile_number]
- * @property {number} [total_credited_balance]
+ * @property {string} [customer_mobile_number] - Mobile number of the customer.
+ * @property {number} [total_credited_balance] - Total credited balance
+ *   available for the customer.
  */
 
 /**
  * @typedef GetCustomerCreditBalanceResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates if the retrieval of customer credit
+ *   balance was successful.
  * @property {GetCustomerCreditBalanceResponseData} [data]
  */
 
@@ -597,51 +664,64 @@ const Joi = require("joi");
 
 /**
  * @typedef GetCnConfigResponseMeta
- * @property {string} [reason]
- * @property {string[]} [source_channel]
+ * @property {string} [reason] - Reason associated with the configuration response.
+ * @property {string[]} [source_channel] - List of source channels associated
+ *   with the credit note configuration.
  */
 
 /**
  * @typedef GetCnConfigResponseData
- * @property {boolean} [is_cn_as_refund_method]
- * @property {string} [affiliate_id]
+ * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
+ *   is configured as a refund method.
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
  * @property {Object} [meta]
- * @property {number} [seller_id]
+ * @property {number} [seller_id] - Unique identifier for the seller.
  * @property {CreditNoteConfigNotificationEvents} [notification_events]
- * @property {number} [validity]
- * @property {string[]} [redemption_ordering_channel]
- * @property {string} [currency_type]
+ * @property {number} [validity] - Validity period of the credit note
+ *   configuration in days.
+ * @property {string[]} [redemption_ordering_channel] - List of ordering
+ *   channels associated with credit note redemption.
+ * @property {string} [currency_type] - Type of currency used for the credit note.
  */
 
 /**
  * @typedef GetCnConfigResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates if the retrieval of credit note
+ *   configuration was successful.
  * @property {GetCnConfigResponseData} [data]
  */
 
 /**
  * @typedef CnGenerateReportFilters
- * @property {string[]} [staff_id]
- * @property {string[]} [channel_of_issuance]
- * @property {string[]} [utilisation]
- * @property {string[]} [ordering_channel]
- * @property {number[]} [store_id]
- * @property {string[]} [type_of_transaction]
- * @property {string[]} [issuance_channel]
+ * @property {string[]} [staff_id] - Array of staff IDs for filtering credit note reports.
+ * @property {string[]} [channel_of_issuance] - Array of channels through which
+ *   credit notes were issued.
+ * @property {string[]} [utilisation] - Array of utilisation types for filtering
+ *   credit note reports.
+ * @property {string[]} [ordering_channel] - Array of ordering channels
+ *   associated with credit note reports.
+ * @property {number[]} [store_id] - Array of store IDs for filtering credit note reports.
+ * @property {string[]} [type_of_transaction] - Array of transaction types for
+ *   filtering credit note reports.
+ * @property {string[]} [issuance_channel] - Array of issuance channels for
+ *   filtering credit note reports.
  */
 
 /**
  * @typedef CnGenerateReport
- * @property {number} [page]
- * @property {string} [end_date]
- * @property {number} [page_size]
+ * @property {number} [page] - Page number of the credit note report.
+ * @property {string} [end_date] - End date for filtering credit note data.
+ * @property {number} [page_size] - Number of items per page in the credit note report.
  * @property {CnGenerateReportFilters} [filters]
- * @property {string} [affiliate_id]
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
  * @property {GenerateReportFilters} [meta]
- * @property {string} [search]
- * @property {string} [report_id]
- * @property {string} [search_type]
- * @property {string} [start_date]
+ * @property {string} [search] - Search query to filter credit note data by keyword.
+ * @property {string} [report_id] - Unique identifier for the credit note report.
+ * @property {string} [search_type] - Type of search criteria used for filtering
+ *   credit note data.
+ * @property {string} [start_date] - Start date for filtering credit note data.
  */
 
 /**
@@ -651,29 +731,36 @@ const Joi = require("joi");
 
 /**
  * @typedef CnGenerateReportItems
- * @property {string} [expiry_date]
- * @property {string} [status]
- * @property {number} [total_amount]
- * @property {string} [order_id]
- * @property {string} [date_issued]
- * @property {string} [shipment_id]
- * @property {string} [invoice_number]
- * @property {string} [credit_note_number]
+ * @property {string} [expiry_date] - Expiry date of the credit note item.
+ * @property {string} [status] - Status of the credit note item.
+ * @property {number} [total_amount] - Total amount of the credit note item.
+ * @property {string} [order_id] - Order ID of the order associated with the
+ *   credit note item.
+ * @property {string} [date_issued] - Date when the credit note item was issued.
+ * @property {string} [shipment_id] - Shipment ID of the order associated with
+ *   the credit note item.
+ * @property {string} [invoice_number] - Invoice number associated with the
+ *   credit note item.
+ * @property {string} [credit_note_number] - Unique number of the credit note item.
  */
 
 /**
  * @typedef GenerateReportCustomerCnResponseData
- * @property {boolean} [success]
- * @property {string} [message]
- * @property {CnGenerateReportItems[]} [items]
- * @property {Object} [row_header_display_order]
- * @property {string} [end_date]
+ * @property {boolean} [success] - Indicates if the credit note report
+ *   generation was successful.
+ * @property {string} [message] - Additional message or information related to
+ *   the credit note report.
+ * @property {CnGenerateReportItems[]} [items] - List of credit note items in the report.
+ * @property {Object} [row_header_display_order] - Display order for row headers
+ *   in the report.
+ * @property {string} [end_date] - End date used in the credit note report.
  * @property {Page} [page]
- * @property {string[]} [headers]
- * @property {string[]} [primary_headers]
- * @property {string[]} [allowed_filters]
- * @property {string} [start_date]
- * @property {number} [item_count]
+ * @property {string[]} [headers] - Headers included in the credit note report.
+ * @property {string[]} [primary_headers] - Primary headers used in the credit
+ *   note report.
+ * @property {string[]} [allowed_filters] - Allowed filters for the credit note report.
+ * @property {string} [start_date] - Start date used in the credit note report.
+ * @property {number} [item_count] - Total count of credit note items in the report.
  */
 
 /**
@@ -683,14 +770,17 @@ const Joi = require("joi");
 
 /**
  * @typedef CnDownloadReport
- * @property {number} [page]
- * @property {string} [start_date]
- * @property {string} [end_date]
- * @property {string} [affiliate_id]
- * @property {string} [search]
- * @property {string} [status]
- * @property {string} [search_type]
- * @property {number} [page_size]
+ * @property {number} [page] - Page number of the download report.
+ * @property {string} [start_date] - Start date for filtering credit note data
+ *   in the report.
+ * @property {string} [end_date] - End date for filtering credit note data in the report.
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string} [search] - Search query to filter credit note data by keyword.
+ * @property {string} [status] - Status of the credit note data in the report.
+ * @property {string} [search_type] - Type of search criteria used for filtering
+ *   credit note data.
+ * @property {number} [page_size] - Number of items per page in the download report.
  */
 
 /**
@@ -700,74 +790,77 @@ const Joi = require("joi");
 
 /**
  * @typedef DownloadReportResponseData
- * @property {string} [report_config_id]
- * @property {string} [full_name]
- * @property {string} [requested_by]
- * @property {string} [start_date]
- * @property {string} [end_date]
- * @property {Object} [request_dict]
- * @property {string} [download_link]
- * @property {string} [created_at]
- * @property {Object} [meta]
- * @property {string} [msg]
- * @property {string} [report_name]
- * @property {string} [status]
- * @property {string} [display_name]
- * @property {Object} [filters]
+ * @property {string} [report_config_id] - Unique identifier for the report configuration.
+ * @property {string} [full_name] - Full name associated with the report request.
+ * @property {string} [requested_by] - User who requested the report.
+ * @property {string} [start_date] - Start date used in the report.
+ * @property {string} [end_date] - End date used in the report.
+ * @property {Object} [request_dict] - Dictionary containing request parameters
+ *   for the report.
+ * @property {string} [download_link] - Download link for accessing the generated report.
+ * @property {string} [created_at] - Date and time when the report was created.
+ * @property {Object} [meta] - Additional metadata associated with the report.
+ * @property {string} [msg] - Message related to the report status or generation.
+ * @property {string} [report_name] - Name of the generated report.
+ * @property {string} [status] - Status of the report.
+ * @property {string} [display_name] - Display name of the report.
+ * @property {Object} [filters] - Filters applied to generate the report.
  */
 
 /**
  * @typedef DownloadReportCustomerCnResponse
- * @property {DownloadReportResponseData[]} [items]
- * @property {DownloadReportResponseData[]} [data]
- * @property {number} [item_count]
+ * @property {DownloadReportResponseData[]} [items] - List of download report data items.
+ * @property {number} [item_count] - Total count of items in the download report.
  * @property {Page} [page]
  */
 
 /**
  * @typedef GetReportingFilters
- * @property {string} [text]
- * @property {string} [type]
- * @property {Object[]} [options]
- * @property {string} [value]
+ * @property {string} [text] - Display text for the filter.
+ * @property {string} [type] - Type of the fields like seach, filter(e.g.,
+ *   single, multi select).
+ * @property {Object[]} [options] - Options available for the filter.
+ * @property {string} [value] - Value to be pass in response select from options.
  */
 
 /**
  * @typedef GetReportingNestedFilters
- * @property {string} [text]
- * @property {Object[]} [options]
- * @property {boolean} [required]
- * @property {string} [placeholder_text]
- * @property {string} [type]
- * @property {string} [value]
+ * @property {string} [text] - Display text for the nested filter.
+ * @property {Object[]} [options] - Options available for the nested filter.
+ * @property {boolean} [required] - Indicates if the nested filter is required.
+ * @property {string} [placeholder_text] - Placeholder text for the nested filter.
+ * @property {string} [type] - Type of the nested filter (e.g., single, multi select).
+ * @property {string} [value] - Value to be pass in response select from options.
  */
 
 /**
  * @typedef GetReportingFiltersReasonOptions
- * @property {string} [text]
- * @property {string} [value]
- * @property {string} [placeholder_text]
+ * @property {string} [text] - Display text for the reason option.
+ * @property {string} [value] - Value of the reason option.
+ * @property {string} [placeholder_text] - Placeholder text for the reason option.
  */
 
 /**
  * @typedef GetReportingFiltersReason
- * @property {string} [text]
- * @property {string} [type]
- * @property {string} [value]
- * @property {GetReportingFiltersReasonOptions[]} [options]
+ * @property {string} [text] - Display text for the reason.
+ * @property {string} [type] - Type of the reason.
+ * @property {string} [value] - Value to be pass in response.
+ * @property {GetReportingFiltersReasonOptions[]} [options] - Options available
+ *   for the reasons select from options.
  */
 
 /**
  * @typedef GetReportingFiltersResponse
  * @property {GetReportingFiltersReason} [reason]
  * @property {GetReportingFilters} [search]
- * @property {GetReportingNestedFilters[]} [filters]
+ * @property {GetReportingNestedFilters[]} [filters] - Array of nested filter objects.
  * @property {GetReportingFilters} [status]
  */
 
 /**
  * @typedef InvoicePaymentOptionsPayloadData
- * @property {string[]} [invoice_numbers]
+ * @property {string[]} [invoice_numbers] - List of invoice numbers for which
+ *   payment options are being requested.
  */
 
 /**
@@ -777,93 +870,115 @@ const Joi = require("joi");
 
 /**
  * @typedef InvoicePaymentOptionsResponsePayableAmounts
- * @property {number} [amount]
- * @property {string} [amount_key]
- * @property {string} [header]
+ * @property {number} [amount] - Amount that is payable for the invoice.
+ * @property {string} [amount_key] - Key associated with the payable amount for
+ *   identification.
+ * @property {string} [header] - Header describing the payable amount.
  */
 
 /**
  * @typedef InvoicePaymentOptionsResponseDeductedAmounts
- * @property {number} [amount]
- * @property {string} [header]
- * @property {string} [amount_key]
- * @property {boolean} [is_payable]
- * @property {string} [symbol]
+ * @property {number} [amount] - Amount deducted from the invoice.
+ * @property {string} [header] - Header describing the deducted amount.
+ * @property {string} [amount_key] - Key associated with the deducted amount for
+ *   identification.
+ * @property {boolean} [is_payable] - Indicates whether the deducted amount is payable.
+ * @property {string} [symbol] - Currency symbol associated with the deducted amount.
  */
 
 /**
  * @typedef InvoicePaymentOptionsResponseData
- * @property {string} [invoice_number]
- * @property {string} [invoice_type]
+ * @property {string} [invoice_number] - Invoice number for which payment
+ *   options are provided.
+ * @property {string} [invoice_type] - Type of the invoice (e.g., 'Seller Fynd',
+ *   'Platform Subscription').
  * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
- * @property {Object} [total_amount]
- * @property {Object} [deducted_amounts]
+ *   - List of amounts that are payable for the invoice.
+ *
+ * @property {Object} [total_amount] - Total amount for the invoice.
+ * @property {Object} [deducted_amounts] - Amounts deducted from the total,
+ *   including any associated details.
  * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
+ *   - Amounts that are payable for the invoice.
+ *
  * @property {Currency} [currency]
  */
 
 /**
  * @typedef InvoicePaymentOptionsResponse
- * @property {string} [reason]
- * @property {InvoicePaymentOptionsResponseData[]} [data]
- * @property {number} [total_payable_amount]
- * @property {number} [invoice_count]
- * @property {boolean} [success]
+ * @property {string} [reason] - Reason for the response or any errors encountered.
+ * @property {InvoicePaymentOptionsResponseData[]} [data] - List of data objects
+ *   containing details about invoice payment options.
+ * @property {number} [total_payable_amount] - Total amount payable for the invoices.
+ * @property {number} [invoice_count] - Number of invoices included in the response.
+ * @property {boolean} [success] - Indicates whether the request to retrieve
+ *   invoice payment options was successful.
  */
 
 /**
  * @typedef PaymentDetail
- * @property {string} [display_name]
- * @property {string} [value]
+ * @property {string} [display_name] - Name or label displayed for the payment detail.
+ * @property {string} [value] - Value associated with the payment detail (e.g.,
+ *   amount, transaction ID).
  */
 
 /**
  * @typedef PaidInvoicePaymentDetail
- * @property {PaymentDetail[]} [payment_details]
- * @property {string} [date_of_payment]
- * @property {number} [amount]
+ * @property {PaymentDetail[]} [payment_details] - List of payment details for
+ *   the invoice.
+ * @property {string} [date_of_payment] - Date when the payment was made.
+ * @property {number} [amount] - Amount paid towards the invoice.
  */
 
 /**
  * @typedef InvoicePaymentDetailsResponseData
- * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details]
- * @property {Object[]} [failed_attempts_details]
+ * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details] - List
+ *   of details for paid invoices.
+ * @property {Object[]} [failed_attempts_details] - Details of any failed
+ *   payment attempts for the invoices.
  */
 
 /**
  * @typedef InvoicePaymentDetailsResponse
- * @property {string} [reason]
+ * @property {string} [reason] - Reason for the response or any errors encountered.
  * @property {InvoicePaymentDetailsResponseData} [data]
- * @property {boolean} [success]
- * @property {boolean} [payment_details_visible]
+ * @property {boolean} [success] - Indicates whether the request to retrieve
+ *   invoice payment details was successful.
+ * @property {boolean} [payment_details_visible] - Indicates whether payment
+ *   details are visible or hidden in the response.
  */
 
 /**
  * @typedef InvoiceActivityLogsResponseData
- * @property {string} [performed_by]
- * @property {string} [status]
- * @property {string} [reason]
- * @property {boolean} [is_resolved]
- * @property {number} [retry_attempts]
- * @property {number} [max_retry_attempts]
+ * @property {string} [performed_by] - Identifier of the user or system that
+ *   performed the activity.
+ * @property {string} [status] - Status of the activity (e.g., 'Completed', 'Pending').
+ * @property {string} [reason] - Reason for the activity status or any related notes.
+ * @property {boolean} [is_resolved] - Indicates whether the activity issue is resolved.
+ * @property {number} [retry_attempts] - Number of retry attempts made for the activity.
+ * @property {number} [max_retry_attempts] - Maximum number of retry attempts
+ *   allowed for the activity.
  */
 
 /**
  * @typedef InvoiceActivityLogsResponse
- * @property {InvoiceActivityLogsResponseData[]} [data]
+ * @property {InvoiceActivityLogsResponseData[]} [data] - List of activity logs
+ *   related to invoices.
  */
 
 /**
  * @typedef InvoiceActivityLogError
- * @property {string} [reason]
+ * @property {string} [reason] - Reason for the error or issue encountered with
+ *   the invoice activity logs.
  */
 
 /**
  * @typedef UnlockCreditNoteRequestData
- * @property {string} [seller_id]
- * @property {string[]} [locked_credit_notes]
- * @property {string} [unlock_reason]
- * @property {string} [description]
+ * @property {string} [seller_id] - The unique identifier for the seller.
+ * @property {string[]} [locked_credit_notes] - A list of credit notes that are locked.
+ * @property {string} [unlock_reason] - The reason for unlocking the credit notes.
+ * @property {string} [description] - Additional details or comments about the
+ *   unlock request.
  */
 
 /**
@@ -873,13 +988,14 @@ const Joi = require("joi");
 
 /**
  * @typedef UnlockCreditNoteResponseData
- * @property {boolean} [is_cn_unlocked]
- * @property {string} [status]
+ * @property {boolean} [is_cn_unlocked] - Indicates whether the credit note is unlocked.
+ * @property {string} [status] - The current status of the each credit notes.
  */
 
 /**
  * @typedef UnlockCreditNoteResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates whether the credit note unlock
+ *   request was successful.
  * @property {UnlockCreditNoteResponseData} [data]
  */
 
@@ -1020,7 +1136,6 @@ class FinancePlatformModel {
       meta: FinancePlatformModel.GenerateReportMeta(),
       report_id: Joi.string().allow(""),
       filters: FinancePlatformModel.GenerateReportFilters(),
-      type_of_request: Joi.string().allow(""),
     });
   }
 
@@ -1122,13 +1237,6 @@ class FinancePlatformModel {
     });
   }
 
-  /** @returns {GetAffiliate} */
-  static GetAffiliate() {
-    return Joi.object({
-      company_id: Joi.number(),
-    });
-  }
-
   /** @returns {GetReportListResponse} */
   static GetReportListResponse() {
     return Joi.object({
@@ -1152,6 +1260,13 @@ class FinancePlatformModel {
     });
   }
 
+  /** @returns {GetAffiliate} */
+  static GetAffiliate() {
+    return Joi.object({
+      company_id: Joi.number(),
+    });
+  }
+
   /** @returns {GetAffiliateResponse} */
   static GetAffiliateResponse() {
     return Joi.object({
@@ -1808,9 +1923,6 @@ class FinancePlatformModel {
       items: Joi.array().items(
         FinancePlatformModel.DownloadReportResponseData()
       ),
-      data: Joi.array().items(
-        FinancePlatformModel.DownloadReportResponseData()
-      ),
       item_count: Joi.number(),
       page: FinancePlatformModel.Page(),
     });