@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,16 +1,234 @@
-export = FinanceValidator;
-declare class FinanceValidator {
-    static creditlineDataplatform(): any;
-    static downloadCreditDebitNote(): any;
-    static downloadReport(): any;
-    static generateReport(): any;
-    static getAffiliate(): any;
-    static getData(): any;
-    static getReason(): any;
-    static getReportList(): any;
-    static invoiceListing(): any;
-    static invoicePDF(): any;
-    static invoiceType(): any;
-    static isCreditlinePlatform(): any;
-    static paymentProcess(): any;
+export = FinancePlatformValidator;
+/**
+ * @typedef ChannelDisplayNameParam
+ * @property {string} filterKey - Gives display name for channel.
+ */
+/**
+ * @typedef CreateSellerCreditNoteConfigParam
+ * @property {FinancePlatformModel.CreateSellerCreditNoteConfigRequest} body
+ */
+/**
+ * @typedef CreditNoteDetailsParam
+ * @property {FinancePlatformModel.CreditNoteDetailsRequest} body
+ */
+/**
+ * @typedef CreditlineDataplatformParam
+ * @property {FinancePlatformModel.CreditlineDataPlatformRequest} body
+ */
+/**
+ * @typedef DeleteConfigParam
+ * @property {FinancePlatformModel.DeleteConfigRequest} body
+ */
+/**
+ * @typedef DownloadCreditDebitNoteParam
+ * @property {FinancePlatformModel.DownloadCreditDebitNoteRequest} body
+ */
+/**
+ * @typedef DownloadReportParam
+ * @property {FinancePlatformModel.DownloadReport} body
+ */
+/**
+ * @typedef DownloadReportCustomerCnParam
+ * @property {FinancePlatformModel.DownloadReportCustomerCnRequest} body
+ */
+/**
+ * @typedef GenerateReportParam
+ * @property {FinancePlatformModel.GenerateReportRequest} body
+ */
+/**
+ * @typedef GenerateReportCustomerCnParam
+ * @property {FinancePlatformModel.GenerateReportCustomerCnRequest} body
+ */
+/**
+ * @typedef GetAffiliateParam
+ * @property {FinancePlatformModel.GetAffiliate} body
+ */
+/**
+ * @typedef GetCnConfigParam
+ * @property {FinancePlatformModel.GetCnConfigRequest} body
+ */
+/**
+ * @typedef GetCustomerCreditBalanceParam
+ * @property {FinancePlatformModel.GetCustomerCreditBalanceRequest} body
+ */
+/**
+ * @typedef GetDataParam
+ * @property {FinancePlatformModel.GetEngineRequest} body
+ */
+/**
+ * @typedef GetPdfUrlViewParam
+ * @property {FinancePlatformModel.GetPdfUrlViewRequest} body
+ */
+/**
+ * @typedef GetReasonParam
+ * @property {FinancePlatformModel.GetReasonRequest} body
+ */
+/**
+ * @typedef GetReportListParam
+ * @property {FinancePlatformModel.GetReportListRequest} body
+ */
+/**
+ * @typedef GetReportingFiltersParam
+ * @property {string} filterKey - Filter type.
+ * @property {string} [affiliateId] - Affiliate id.
+ */
+/**
+ * @typedef InvoiceListingParam
+ * @property {FinancePlatformModel.InvoiceListingRequest} body
+ */
+/**
+ * @typedef InvoicePDFParam
+ * @property {FinancePlatformModel.InvoicePdfRequest} body
+ */
+/**
+ * @typedef InvoiceTypeParam
+ * @property {FinancePlatformModel.InvoiceTypeRequest} body
+ */
+/**
+ * @typedef IsCnRefundMethodParam
+ * @property {FinancePlatformModel.IsCnRefundMethodRequest} body
+ */
+/**
+ * @typedef IsCreditlinePlatformParam
+ * @property {FinancePlatformModel.IsCreditlinePlatformRequest} body
+ */
+/**
+ * @typedef PaymentProcessParam
+ * @property {FinancePlatformModel.PaymentProcessRequest} body
+ */
+declare class FinancePlatformValidator {
+    /** @returns {ChannelDisplayNameParam} */
+    static channelDisplayName(): ChannelDisplayNameParam;
+    /** @returns {CreateSellerCreditNoteConfigParam} */
+    static createSellerCreditNoteConfig(): CreateSellerCreditNoteConfigParam;
+    /** @returns {CreditNoteDetailsParam} */
+    static creditNoteDetails(): CreditNoteDetailsParam;
+    /** @returns {CreditlineDataplatformParam} */
+    static creditlineDataplatform(): CreditlineDataplatformParam;
+    /** @returns {DeleteConfigParam} */
+    static deleteConfig(): DeleteConfigParam;
+    /** @returns {DownloadCreditDebitNoteParam} */
+    static downloadCreditDebitNote(): DownloadCreditDebitNoteParam;
+    /** @returns {DownloadReportParam} */
+    static downloadReport(): DownloadReportParam;
+    /** @returns {DownloadReportCustomerCnParam} */
+    static downloadReportCustomerCn(): DownloadReportCustomerCnParam;
+    /** @returns {GenerateReportParam} */
+    static generateReport(): GenerateReportParam;
+    /** @returns {GenerateReportCustomerCnParam} */
+    static generateReportCustomerCn(): GenerateReportCustomerCnParam;
+    /** @returns {GetAffiliateParam} */
+    static getAffiliate(): GetAffiliateParam;
+    /** @returns {GetCnConfigParam} */
+    static getCnConfig(): GetCnConfigParam;
+    /** @returns {GetCustomerCreditBalanceParam} */
+    static getCustomerCreditBalance(): GetCustomerCreditBalanceParam;
+    /** @returns {GetDataParam} */
+    static getData(): GetDataParam;
+    /** @returns {GetPdfUrlViewParam} */
+    static getPdfUrlView(): GetPdfUrlViewParam;
+    /** @returns {GetReasonParam} */
+    static getReason(): GetReasonParam;
+    /** @returns {GetReportListParam} */
+    static getReportList(): GetReportListParam;
+    /** @returns {GetReportingFiltersParam} */
+    static getReportingFilters(): GetReportingFiltersParam;
+    /** @returns {InvoiceListingParam} */
+    static invoiceListing(): InvoiceListingParam;
+    /** @returns {InvoicePDFParam} */
+    static invoicePDF(): InvoicePDFParam;
+    /** @returns {InvoiceTypeParam} */
+    static invoiceType(): InvoiceTypeParam;
+    /** @returns {IsCnRefundMethodParam} */
+    static isCnRefundMethod(): IsCnRefundMethodParam;
+    /** @returns {IsCreditlinePlatformParam} */
+    static isCreditlinePlatform(): IsCreditlinePlatformParam;
+    /** @returns {PaymentProcessParam} */
+    static paymentProcess(): PaymentProcessParam;
 }
+declare namespace FinancePlatformValidator {
+    export { ChannelDisplayNameParam, CreateSellerCreditNoteConfigParam, CreditNoteDetailsParam, CreditlineDataplatformParam, DeleteConfigParam, DownloadCreditDebitNoteParam, DownloadReportParam, DownloadReportCustomerCnParam, GenerateReportParam, GenerateReportCustomerCnParam, GetAffiliateParam, GetCnConfigParam, GetCustomerCreditBalanceParam, GetDataParam, GetPdfUrlViewParam, GetReasonParam, GetReportListParam, GetReportingFiltersParam, InvoiceListingParam, InvoicePDFParam, InvoiceTypeParam, IsCnRefundMethodParam, IsCreditlinePlatformParam, PaymentProcessParam };
+}
+type ChannelDisplayNameParam = {
+    /**
+     * - Gives display name for channel.
+     */
+    filterKey: string;
+};
+type CreateSellerCreditNoteConfigParam = {
+    body: FinancePlatformModel.CreateSellerCreditNoteConfigRequest;
+};
+type CreditNoteDetailsParam = {
+    body: FinancePlatformModel.CreditNoteDetailsRequest;
+};
+type CreditlineDataplatformParam = {
+    body: FinancePlatformModel.CreditlineDataPlatformRequest;
+};
+type DeleteConfigParam = {
+    body: FinancePlatformModel.DeleteConfigRequest;
+};
+type DownloadCreditDebitNoteParam = {
+    body: FinancePlatformModel.DownloadCreditDebitNoteRequest;
+};
+type DownloadReportParam = {
+    body: FinancePlatformModel.DownloadReport;
+};
+type DownloadReportCustomerCnParam = {
+    body: FinancePlatformModel.DownloadReportCustomerCnRequest;
+};
+type GenerateReportParam = {
+    body: FinancePlatformModel.GenerateReportRequest;
+};
+type GenerateReportCustomerCnParam = {
+    body: FinancePlatformModel.GenerateReportCustomerCnRequest;
+};
+type GetAffiliateParam = {
+    body: FinancePlatformModel.GetAffiliate;
+};
+type GetCnConfigParam = {
+    body: FinancePlatformModel.GetCnConfigRequest;
+};
+type GetCustomerCreditBalanceParam = {
+    body: FinancePlatformModel.GetCustomerCreditBalanceRequest;
+};
+type GetDataParam = {
+    body: FinancePlatformModel.GetEngineRequest;
+};
+type GetPdfUrlViewParam = {
+    body: FinancePlatformModel.GetPdfUrlViewRequest;
+};
+type GetReasonParam = {
+    body: FinancePlatformModel.GetReasonRequest;
+};
+type GetReportListParam = {
+    body: FinancePlatformModel.GetReportListRequest;
+};
+type GetReportingFiltersParam = {
+    /**
+     * - Filter type.
+     */
+    filterKey: string;
+    /**
+     * - Affiliate id.
+     */
+    affiliateId?: string;
+};
+type InvoiceListingParam = {
+    body: FinancePlatformModel.InvoiceListingRequest;
+};
+type InvoicePDFParam = {
+    body: FinancePlatformModel.InvoicePdfRequest;
+};
+type InvoiceTypeParam = {
+    body: FinancePlatformModel.InvoiceTypeRequest;
+};
+type IsCnRefundMethodParam = {
+    body: FinancePlatformModel.IsCnRefundMethodRequest;
+};
+type IsCreditlinePlatformParam = {
+    body: FinancePlatformModel.IsCreditlinePlatformRequest;
+};
+type PaymentProcessParam = {
+    body: FinancePlatformModel.PaymentProcessRequest;
+};
+import FinancePlatformModel = require("./FinancePlatformModel");

package/sdk/platform/Finance/FinancePlatformValidator.js

@@ -1,84 +1,297 @@
 const Joi = require("joi");
 
-const FinanceModel = require("./FinancePlatformModel");
-class FinanceValidator {
+const FinancePlatformModel = require("./FinancePlatformModel");
+
+/**
+ * @typedef ChannelDisplayNameParam
+ * @property {string} filterKey - Gives display name for channel.
+ */
+
+/**
+ * @typedef CreateSellerCreditNoteConfigParam
+ * @property {FinancePlatformModel.CreateSellerCreditNoteConfigRequest} body
+ */
+
+/**
+ * @typedef CreditNoteDetailsParam
+ * @property {FinancePlatformModel.CreditNoteDetailsRequest} body
+ */
+
+/**
+ * @typedef CreditlineDataplatformParam
+ * @property {FinancePlatformModel.CreditlineDataPlatformRequest} body
+ */
+
+/**
+ * @typedef DeleteConfigParam
+ * @property {FinancePlatformModel.DeleteConfigRequest} body
+ */
+
+/**
+ * @typedef DownloadCreditDebitNoteParam
+ * @property {FinancePlatformModel.DownloadCreditDebitNoteRequest} body
+ */
+
+/**
+ * @typedef DownloadReportParam
+ * @property {FinancePlatformModel.DownloadReport} body
+ */
+
+/**
+ * @typedef DownloadReportCustomerCnParam
+ * @property {FinancePlatformModel.DownloadReportCustomerCnRequest} body
+ */
+
+/**
+ * @typedef GenerateReportParam
+ * @property {FinancePlatformModel.GenerateReportRequest} body
+ */
+
+/**
+ * @typedef GenerateReportCustomerCnParam
+ * @property {FinancePlatformModel.GenerateReportCustomerCnRequest} body
+ */
+
+/**
+ * @typedef GetAffiliateParam
+ * @property {FinancePlatformModel.GetAffiliate} body
+ */
+
+/**
+ * @typedef GetCnConfigParam
+ * @property {FinancePlatformModel.GetCnConfigRequest} body
+ */
+
+/**
+ * @typedef GetCustomerCreditBalanceParam
+ * @property {FinancePlatformModel.GetCustomerCreditBalanceRequest} body
+ */
+
+/**
+ * @typedef GetDataParam
+ * @property {FinancePlatformModel.GetEngineRequest} body
+ */
+
+/**
+ * @typedef GetPdfUrlViewParam
+ * @property {FinancePlatformModel.GetPdfUrlViewRequest} body
+ */
+
+/**
+ * @typedef GetReasonParam
+ * @property {FinancePlatformModel.GetReasonRequest} body
+ */
+
+/**
+ * @typedef GetReportListParam
+ * @property {FinancePlatformModel.GetReportListRequest} body
+ */
+
+/**
+ * @typedef GetReportingFiltersParam
+ * @property {string} filterKey - Filter type.
+ * @property {string} [affiliateId] - Affiliate id.
+ */
+
+/**
+ * @typedef InvoiceListingParam
+ * @property {FinancePlatformModel.InvoiceListingRequest} body
+ */
+
+/**
+ * @typedef InvoicePDFParam
+ * @property {FinancePlatformModel.InvoicePdfRequest} body
+ */
+
+/**
+ * @typedef InvoiceTypeParam
+ * @property {FinancePlatformModel.InvoiceTypeRequest} body
+ */
+
+/**
+ * @typedef IsCnRefundMethodParam
+ * @property {FinancePlatformModel.IsCnRefundMethodRequest} body
+ */
+
+/**
+ * @typedef IsCreditlinePlatformParam
+ * @property {FinancePlatformModel.IsCreditlinePlatformRequest} body
+ */
+
+/**
+ * @typedef PaymentProcessParam
+ * @property {FinancePlatformModel.PaymentProcessRequest} body
+ */
+
+class FinancePlatformValidator {
+  /** @returns {ChannelDisplayNameParam} */
+  static channelDisplayName() {
+    return Joi.object({
+      filterKey: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {CreateSellerCreditNoteConfigParam} */
+  static createSellerCreditNoteConfig() {
+    return Joi.object({
+      body: FinancePlatformModel.CreateSellerCreditNoteConfigRequest().required(),
+    }).required();
+  }
+
+  /** @returns {CreditNoteDetailsParam} */
+  static creditNoteDetails() {
+    return Joi.object({
+      body: FinancePlatformModel.CreditNoteDetailsRequest().required(),
+    }).required();
+  }
+
+  /** @returns {CreditlineDataplatformParam} */
   static creditlineDataplatform() {
     return Joi.object({
-      body: FinanceModel.CreditlineDataPlatformRequest().required(),
+      body: FinancePlatformModel.CreditlineDataPlatformRequest().required(),
     }).required();
   }
 
+  /** @returns {DeleteConfigParam} */
+  static deleteConfig() {
+    return Joi.object({
+      body: FinancePlatformModel.DeleteConfigRequest().required(),
+    }).required();
+  }
+
+  /** @returns {DownloadCreditDebitNoteParam} */
   static downloadCreditDebitNote() {
     return Joi.object({
-      body: FinanceModel.DownloadCreditDebitNoteRequest().required(),
+      body: FinancePlatformModel.DownloadCreditDebitNoteRequest().required(),
     }).required();
   }
 
+  /** @returns {DownloadReportParam} */
   static downloadReport() {
     return Joi.object({
-      body: FinanceModel.DownloadReport().required(),
+      body: FinancePlatformModel.DownloadReport().required(),
     }).required();
   }
 
+  /** @returns {DownloadReportCustomerCnParam} */
+  static downloadReportCustomerCn() {
+    return Joi.object({
+      body: FinancePlatformModel.DownloadReportCustomerCnRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GenerateReportParam} */
   static generateReport() {
     return Joi.object({
-      body: FinanceModel.GenerateReportRequest().required(),
+      body: FinancePlatformModel.GenerateReportRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GenerateReportCustomerCnParam} */
+  static generateReportCustomerCn() {
+    return Joi.object({
+      body: FinancePlatformModel.GenerateReportCustomerCnRequest().required(),
     }).required();
   }
 
+  /** @returns {GetAffiliateParam} */
   static getAffiliate() {
     return Joi.object({
-      body: FinanceModel.GetAffiliate().required(),
+      body: FinancePlatformModel.GetAffiliate().required(),
+    }).required();
+  }
+
+  /** @returns {GetCnConfigParam} */
+  static getCnConfig() {
+    return Joi.object({
+      body: FinancePlatformModel.GetCnConfigRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomerCreditBalanceParam} */
+  static getCustomerCreditBalance() {
+    return Joi.object({
+      body: FinancePlatformModel.GetCustomerCreditBalanceRequest().required(),
     }).required();
   }
 
+  /** @returns {GetDataParam} */
   static getData() {
     return Joi.object({
-      body: FinanceModel.GetEngineRequest().required(),
+      body: FinancePlatformModel.GetEngineRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GetPdfUrlViewParam} */
+  static getPdfUrlView() {
+    return Joi.object({
+      body: FinancePlatformModel.GetPdfUrlViewRequest().required(),
     }).required();
   }
 
+  /** @returns {GetReasonParam} */
   static getReason() {
     return Joi.object({
-      body: FinanceModel.GetReasonRequest().required(),
+      body: FinancePlatformModel.GetReasonRequest().required(),
     }).required();
   }
 
+  /** @returns {GetReportListParam} */
   static getReportList() {
     return Joi.object({
-      body: FinanceModel.GetReportListRequest().required(),
+      body: FinancePlatformModel.GetReportListRequest().required(),
     }).required();
   }
 
+  /** @returns {GetReportingFiltersParam} */
+  static getReportingFilters() {
+    return Joi.object({
+      filterKey: Joi.string().allow("").required(),
+      affiliateId: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {InvoiceListingParam} */
   static invoiceListing() {
     return Joi.object({
-      body: FinanceModel.InvoiceListingRequest().required(),
+      body: FinancePlatformModel.InvoiceListingRequest().required(),
     }).required();
   }
 
+  /** @returns {InvoicePDFParam} */
   static invoicePDF() {
     return Joi.object({
-      body: FinanceModel.InvoicePdfRequest().required(),
+      body: FinancePlatformModel.InvoicePdfRequest().required(),
     }).required();
   }
 
+  /** @returns {InvoiceTypeParam} */
   static invoiceType() {
     return Joi.object({
-      body: FinanceModel.InvoiceTypeRequest().required(),
+      body: FinancePlatformModel.InvoiceTypeRequest().required(),
+    }).required();
+  }
+
+  /** @returns {IsCnRefundMethodParam} */
+  static isCnRefundMethod() {
+    return Joi.object({
+      body: FinancePlatformModel.IsCnRefundMethodRequest().required(),
     }).required();
   }
 
+  /** @returns {IsCreditlinePlatformParam} */
   static isCreditlinePlatform() {
     return Joi.object({
-      body: FinanceModel.IsCreditlinePlatformRequest().required(),
+      body: FinancePlatformModel.IsCreditlinePlatformRequest().required(),
     }).required();
   }
 
+  /** @returns {PaymentProcessParam} */
   static paymentProcess() {
     return Joi.object({
-      body: FinanceModel.PaymentProcessRequest().required(),
+      body: FinancePlatformModel.PaymentProcessRequest().required(),
     }).required();
   }
 }
 
-module.exports = FinanceValidator;
+module.exports = FinancePlatformValidator;