@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Billing/BillingPlatformValidator.d.ts

@@ -1,17 +1,158 @@
-export = BillingValidator;
-declare class BillingValidator {
-    static activateSubscriptionPlan(): any;
-    static cancelSubscriptionCharge(): any;
-    static cancelSubscriptionPlan(): any;
-    static checkCouponValidity(): any;
-    static createOneTimeCharge(): any;
-    static createSubscriptionCharge(): any;
-    static getChargeDetails(): any;
+export = BillingPlatformValidator;
+/**
+ * @typedef ActivateSubscriptionPlanParam
+ * @property {BillingPlatformModel.SubscriptionActivateReq} body
+ */
+/**
+ * @typedef CancelSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} subscriptionId - Subscription charge _id
+ */
+/**
+ * @typedef CancelSubscriptionPlanParam
+ * @property {BillingPlatformModel.CancelSubscriptionReq} body
+ */
+/**
+ * @typedef CheckCouponValidityParam
+ * @property {string} plan - ID of the plan.
+ * @property {string} couponCode - Coupon code.
+ */
+/**
+ * @typedef CreateOneTimeChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {BillingPlatformModel.CreateOneTimeCharge} body
+ */
+/**
+ * @typedef CreateSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {BillingPlatformModel.CreateSubscriptionCharge} body
+ */
+/**
+ * @typedef GetChargeDetailsParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} chargeId - Standalone charge _id
+ */
+/** @typedef GetCustomerDetailParam */
+/** @typedef GetFeatureLimitConfigParam */
+/**
+ * @typedef GetInvoiceByIdParam
+ * @property {string} invoiceId - Invoice id
+ */
+/** @typedef GetInvoicesParam */
+/** @typedef GetSubscriptionParam */
+/**
+ * @typedef GetSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} subscriptionId - Subscription charge _id
+ */
+/**
+ * @typedef UpsertCustomerDetailParam
+ * @property {BillingPlatformModel.SubscriptionCustomerCreate} body
+ */
+declare class BillingPlatformValidator {
+    /** @returns {ActivateSubscriptionPlanParam} */
+    static activateSubscriptionPlan(): ActivateSubscriptionPlanParam;
+    /** @returns {CancelSubscriptionChargeParam} */
+    static cancelSubscriptionCharge(): CancelSubscriptionChargeParam;
+    /** @returns {CancelSubscriptionPlanParam} */
+    static cancelSubscriptionPlan(): CancelSubscriptionPlanParam;
+    /** @returns {CheckCouponValidityParam} */
+    static checkCouponValidity(): CheckCouponValidityParam;
+    /** @returns {CreateOneTimeChargeParam} */
+    static createOneTimeCharge(): CreateOneTimeChargeParam;
+    /** @returns {CreateSubscriptionChargeParam} */
+    static createSubscriptionCharge(): CreateSubscriptionChargeParam;
+    /** @returns {GetChargeDetailsParam} */
+    static getChargeDetails(): GetChargeDetailsParam;
+    /** @returns {GetCustomerDetailParam} */
     static getCustomerDetail(): any;
+    /** @returns {GetFeatureLimitConfigParam} */
     static getFeatureLimitConfig(): any;
-    static getInvoiceById(): any;
+    /** @returns {GetInvoiceByIdParam} */
+    static getInvoiceById(): GetInvoiceByIdParam;
+    /** @returns {GetInvoicesParam} */
     static getInvoices(): any;
+    /** @returns {GetSubscriptionParam} */
     static getSubscription(): any;
-    static getSubscriptionCharge(): any;
-    static upsertCustomerDetail(): any;
+    /** @returns {GetSubscriptionChargeParam} */
+    static getSubscriptionCharge(): GetSubscriptionChargeParam;
+    /** @returns {UpsertCustomerDetailParam} */
+    static upsertCustomerDetail(): UpsertCustomerDetailParam;
 }
+declare namespace BillingPlatformValidator {
+    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, GetChargeDetailsParam, GetCustomerDetailParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetSubscriptionParam, GetSubscriptionChargeParam, UpsertCustomerDetailParam };
+}
+type ActivateSubscriptionPlanParam = {
+    body: BillingPlatformModel.SubscriptionActivateReq;
+};
+type CancelSubscriptionChargeParam = {
+    /**
+     * - Extension _id
+     */
+    extensionId: string;
+    /**
+     * - Subscription charge _id
+     */
+    subscriptionId: string;
+};
+type CancelSubscriptionPlanParam = {
+    body: BillingPlatformModel.CancelSubscriptionReq;
+};
+type CheckCouponValidityParam = {
+    /**
+     * - ID of the plan.
+     */
+    plan: string;
+    /**
+     * - Coupon code.
+     */
+    couponCode: string;
+};
+type CreateOneTimeChargeParam = {
+    /**
+     * - Extension _id
+     */
+    extensionId: string;
+    body: BillingPlatformModel.CreateOneTimeCharge;
+};
+type CreateSubscriptionChargeParam = {
+    /**
+     * - Extension _id
+     */
+    extensionId: string;
+    body: BillingPlatformModel.CreateSubscriptionCharge;
+};
+type GetChargeDetailsParam = {
+    /**
+     * - Extension _id
+     */
+    extensionId: string;
+    /**
+     * - Standalone charge _id
+     */
+    chargeId: string;
+};
+type GetInvoiceByIdParam = {
+    /**
+     * - Invoice id
+     */
+    invoiceId: string;
+};
+type GetSubscriptionChargeParam = {
+    /**
+     * - Extension _id
+     */
+    extensionId: string;
+    /**
+     * - Subscription charge _id
+     */
+    subscriptionId: string;
+};
+type UpsertCustomerDetailParam = {
+    body: BillingPlatformModel.SubscriptionCustomerCreate;
+};
+type GetCustomerDetailParam = any;
+type GetFeatureLimitConfigParam = any;
+type GetInvoicesParam = any;
+type GetSubscriptionParam = any;
+import BillingPlatformModel = require("./BillingPlatformModel");

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -1,13 +1,80 @@
 const Joi = require("joi");
 
-const BillingModel = require("./BillingPlatformModel");
-class BillingValidator {
+const BillingPlatformModel = require("./BillingPlatformModel");
+
+/**
+ * @typedef ActivateSubscriptionPlanParam
+ * @property {BillingPlatformModel.SubscriptionActivateReq} body
+ */
+
+/**
+ * @typedef CancelSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} subscriptionId - Subscription charge _id
+ */
+
+/**
+ * @typedef CancelSubscriptionPlanParam
+ * @property {BillingPlatformModel.CancelSubscriptionReq} body
+ */
+
+/**
+ * @typedef CheckCouponValidityParam
+ * @property {string} plan - ID of the plan.
+ * @property {string} couponCode - Coupon code.
+ */
+
+/**
+ * @typedef CreateOneTimeChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {BillingPlatformModel.CreateOneTimeCharge} body
+ */
+
+/**
+ * @typedef CreateSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {BillingPlatformModel.CreateSubscriptionCharge} body
+ */
+
+/**
+ * @typedef GetChargeDetailsParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} chargeId - Standalone charge _id
+ */
+
+/** @typedef GetCustomerDetailParam */
+
+/** @typedef GetFeatureLimitConfigParam */
+
+/**
+ * @typedef GetInvoiceByIdParam
+ * @property {string} invoiceId - Invoice id
+ */
+
+/** @typedef GetInvoicesParam */
+
+/** @typedef GetSubscriptionParam */
+
+/**
+ * @typedef GetSubscriptionChargeParam
+ * @property {string} extensionId - Extension _id
+ * @property {string} subscriptionId - Subscription charge _id
+ */
+
+/**
+ * @typedef UpsertCustomerDetailParam
+ * @property {BillingPlatformModel.SubscriptionCustomerCreate} body
+ */
+
+class BillingPlatformValidator {
+  /** @returns {ActivateSubscriptionPlanParam} */
   static activateSubscriptionPlan() {
     return Joi.object({
-      body: BillingModel.SubscriptionActivateReq().required(),
+      body: BillingPlatformModel.SubscriptionActivateReq().required(),
     }).required();
   }
 
+  /** @returns {CancelSubscriptionChargeParam} */
   static cancelSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -15,12 +82,14 @@ class BillingValidator {
     }).required();
   }
 
+  /** @returns {CancelSubscriptionPlanParam} */
   static cancelSubscriptionPlan() {
     return Joi.object({
-      body: BillingModel.CancelSubscriptionReq().required(),
+      body: BillingPlatformModel.CancelSubscriptionReq().required(),
     }).required();
   }
 
+  /** @returns {CheckCouponValidityParam} */
   static checkCouponValidity() {
     return Joi.object({
       plan: Joi.string().allow("").required(),
@@ -28,20 +97,23 @@ class BillingValidator {
     }).required();
   }
 
+  /** @returns {CreateOneTimeChargeParam} */
   static createOneTimeCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: BillingModel.CreateOneTimeCharge().required(),
+      body: BillingPlatformModel.CreateOneTimeCharge().required(),
     }).required();
   }
 
+  /** @returns {CreateSubscriptionChargeParam} */
   static createSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: BillingModel.CreateSubscriptionCharge().required(),
+      body: BillingPlatformModel.CreateSubscriptionCharge().required(),
     }).required();
   }
 
+  /** @returns {GetChargeDetailsParam} */
   static getChargeDetails() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -49,28 +121,34 @@ class BillingValidator {
     }).required();
   }
 
+  /** @returns {GetCustomerDetailParam} */
   static getCustomerDetail() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetFeatureLimitConfigParam} */
   static getFeatureLimitConfig() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetInvoiceByIdParam} */
   static getInvoiceById() {
     return Joi.object({
       invoiceId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetInvoicesParam} */
   static getInvoices() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSubscriptionParam} */
   static getSubscription() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSubscriptionChargeParam} */
   static getSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -78,11 +156,12 @@ class BillingValidator {
     }).required();
   }
 
+  /** @returns {UpsertCustomerDetailParam} */
   static upsertCustomerDetail() {
     return Joi.object({
-      body: BillingModel.SubscriptionCustomerCreate().required(),
+      body: BillingPlatformModel.SubscriptionCustomerCreate().required(),
     }).required();
   }
 }
 
-module.exports = BillingValidator;
+module.exports = BillingPlatformValidator;