@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -9,7 +9,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
-const axios = require("axios");
+const { fdkAxios } = require("../../common/AxiosHelper.js");
 
 class FileStorage {
   constructor(config) {
@@ -22,7 +22,7 @@ class FileStorage {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<Object>} - Success response
    * @name browse
-   * @summary: Browse files.
+   * @summary: Browse files
    * @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browse/).
    */
   async browse(
@@ -105,7 +105,7 @@ class FileStorage {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
    * @name completeUpload
-   * @summary: Complete file upload.
+   * @summary: Complete file upload
    * @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
    */
   async completeUpload(
@@ -188,7 +188,7 @@ class FileStorage {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<Object>} - Success response
    * @name copyFiles
-   * @summary: Copy files.
+   * @summary: Copy files
    * @description: Duplicate files to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
    */
   async copyFiles(
@@ -268,7 +268,7 @@ class FileStorage {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
    * @name getSignUrls
-   * @summary: Get signed URLs.
+   * @summary: Get signed URLs
    * @description: Retrieve signed URLs for file access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
    */
   async getSignUrls(
@@ -345,9 +345,9 @@ class FileStorage {
    * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<string>} - Success response
+   * @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
    * @name proxy
-   * @summary: Proxy file access.
+   * @summary: Proxy file access
    * @description: Access files through a proxy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
    */
   async proxy(
@@ -398,9 +398,12 @@ class FileStorage {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.string()
-      .allow("")
-      .validate(responseData, { abortEarly: false, allowUnknown: true });
+    const {
+      error: res_error,
+    } = FileStoragePlatformModel.ProxyResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -422,7 +425,7 @@ class FileStorage {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
    * @name startUpload
-   * @summary: Start file upload.
+   * @summary: Start file upload
    * @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
    */
   async startUpload(
@@ -528,10 +531,16 @@ FileStorage.prototype.upload = function ({
         },
       });
       if (dataObj.upload && dataObj.upload.url) {
-        await axios.put(dataObj.upload.url, data, {
+        let rawRequest = {
+          method: "PUT",
+          url: dataObj.upload.url,
+          data: data,
+          headers: {
+            "Content-Type": content_type,
+          },
           withCredentials: false,
-          headers: { "Content-Type": content_type },
-        });
+        };
+        await fdkAxios.request(rawRequest);
       } else {
         reject({ message: "Failed to upload file" });
       }

package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts

@@ -1,4 +1,9 @@
 export = FileStoragePlatformModel;
+/**
+ * @typedef ProxyResponse
+ * @property {Object} [data]
+ * @property {Object} [support]
+ */
 /**
  * @typedef FailedResponse
  * @property {string} message
@@ -556,8 +561,14 @@ export = FileStoragePlatformModel;
 declare class FileStoragePlatformModel {
 }
 declare namespace FileStoragePlatformModel {
-    export { FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
+    export { ProxyResponse, FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
 }
+/** @returns {ProxyResponse} */
+declare function ProxyResponse(): ProxyResponse;
+type ProxyResponse = {
+    data?: any;
+    support?: any;
+};
 /** @returns {FailedResponse} */
 declare function FailedResponse(): FailedResponse;
 type FailedResponse = {

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -1,5 +1,11 @@
 const Joi = require("joi");
 
+/**
+ * @typedef ProxyResponse
+ * @property {Object} [data]
+ * @property {Object} [support]
+ */
+
 /**
  * @typedef FailedResponse
  * @property {string} message
@@ -621,6 +627,14 @@ const Joi = require("joi");
  */
 
 class FileStoragePlatformModel {
+  /** @returns {ProxyResponse} */
+  static ProxyResponse() {
+    return Joi.object({
+      data: Joi.object().pattern(/\S/, Joi.any()),
+      support: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
   /** @returns {FailedResponse} */
   static FailedResponse() {
     return Joi.object({

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,7 +216,7 @@ declare class Finance {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
      * @name invoiceListing
-     * @summary: Gives list of invoices.
+     * @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,7 +237,7 @@ 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>;
@@ -247,7 +247,7 @@ declare 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/).
      */
     invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
@@ -258,7 +258,7 @@ declare class Finance {
      * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
      *   Success response
      * @name isCnRefundMethod
-     * @summary: Check CN 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,7 +269,7 @@ 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>;
@@ -279,7 +279,7 @@ declare 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/).
      */
     paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
@@ -290,7 +290,7 @@ declare class Finance {
      * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
      *   Success response
      * @name unlockCreditNote
-     * @summary: Unlocks 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>;

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,7 +1550,7 @@ class Finance {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
    * @name invoiceListing
-   * @summary: Gives list of invoices.
+   * @summary: Gives list of invoices
    * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
    */
   async invoiceListing(
@@ -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(
@@ -1786,7 +1786,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(
@@ -1864,7 +1864,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
    *   Success response
    * @name isCnRefundMethod
-   * @summary: Check CN 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/).
    */
   async isCnRefundMethod(
@@ -1944,7 +1944,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(
@@ -2023,7 +2023,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(
@@ -2103,7 +2103,7 @@ class Finance {
    * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
    *   Success response
    * @name unlockCreditNote
-   * @summary: Unlocks 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/).
    */
   async unlockCreditNote(