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

package/sdk/platform/Finance/FinancePlatformClient.d.ts

@@ -9,7 +9,7 @@ declare 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/).
      */
     channelDisplayName({ filterKey, requestHeaders }?: FinancePlatformValidator.ChannelDisplayNameParam, { responseHeaders }?: object): Promise<FinancePlatformModel.ChannelDisplayNameResponse>;
@@ -23,7 +23,7 @@ declare 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/).
      */
     createSellerCreditNoteConfig({ body, requestHeaders }?: FinancePlatformValidator.CreateSellerCreditNoteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreateSellerCreditNoteConfigResponse>;
@@ -34,7 +34,7 @@ declare 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/).
      */
     creditNoteDetails({ body, requestHeaders }?: FinancePlatformValidator.CreditNoteDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditNoteDetailsResponse>;
@@ -46,7 +46,7 @@ declare 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/).
      */
     creditlineDataplatform({ body, requestHeaders }?: FinancePlatformValidator.CreditlineDataplatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditlineDataPlatformResponse>;
@@ -56,7 +56,7 @@ declare 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/).
      */
     deleteConfig({ body, requestHeaders }?: FinancePlatformValidator.DeleteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DeleteConfigResponse>;
@@ -68,7 +68,7 @@ declare 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/).
      */
     downloadCreditDebitNote({ body, requestHeaders }?: FinancePlatformValidator.DownloadCreditDebitNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadCreditDebitNoteResponse>;
@@ -78,7 +78,7 @@ declare 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/).
      */
     downloadReport({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportList>;
@@ -90,7 +90,7 @@ declare 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/).
      */
     downloadReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportCustomerCnResponse>;
@@ -100,7 +100,7 @@ declare 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/).
      */
     generateReport({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportJson>;
@@ -112,7 +112,7 @@ declare 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/).
      */
     generateReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportCustomerCnResponse>;
@@ -122,7 +122,7 @@ declare 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/).
      */
     getAffiliate({ body, requestHeaders }?: FinancePlatformValidator.GetAffiliateParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetAffiliateResponse>;
@@ -132,7 +132,7 @@ declare 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/).
      */
     getCnConfig({ body, requestHeaders }?: FinancePlatformValidator.GetCnConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCnConfigResponse>;
@@ -144,7 +144,7 @@ declare 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/).
      */
     getCustomerCreditBalance({ body, requestHeaders }?: FinancePlatformValidator.GetCustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCustomerCreditBalanceResponse>;
@@ -154,7 +154,7 @@ declare 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/).
      */
     getData({ body, requestHeaders }?: FinancePlatformValidator.GetDataParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetEngineResponse>;
@@ -164,7 +164,7 @@ declare 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/).
      */
     getPdfUrlView({ body, requestHeaders }?: FinancePlatformValidator.GetPdfUrlViewParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetPdfUrlViewResponse>;
@@ -174,7 +174,7 @@ declare 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/).
      */
     getReason({ body, requestHeaders }?: FinancePlatformValidator.GetReasonParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReasonResponse>;
@@ -184,7 +184,7 @@ declare 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/).
      */
     getReportList({ body, requestHeaders }?: FinancePlatformValidator.GetReportListParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportListResponse>;
@@ -195,7 +195,7 @@ declare 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/).
      */
     getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
@@ -206,7 +206,7 @@ declare 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/).
      */
     invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
@@ -216,8 +216,8 @@ declare class Finance {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
      * @name 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/).
+     * @summary: Gives list of invoices.
+     * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
      */
     invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
     /**
@@ -226,7 +226,7 @@ declare 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/).
      */
     invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
@@ -237,17 +237,28 @@ declare 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/).
      */
     invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
+    /**
+     * @param {FinancePlatformValidator.InvoicePaymentOptionsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
+     *   Success response
+     * @name invoicePaymentOptions
+     * @summary: Display all payment options for invoice.
+     * @description: Display all payment options for invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
+     */
+    invoicePaymentOptions({ body, requestHeaders }?: FinancePlatformValidator.InvoicePaymentOptionsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>;
     /**
      * @param {FinancePlatformValidator.InvoiceTypeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @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/).
      */
     invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
@@ -258,7 +269,7 @@ declare class Finance {
      * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
      *   Success response
      * @name isCnRefundMethod
-     * @summary: Check refund method
+     * @summary: Check CN refund method.
      * @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
      */
     isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
@@ -269,17 +280,27 @@ declare 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/).
      */
     isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
+    /**
+     * @param {FinancePlatformValidator.OrderFreezeParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FinancePlatformModel.OrederFreezeResponse>} - Success response
+     * @name orderFreeze
+     * @summary: Get status of oms freeze.
+     * @description: Used to get status of oms freeze. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/orderFreeze/).
+     */
+    orderFreeze({ requestHeaders }?: any, { responseHeaders }?: object): Promise<FinancePlatformModel.OrederFreezeResponse>;
     /**
      * @param {FinancePlatformValidator.PaymentProcessParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @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/).
      */
     paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
@@ -290,7 +311,7 @@ declare class Finance {
      * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
      *   Success response
      * @name unlockCreditNote
-     * @summary: Unlock credit notes
+     * @summary: Unlocks credit notes.
      * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
      */
     unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;