@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -73,43 +73,6 @@ const Joi = require("joi");
  * @property {string} [start_date]
  */
 
-/**
- * @typedef DetailedPlan
- * @property {string} [_id]
- * @property {string[]} [addons]
- * @property {number} [amount]
- * @property {DetailedPlanComponents[]} [components]
- * @property {string} [country]
- * @property {string} [created_at]
- * @property {string} [currency]
- * @property {string} [description]
- * @property {boolean} [is_active]
- * @property {boolean} [is_trial_plan]
- * @property {boolean} [is_visible]
- * @property {string} [modified_at]
- * @property {string} [name]
- * @property {string} [plan_group]
- * @property {string} [product_suite_id]
- * @property {PlanRecurring} [recurring]
- * @property {string[]} [tag_lines]
- * @property {string[]} [tags]
- * @property {number} [trial_period]
- * @property {string} [type]
- */
-
-/**
- * @typedef DetailedPlanComponents
- * @property {Object} [config]
- * @property {string} [description]
- * @property {string} [display_text]
- * @property {boolean} [enabled]
- * @property {string} [group]
- * @property {string} [icon]
- * @property {Object} [links]
- * @property {string} [name]
- * @property {string} [slug]
- */
-
 /**
  * @typedef EntityChargePrice
  * @property {number} amount - Amount for price. Minimum value 1
@@ -183,49 +146,6 @@ const Joi = require("joi");
  * @property {string} [phone]
  */
 
-/**
- * @typedef InvoiceDetailsPaymentMethods
- * @property {InvoiceDetailsPaymentMethodsData} [data]
- * @property {number} [id]
- * @property {boolean} [is_default]
- * @property {string} [pg_payment_method_id]
- * @property {string} [type]
- */
-
-/**
- * @typedef InvoiceDetailsPaymentMethodsData
- * @property {string} [brand]
- * @property {InvoiceDetailsPaymentMethodsDataChecks} [checks]
- * @property {string} [country]
- * @property {number} [exp_month]
- * @property {number} [exp_year]
- * @property {string} [fingerprint]
- * @property {string} [funding]
- * @property {string} [generated_from]
- * @property {string} [last4]
- * @property {InvoiceDetailsPaymentMethodsDataNetworks} [networks]
- * @property {InvoiceDetailsPaymentMethodsDataThreeDSecureUsage} [three_d_secure_usage]
- * @property {string} [wallet]
- */
-
-/**
- * @typedef InvoiceDetailsPaymentMethodsDataChecks
- * @property {string} [address_line1_check]
- * @property {string} [address_postal_code_check]
- * @property {string} [cvc_check]
- */
-
-/**
- * @typedef InvoiceDetailsPaymentMethodsDataNetworks
- * @property {string[]} [available]
- * @property {string} [preferred]
- */
-
-/**
- * @typedef InvoiceDetailsPaymentMethodsDataThreeDSecureUsage
- * @property {boolean} [supported]
- */
-
 /**
  * @typedef InvoiceDetailsPeriod
  * @property {string} [end]
@@ -354,6 +274,13 @@ const Joi = require("joi");
  * @property {string} [start]
  */
 
+/**
+ * @typedef Meta
+ * @property {boolean} [is_custom_plan]
+ * @property {boolean} [is_plan_upgrade]
+ * @property {boolean} [subscribe]
+ */
+
 /**
  * @typedef OneTimeChargeEntity
  * @property {string} [_id]
@@ -383,17 +310,6 @@ const Joi = require("joi");
  * @property {string} [term]
  */
 
-/**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
- */
-
 /**
  * @typedef Phone
  * @property {string} [phone_country_code]
@@ -429,11 +345,26 @@ const Joi = require("joi");
  * @property {number} [interval_count]
  */
 
+/**
+ * @typedef PlanStatusUpdateReq
+ * @property {string} [plan_id]
+ * @property {string} [reason]
+ * @property {string} [seller_status]
+ */
+
 /**
  * @typedef ResourceNotFound
  * @property {string} [message] - Resource not found with {id}
  */
 
+/**
+ * @typedef SubscribePlanRes
+ * @property {string} [current_status]
+ * @property {Meta} [meta]
+ * @property {string} [redirect_url]
+ * @property {string} [transaction_id]
+ */
+
 /**
  * @typedef Subscription
  * @property {string} [_id]
@@ -615,13 +546,12 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef UnauthenticatedApplication
- * @property {string} [message] - Failure message.
- */
-
-/**
- * @typedef UnauthenticatedUser
- * @property {string} [message] - Failure message.
+ * @typedef SunscribePlan
+ * @property {string} [callback_url]
+ * @property {string} [collection_type]
+ * @property {string} [entity_type]
+ * @property {Meta} [meta]
+ * @property {string} [plan_id]
  */
 
 class BillingPlatformModel {
@@ -720,49 +650,6 @@ class BillingPlatformModel {
     });
   }
 
-  /** @returns {DetailedPlan} */
-  static DetailedPlan() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      addons: Joi.array().items(Joi.string().allow("")),
-      amount: Joi.number(),
-      components: Joi.array().items(
-        BillingPlatformModel.DetailedPlanComponents()
-      ),
-      country: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      currency: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      is_active: Joi.boolean(),
-      is_trial_plan: Joi.boolean(),
-      is_visible: Joi.boolean(),
-      modified_at: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      plan_group: Joi.string().allow(""),
-      product_suite_id: Joi.string().allow(""),
-      recurring: BillingPlatformModel.PlanRecurring(),
-      tag_lines: Joi.array().items(Joi.string().allow("")),
-      tags: Joi.array().items(Joi.string().allow("")),
-      trial_period: Joi.number(),
-      type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {DetailedPlanComponents} */
-  static DetailedPlanComponents() {
-    return Joi.object({
-      config: Joi.any(),
-      description: Joi.string().allow(""),
-      display_text: Joi.string().allow(""),
-      enabled: Joi.boolean(),
-      group: Joi.string().allow(""),
-      icon: Joi.string().allow(""),
-      links: Joi.any(),
-      name: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {EntityChargePrice} */
   static EntityChargePrice() {
     return Joi.object({
@@ -852,59 +739,6 @@ class BillingPlatformModel {
     });
   }
 
-  /** @returns {InvoiceDetailsPaymentMethods} */
-  static InvoiceDetailsPaymentMethods() {
-    return Joi.object({
-      data: BillingPlatformModel.InvoiceDetailsPaymentMethodsData(),
-      id: Joi.number(),
-      is_default: Joi.boolean(),
-      pg_payment_method_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceDetailsPaymentMethodsData} */
-  static InvoiceDetailsPaymentMethodsData() {
-    return Joi.object({
-      brand: Joi.string().allow(""),
-      checks: BillingPlatformModel.InvoiceDetailsPaymentMethodsDataChecks(),
-      country: Joi.string().allow(""),
-      exp_month: Joi.number(),
-      exp_year: Joi.number(),
-      fingerprint: Joi.string().allow(""),
-      funding: Joi.string().allow(""),
-      generated_from: Joi.string().allow(""),
-      last4: Joi.string().allow(""),
-      networks: BillingPlatformModel.InvoiceDetailsPaymentMethodsDataNetworks(),
-      three_d_secure_usage: BillingPlatformModel.InvoiceDetailsPaymentMethodsDataThreeDSecureUsage(),
-      wallet: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceDetailsPaymentMethodsDataChecks} */
-  static InvoiceDetailsPaymentMethodsDataChecks() {
-    return Joi.object({
-      address_line1_check: Joi.string().allow(""),
-      address_postal_code_check: Joi.string().allow(""),
-      cvc_check: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceDetailsPaymentMethodsDataNetworks} */
-  static InvoiceDetailsPaymentMethodsDataNetworks() {
-    return Joi.object({
-      available: Joi.array().items(Joi.string().allow("")),
-      preferred: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceDetailsPaymentMethodsDataThreeDSecureUsage} */
-  static InvoiceDetailsPaymentMethodsDataThreeDSecureUsage() {
-    return Joi.object({
-      supported: Joi.boolean(),
-    });
-  }
-
   /** @returns {InvoiceDetailsPeriod} */
   static InvoiceDetailsPeriod() {
     return Joi.object({
@@ -1059,6 +893,15 @@ class BillingPlatformModel {
     });
   }
 
+  /** @returns {Meta} */
+  static Meta() {
+    return Joi.object({
+      is_custom_plan: Joi.boolean(),
+      is_plan_upgrade: Joi.boolean(),
+      subscribe: Joi.boolean(),
+    });
+  }
+
   /** @returns {OneTimeChargeEntity} */
   static OneTimeChargeEntity() {
     return Joi.object({
@@ -1092,19 +935,6 @@ class BillingPlatformModel {
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
-    return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
-    });
-  }
-
   /** @returns {Phone} */
   static Phone() {
     return Joi.object({
@@ -1146,6 +976,15 @@ class BillingPlatformModel {
     });
   }
 
+  /** @returns {PlanStatusUpdateReq} */
+  static PlanStatusUpdateReq() {
+    return Joi.object({
+      plan_id: Joi.string().allow(""),
+      reason: Joi.string().allow(""),
+      seller_status: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ResourceNotFound} */
   static ResourceNotFound() {
     return Joi.object({
@@ -1153,6 +992,16 @@ class BillingPlatformModel {
     });
   }
 
+  /** @returns {SubscribePlanRes} */
+  static SubscribePlanRes() {
+    return Joi.object({
+      current_status: Joi.string().allow(""),
+      meta: BillingPlatformModel.Meta(),
+      redirect_url: Joi.string().allow(""),
+      transaction_id: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {Subscription} */
   static Subscription() {
     return Joi.object({
@@ -1377,17 +1226,14 @@ class BillingPlatformModel {
     });
   }
 
-  /** @returns {UnauthenticatedApplication} */
-  static UnauthenticatedApplication() {
+  /** @returns {SunscribePlan} */
+  static SunscribePlan() {
     return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {UnauthenticatedUser} */
-  static UnauthenticatedUser() {
-    return Joi.object({
-      message: Joi.string().allow(""),
+      callback_url: Joi.string().allow(""),
+      collection_type: Joi.string().allow(""),
+      entity_type: Joi.string().allow(""),
+      meta: BillingPlatformModel.Meta(),
+      plan_id: Joi.string().allow(""),
     });
   }
 }

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

@@ -33,6 +33,7 @@ export = BillingPlatformValidator;
  * @property {string} chargeId - Standalone charge _id
  */
 /** @typedef GetCustomerDetailParam */
+/** @typedef GetEnterprisePlansParam */
 /** @typedef GetFeatureLimitConfigParam */
 /**
  * @typedef GetInvoiceByIdParam
@@ -45,6 +46,14 @@ export = BillingPlatformValidator;
  * @property {string} extensionId - Extension _id
  * @property {string} subscriptionId - Subscription charge _id
  */
+/**
+ * @typedef PlanStatusUpdateParam
+ * @property {BillingPlatformModel.PlanStatusUpdateReq} body
+ */
+/**
+ * @typedef SubscripePlanParam
+ * @property {BillingPlatformModel.SunscribePlan} body
+ */
 /**
  * @typedef UpsertCustomerDetailParam
  * @property {BillingPlatformModel.SubscriptionCustomerCreate} body
@@ -66,6 +75,8 @@ declare class BillingPlatformValidator {
     static getChargeDetails(): GetChargeDetailsParam;
     /** @returns {GetCustomerDetailParam} */
     static getCustomerDetail(): any;
+    /** @returns {GetEnterprisePlansParam} */
+    static getEnterprisePlans(): any;
     /** @returns {GetFeatureLimitConfigParam} */
     static getFeatureLimitConfig(): any;
     /** @returns {GetInvoiceByIdParam} */
@@ -76,11 +87,15 @@ declare class BillingPlatformValidator {
     static getSubscription(): any;
     /** @returns {GetSubscriptionChargeParam} */
     static getSubscriptionCharge(): GetSubscriptionChargeParam;
+    /** @returns {PlanStatusUpdateParam} */
+    static planStatusUpdate(): PlanStatusUpdateParam;
+    /** @returns {SubscripePlanParam} */
+    static subscripePlan(): SubscripePlanParam;
     /** @returns {UpsertCustomerDetailParam} */
     static upsertCustomerDetail(): UpsertCustomerDetailParam;
 }
 declare namespace BillingPlatformValidator {
-    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, GetChargeDetailsParam, GetCustomerDetailParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetSubscriptionParam, GetSubscriptionChargeParam, UpsertCustomerDetailParam };
+    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, GetChargeDetailsParam, GetCustomerDetailParam, GetEnterprisePlansParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetSubscriptionParam, GetSubscriptionChargeParam, PlanStatusUpdateParam, SubscripePlanParam, UpsertCustomerDetailParam };
 }
 type ActivateSubscriptionPlanParam = {
     body: BillingPlatformModel.SubscriptionActivateReq;
@@ -148,10 +163,17 @@ type GetSubscriptionChargeParam = {
      */
     subscriptionId: string;
 };
+type PlanStatusUpdateParam = {
+    body: BillingPlatformModel.PlanStatusUpdateReq;
+};
+type SubscripePlanParam = {
+    body: BillingPlatformModel.SunscribePlan;
+};
 type UpsertCustomerDetailParam = {
     body: BillingPlatformModel.SubscriptionCustomerCreate;
 };
 type GetCustomerDetailParam = any;
+type GetEnterprisePlansParam = any;
 type GetFeatureLimitConfigParam = any;
 type GetInvoicesParam = any;
 type GetSubscriptionParam = any;

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -44,6 +44,8 @@ const BillingPlatformModel = require("./BillingPlatformModel");
 
 /** @typedef GetCustomerDetailParam */
 
+/** @typedef GetEnterprisePlansParam */
+
 /** @typedef GetFeatureLimitConfigParam */
 
 /**
@@ -61,6 +63,16 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {string} subscriptionId - Subscription charge _id
  */
 
+/**
+ * @typedef PlanStatusUpdateParam
+ * @property {BillingPlatformModel.PlanStatusUpdateReq} body
+ */
+
+/**
+ * @typedef SubscripePlanParam
+ * @property {BillingPlatformModel.SunscribePlan} body
+ */
+
 /**
  * @typedef UpsertCustomerDetailParam
  * @property {BillingPlatformModel.SubscriptionCustomerCreate} body
@@ -126,6 +138,11 @@ class BillingPlatformValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetEnterprisePlansParam} */
+  static getEnterprisePlans() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetFeatureLimitConfigParam} */
   static getFeatureLimitConfig() {
     return Joi.object({}).required();
@@ -156,6 +173,20 @@ class BillingPlatformValidator {
     }).required();
   }
 
+  /** @returns {PlanStatusUpdateParam} */
+  static planStatusUpdate() {
+    return Joi.object({
+      body: BillingPlatformModel.PlanStatusUpdateReq().required(),
+    }).required();
+  }
+
+  /** @returns {SubscripePlanParam} */
+  static subscripePlan() {
+    return Joi.object({
+      body: BillingPlatformModel.SunscribePlan().required(),
+    }).required();
+  }
+
   /** @returns {UpsertCustomerDetailParam} */
   static upsertCustomerDetail() {
     return Joi.object({