@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -1,11 +1,638 @@
 const Joi = require("joi");
 
-class BillingModel {
+/**
+ * @typedef BadRequest
+ * @property {string} [message] - Failure message.
+ */
+
+/**
+ * @typedef CancelSubscriptionReq
+ * @property {string} [product_suite]
+ * @property {string} [subscription_id]
+ * @property {string} [type]
+ * @property {string} [unique_id]
+ */
+
+/**
+ * @typedef CancelSubscriptionRes
+ * @property {Subscription} [data]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef ChargeLineItem
+ * @property {number} [capped_amount]
+ * @property {boolean} [is_test]
+ * @property {Object} [metadata]
+ * @property {string} name
+ * @property {EntityChargePrice} price
+ * @property {string} pricing_type
+ * @property {EntityChargeRecurring} [recurring]
+ * @property {string} term
+ * @property {number} [trial_days]
+ */
+
+/**
+ * @typedef CheckValidityResponse
+ * @property {number} [discount_amount]
+ * @property {boolean} [is_valid]
+ */
+
+/**
+ * @typedef CreateOneTimeCharge
+ * @property {OneTimeChargeItem} charge
+ * @property {boolean} [is_test]
+ * @property {string} name
+ * @property {string} return_url
+ */
+
+/**
+ * @typedef CreateOneTimeChargeResponse
+ * @property {OneTimeChargeEntity} [charge]
+ * @property {string} [confirm_url]
+ */
+
+/**
+ * @typedef CreateSubscriptionCharge
+ * @property {boolean} [is_test]
+ * @property {ChargeLineItem[]} line_items
+ * @property {string} name
+ * @property {string} return_url
+ * @property {number} [trial_days]
+ */
+
+/**
+ * @typedef CreateSubscriptionResponse
+ * @property {string} [confirm_url]
+ * @property {EntitySubscription} [subscription]
+ */
+
+/**
+ * @typedef CurrentPeriod
+ * @property {string} [end_date]
+ * @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
+ * @property {string} currency_code
+ */
+
+/**
+ * @typedef EntityChargeRecurring
+ * @property {string} interval
+ */
+
+/**
+ * @typedef EntitySubscription
+ * @property {string} [_id]
+ * @property {string} [activated_on]
+ * @property {string} [cancelled_on]
+ * @property {number} [company_id]
+ * @property {SubscriptionCharge[]} [line_items]
+ * @property {Object} [metadata]
+ * @property {string} [name]
+ * @property {string} [status]
+ * @property {number} [trial_days]
+ * @property {SubscriptionTrialPeriod} [trial_period]
+ */
+
+/**
+ * @typedef InternalServerError
+ * @property {string} [code] - Error code
+ * @property {string} [message] - Internal server Server error
+ */
+
+/**
+ * @typedef Invoice
+ * @property {InvoiceDetails} [invoice]
+ * @property {InvoiceItems[]} [invoice_items]
+ */
+
+/**
+ * @typedef InvoiceDetails
+ * @property {string} [_id]
+ * @property {number} [attemp]
+ * @property {boolean} [auto_advance]
+ * @property {InvoiceDetailsClient} [client]
+ * @property {string} [collection_method]
+ * @property {string} [created_at]
+ * @property {string} [currency]
+ * @property {string} [current_status]
+ * @property {string} [hash_identifier]
+ * @property {string} [invoice_url]
+ * @property {string} [modified_at]
+ * @property {string} [next_action_time]
+ * @property {string} [number]
+ * @property {boolean} [paid]
+ * @property {InvoicePaymentMethod} [payment_method]
+ * @property {InvoiceDetailsPeriod} [period]
+ * @property {Object} [pg_data]
+ * @property {string} [receipt_number]
+ * @property {string} [statement_descriptor]
+ * @property {InvoiceDetailsStatusTrail[]} [status_trail]
+ * @property {string} [subscriber_id]
+ * @property {string} [subscription]
+ * @property {number} [subtotal]
+ * @property {number} [total]
+ */
+
+/**
+ * @typedef InvoiceDetailsClient
+ * @property {string[]} [address_lines]
+ * @property {string} [email]
+ * @property {string} [name]
+ * @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]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef InvoiceDetailsStatusTrail
+ * @property {string} [_id]
+ * @property {string} [timestamp]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef InvoiceItems
+ * @property {string} [_id]
+ * @property {number} [amount]
+ * @property {string} [created_at]
+ * @property {string} [currency]
+ * @property {string} [description]
+ * @property {string} [invoice_id]
+ * @property {string} [modified_at]
+ * @property {string} [name]
+ * @property {InvoiceItemsPeriod} [period]
+ * @property {InvoiceItemsPlan} [plan]
+ * @property {number} [quantity]
+ * @property {string} [type]
+ * @property {number} [unit_amount]
+ */
+
+/**
+ * @typedef InvoiceItemsPeriod
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef InvoiceItemsPlan
+ * @property {string} [_id]
+ * @property {string[]} [addons]
+ * @property {number} [amount]
+ * @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 {InvoiceItemsPlanRecurring} [recurring]
+ * @property {string[]} [tag_lines]
+ * @property {string[]} [tags]
+ * @property {number} [trial_period]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef InvoiceItemsPlanRecurring
+ * @property {string} [interval]
+ * @property {number} [interval_count]
+ */
+
+/**
+ * @typedef InvoicePaymentMethod
+ * @property {string} [pg_payment_method_id]
+ */
+
+/**
+ * @typedef Invoices
+ * @property {InvoicesData[]} [data]
+ * @property {number} [end]
+ * @property {number} [limit]
+ * @property {number} [page]
+ * @property {number} [start]
+ * @property {number} [total]
+ */
+
+/**
+ * @typedef InvoicesData
+ * @property {string} [_id]
+ * @property {number} [attemp]
+ * @property {boolean} [auto_advance]
+ * @property {InvoicesDataClient} [client]
+ * @property {string} [collection_method]
+ * @property {string} [created_at]
+ * @property {string} [currency]
+ * @property {string} [current_status]
+ * @property {string} [hash_identifier]
+ * @property {InvoiceItems[]} [invoice_items]
+ * @property {string} [invoice_url]
+ * @property {string} [modified_at]
+ * @property {string} [next_action_time]
+ * @property {string} [number]
+ * @property {boolean} [paid]
+ * @property {InvoicesDataPaymentMethod} [payment_method]
+ * @property {InvoicesDataPeriod} [period]
+ * @property {Object} [pg_data]
+ * @property {string} [receipt_number]
+ * @property {string} [statement_descriptor]
+ * @property {InvoiceDetailsStatusTrail[]} [status_trail]
+ * @property {string} [subscriber_id]
+ * @property {string} [subscription]
+ * @property {number} [subtotal]
+ * @property {number} [total]
+ */
+
+/**
+ * @typedef InvoicesDataClient
+ * @property {string[]} [address_lines]
+ * @property {string} [email]
+ * @property {string} [name]
+ * @property {string} [phone]
+ */
+
+/**
+ * @typedef InvoicesDataPaymentMethod
+ * @property {string} [pg_payment_method_id]
+ */
+
+/**
+ * @typedef InvoicesDataPeriod
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef OneTimeChargeEntity
+ * @property {string} [_id]
+ * @property {string} [activated_on]
+ * @property {string} [cancelled_on]
+ * @property {string} [entity_id]
+ * @property {string} [entity_type]
+ * @property {boolean} [is_test]
+ * @property {Object} [meta]
+ * @property {Object} [metadata]
+ * @property {string} [name]
+ * @property {EntityChargePrice} [price]
+ * @property {string} [pricing_type]
+ * @property {string} [return_url]
+ * @property {string} [status]
+ * @property {string} [subscriber_id]
+ */
+
+/**
+ * @typedef OneTimeChargeItem
+ * @property {number} [capped_amount]
+ * @property {boolean} [is_test]
+ * @property {Object} [metadata]
+ * @property {string} name
+ * @property {EntityChargePrice} price
+ * @property {string} pricing_type
+ * @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]
+ * @property {string} [phone_number]
+ */
+
+/**
+ * @typedef Plan
+ * @property {string} [_id]
+ * @property {string[]} [addons]
+ * @property {number} [amount]
+ * @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 PlanRecurring
+ * @property {string} [interval]
+ * @property {number} [interval_count]
+ */
+
+/**
+ * @typedef ResourceNotFound
+ * @property {string} [message] - Resource not found with {id}
+ */
+
+/**
+ * @typedef Subscription
+ * @property {string} [_id]
+ * @property {boolean} [cancel_at_period_end]
+ * @property {string} [channel_type]
+ * @property {string} [collection_method]
+ * @property {string} [created_at]
+ * @property {SubscriptionCurrentPeriod} [current_period]
+ * @property {string} [current_status]
+ * @property {SubscriptionInvoiceSettings} [invoice_settings]
+ * @property {boolean} [is_active]
+ * @property {string} [latest_invoice]
+ * @property {string} [modified_at]
+ * @property {SubscriptionPauseCollection} [pause_collection]
+ * @property {Plan} [plan_data]
+ * @property {string} [plan_id]
+ * @property {string} [product_suite_id]
+ * @property {string} [subscriber_id]
+ * @property {SubscriptionTrial} [trial]
+ */
+
+/**
+ * @typedef SubscriptionActivateReq
+ * @property {string} [payment_method]
+ * @property {string} [plan_id]
+ * @property {string} [product_suite]
+ * @property {string} [type]
+ * @property {string} [unique_id]
+ */
+
+/**
+ * @typedef SubscriptionActivateRes
+ * @property {Subscription} [data]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef SubscriptionBillingAddress
+ * @property {string} [city]
+ * @property {string} [country]
+ * @property {string} [line1]
+ * @property {string} [line2]
+ * @property {string} [postal_code]
+ * @property {string} [state]
+ */
+
+/**
+ * @typedef SubscriptionCharge
+ * @property {string} [_id]
+ * @property {string} [activated_on]
+ * @property {string} [billing_date]
+ * @property {string} [cancelled_on]
+ * @property {number} [capped_amount]
+ * @property {CurrentPeriod} [current_period]
+ * @property {boolean} [is_test]
+ * @property {Object} [metadata]
+ * @property {string} [name]
+ * @property {EntityChargePrice} [price]
+ * @property {string} [pricing_type]
+ * @property {EntityChargeRecurring} [recurring]
+ * @property {string} [status]
+ * @property {string} [term] - Brief description for a charge
+ */
+
+/**
+ * @typedef SubscriptionCurrentPeriod
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef SubscriptionCustomer
+ * @property {string} [_id]
+ * @property {SubscriptionBillingAddress} [billing_address]
+ * @property {string} [created_at]
+ * @property {Object} [data]
+ * @property {string} [email]
+ * @property {string} [modified_at]
+ * @property {string} [name]
+ * @property {Phone} [phone]
+ * @property {string} [type]
+ * @property {string} [unique_id]
+ */
+
+/**
+ * @typedef SubscriptionCustomerCreate
+ * @property {SubscriptionBillingAddress} [billing_address]
+ * @property {string} [email]
+ * @property {string} [name]
+ * @property {Phone} [phone]
+ * @property {string} [type]
+ * @property {string} [unique_id]
+ */
+
+/**
+ * @typedef SubscriptionInvoiceSettings
+ * @property {boolean} [charging]
+ * @property {boolean} [generation]
+ */
+
+/**
+ * @typedef SubscriptionLimit
+ * @property {SubscriptionLimitApplication} [application]
+ * @property {SubscriptionLimitExtensions} [extensions]
+ * @property {SubscriptionLimitIntegrations} [integrations]
+ * @property {boolean} [is_trial_plan]
+ * @property {SubscriptionLimitMarketplace} [marketplace]
+ * @property {SubscriptionLimitOtherPlatform} [other_platform]
+ * @property {SubscriptionLimitProducts} [products]
+ * @property {SubscriptionLimitTeam} [team]
+ */
+
+/**
+ * @typedef SubscriptionLimitApplication
+ * @property {boolean} [enabled]
+ * @property {number} [hard_limit]
+ * @property {number} [soft_limit]
+ */
+
+/**
+ * @typedef SubscriptionLimitExtensions
+ * @property {boolean} [enabled]
+ * @property {number} [limit]
+ */
+
+/**
+ * @typedef SubscriptionLimitIntegrations
+ * @property {boolean} [enabled]
+ * @property {number} [limit]
+ */
+
+/**
+ * @typedef SubscriptionLimitMarketplace
+ * @property {boolean} [enabled]
+ */
+
+/**
+ * @typedef SubscriptionLimitOtherPlatform
+ * @property {boolean} [enabled]
+ */
+
+/**
+ * @typedef SubscriptionLimitProducts
+ * @property {boolean} [bulk]
+ * @property {number} [limit]
+ */
+
+/**
+ * @typedef SubscriptionLimitTeam
+ * @property {number} [limit]
+ */
+
+/**
+ * @typedef SubscriptionPauseCollection
+ * @property {string} [behavior]
+ * @property {string} [resume_at]
+ */
+
+/**
+ * @typedef SubscriptionStatus
+ * @property {Subscription[]} [current_subscriptions]
+ * @property {boolean} [is_enabled]
+ * @property {InvoicesData} [latest_invoice]
+ * @property {string} [mandate_amount]
+ * @property {Plan} [next_plan]
+ * @property {Subscription} [subscription]
+ */
+
+/**
+ * @typedef SubscriptionTrial
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef SubscriptionTrialPeriod
+ * @property {string} [end_date]
+ * @property {string} [start_date]
+ */
+
+/**
+ * @typedef UnauthenticatedApplication
+ * @property {string} [message] - Failure message.
+ */
+
+/**
+ * @typedef UnauthenticatedUser
+ * @property {string} [message] - Failure message.
+ */
+
+class BillingPlatformModel {
+  /** @returns {BadRequest} */
   static BadRequest() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CancelSubscriptionReq} */
   static CancelSubscriptionReq() {
     return Joi.object({
       product_suite: Joi.string().allow(""),
@@ -14,72 +641,94 @@ class BillingModel {
       unique_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CancelSubscriptionRes} */
   static CancelSubscriptionRes() {
     return Joi.object({
-      data: BillingModel.Subscription(),
+      data: BillingPlatformModel.Subscription(),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {ChargeLineItem} */
   static ChargeLineItem() {
     return Joi.object({
       capped_amount: Joi.number(),
       is_test: Joi.boolean(),
       metadata: Joi.any(),
       name: Joi.string().allow("").required(),
-      price: BillingModel.EntityChargePrice().required(),
+      price: BillingPlatformModel.EntityChargePrice().required(),
       pricing_type: Joi.string().allow("").required(),
-      recurring: BillingModel.EntityChargeRecurring(),
+      recurring: BillingPlatformModel.EntityChargeRecurring(),
       term: Joi.string().allow("").required(),
       trial_days: Joi.number(),
     });
   }
+
+  /** @returns {CheckValidityResponse} */
   static CheckValidityResponse() {
     return Joi.object({
       discount_amount: Joi.number(),
       is_valid: Joi.boolean(),
     });
   }
+
+  /** @returns {CreateOneTimeCharge} */
   static CreateOneTimeCharge() {
     return Joi.object({
-      charge: BillingModel.OneTimeChargeItem().required(),
+      charge: BillingPlatformModel.OneTimeChargeItem().required(),
       is_test: Joi.boolean(),
       name: Joi.string().allow("").required(),
       return_url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreateOneTimeChargeResponse} */
   static CreateOneTimeChargeResponse() {
     return Joi.object({
-      charge: BillingModel.OneTimeChargeEntity(),
+      charge: BillingPlatformModel.OneTimeChargeEntity(),
       confirm_url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CreateSubscriptionCharge} */
   static CreateSubscriptionCharge() {
     return Joi.object({
       is_test: Joi.boolean(),
-      line_items: Joi.array().items(BillingModel.ChargeLineItem()).required(),
+      line_items: Joi.array()
+        .items(BillingPlatformModel.ChargeLineItem())
+        .required(),
       name: Joi.string().allow("").required(),
       return_url: Joi.string().allow("").required(),
       trial_days: Joi.number(),
     });
   }
+
+  /** @returns {CreateSubscriptionResponse} */
   static CreateSubscriptionResponse() {
     return Joi.object({
       confirm_url: Joi.string().allow(""),
-      subscription: BillingModel.EntitySubscription(),
+      subscription: BillingPlatformModel.EntitySubscription(),
     });
   }
+
+  /** @returns {CurrentPeriod} */
   static CurrentPeriod() {
     return Joi.object({
       end_date: Joi.string().allow(""),
       start_date: Joi.string().allow(""),
     });
   }
+
+  /** @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(BillingModel.DetailedPlanComponents()),
+      components: Joi.array().items(
+        BillingPlatformModel.DetailedPlanComponents()
+      ),
       country: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       currency: Joi.string().allow(""),
@@ -91,13 +740,15 @@ class BillingModel {
       name: Joi.string().allow(""),
       plan_group: Joi.string().allow(""),
       product_suite_id: Joi.string().allow(""),
-      recurring: BillingModel.PlanRecurring(),
+      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(),
@@ -111,49 +762,61 @@ class BillingModel {
       slug: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EntityChargePrice} */
   static EntityChargePrice() {
     return Joi.object({
       amount: Joi.number().required(),
       currency_code: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {EntityChargeRecurring} */
   static EntityChargeRecurring() {
     return Joi.object({
       interval: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {EntitySubscription} */
   static EntitySubscription() {
     return Joi.object({
       _id: Joi.string().allow(""),
       activated_on: Joi.string().allow(""),
       cancelled_on: Joi.string().allow(""),
       company_id: Joi.number(),
-      line_items: Joi.array().items(BillingModel.SubscriptionCharge()),
+      line_items: Joi.array().items(BillingPlatformModel.SubscriptionCharge()),
       metadata: Joi.any(),
       name: Joi.string().allow(""),
       status: Joi.string().allow(""),
       trial_days: Joi.number(),
-      trial_period: BillingModel.SubscriptionTrialPeriod(),
+      trial_period: BillingPlatformModel.SubscriptionTrialPeriod(),
     });
   }
+
+  /** @returns {InternalServerError} */
   static InternalServerError() {
     return Joi.object({
       code: Joi.string().allow(""),
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Invoice} */
   static Invoice() {
     return Joi.object({
-      invoice: BillingModel.InvoiceDetails(),
-      invoice_items: Joi.array().items(BillingModel.InvoiceItems()),
+      invoice: BillingPlatformModel.InvoiceDetails(),
+      invoice_items: Joi.array().items(BillingPlatformModel.InvoiceItems()),
     });
   }
+
+  /** @returns {InvoiceDetails} */
   static InvoiceDetails() {
     return Joi.object({
       _id: Joi.string().allow(""),
       attemp: Joi.number(),
       auto_advance: Joi.boolean(),
-      client: BillingModel.InvoiceDetailsClient(),
+      client: BillingPlatformModel.InvoiceDetailsClient(),
       collection_method: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       currency: Joi.string().allow(""),
@@ -164,18 +827,22 @@ class BillingModel {
       next_action_time: Joi.string().allow(""),
       number: Joi.string().allow(""),
       paid: Joi.boolean(),
-      payment_method: BillingModel.InvoicePaymentMethod(),
-      period: BillingModel.InvoiceDetailsPeriod(),
+      payment_method: BillingPlatformModel.InvoicePaymentMethod(),
+      period: BillingPlatformModel.InvoiceDetailsPeriod(),
       pg_data: Joi.any(),
       receipt_number: Joi.string().allow(""),
       statement_descriptor: Joi.string().allow(""),
-      status_trail: Joi.array().items(BillingModel.InvoiceDetailsStatusTrail()),
+      status_trail: Joi.array().items(
+        BillingPlatformModel.InvoiceDetailsStatusTrail()
+      ),
       subscriber_id: Joi.string().allow(""),
       subscription: Joi.string().allow(""),
       subtotal: Joi.number(),
       total: Joi.number(),
     });
   }
+
+  /** @returns {InvoiceDetailsClient} */
   static InvoiceDetailsClient() {
     return Joi.object({
       address_lines: Joi.array().items(Joi.string().allow("")),
@@ -184,19 +851,23 @@ class BillingModel {
       phone: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoiceDetailsPaymentMethods} */
   static InvoiceDetailsPaymentMethods() {
     return Joi.object({
-      data: BillingModel.InvoiceDetailsPaymentMethodsData(),
+      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: BillingModel.InvoiceDetailsPaymentMethodsDataChecks(),
+      checks: BillingPlatformModel.InvoiceDetailsPaymentMethodsDataChecks(),
       country: Joi.string().allow(""),
       exp_month: Joi.number(),
       exp_year: Joi.number(),
@@ -204,11 +875,13 @@ class BillingModel {
       funding: Joi.string().allow(""),
       generated_from: Joi.string().allow(""),
       last4: Joi.string().allow(""),
-      networks: BillingModel.InvoiceDetailsPaymentMethodsDataNetworks(),
-      three_d_secure_usage: BillingModel.InvoiceDetailsPaymentMethodsDataThreeDSecureUsage(),
+      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(""),
@@ -216,23 +889,31 @@ class BillingModel {
       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({
       end: Joi.string().allow(""),
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoiceDetailsStatusTrail} */
   static InvoiceDetailsStatusTrail() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -240,6 +921,8 @@ class BillingModel {
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoiceItems} */
   static InvoiceItems() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -250,19 +933,23 @@ class BillingModel {
       invoice_id: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      period: BillingModel.InvoiceItemsPeriod(),
-      plan: BillingModel.InvoiceItemsPlan(),
+      period: BillingPlatformModel.InvoiceItemsPeriod(),
+      plan: BillingPlatformModel.InvoiceItemsPlan(),
       quantity: Joi.number(),
       type: Joi.string().allow(""),
       unit_amount: Joi.number(),
     });
   }
+
+  /** @returns {InvoiceItemsPeriod} */
   static InvoiceItemsPeriod() {
     return Joi.object({
       end: Joi.string().allow(""),
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoiceItemsPlan} */
   static InvoiceItemsPlan() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -279,27 +966,33 @@ class BillingModel {
       name: Joi.string().allow(""),
       plan_group: Joi.string().allow(""),
       product_suite_id: Joi.string().allow(""),
-      recurring: BillingModel.InvoiceItemsPlanRecurring(),
+      recurring: BillingPlatformModel.InvoiceItemsPlanRecurring(),
       tag_lines: Joi.array().items(Joi.string().allow("")),
       tags: Joi.array().items(Joi.string().allow("")),
       trial_period: Joi.number(),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoiceItemsPlanRecurring} */
   static InvoiceItemsPlanRecurring() {
     return Joi.object({
       interval: Joi.string().allow(""),
       interval_count: Joi.number(),
     });
   }
+
+  /** @returns {InvoicePaymentMethod} */
   static InvoicePaymentMethod() {
     return Joi.object({
       pg_payment_method_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Invoices} */
   static Invoices() {
     return Joi.object({
-      data: Joi.array().items(BillingModel.InvoicesData()),
+      data: Joi.array().items(BillingPlatformModel.InvoicesData()),
       end: Joi.number(),
       limit: Joi.number(),
       page: Joi.number(),
@@ -307,35 +1000,41 @@ class BillingModel {
       total: Joi.number(),
     });
   }
+
+  /** @returns {InvoicesData} */
   static InvoicesData() {
     return Joi.object({
       _id: Joi.string().allow(""),
       attemp: Joi.number(),
       auto_advance: Joi.boolean(),
-      client: BillingModel.InvoicesDataClient(),
+      client: BillingPlatformModel.InvoicesDataClient(),
       collection_method: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       currency: Joi.string().allow(""),
       current_status: Joi.string().allow(""),
       hash_identifier: Joi.string().allow(""),
-      invoice_items: Joi.array().items(BillingModel.InvoiceItems()),
+      invoice_items: Joi.array().items(BillingPlatformModel.InvoiceItems()),
       invoice_url: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
       next_action_time: Joi.string().allow(""),
       number: Joi.string().allow(""),
       paid: Joi.boolean(),
-      payment_method: BillingModel.InvoicesDataPaymentMethod(),
-      period: BillingModel.InvoicesDataPeriod(),
+      payment_method: BillingPlatformModel.InvoicesDataPaymentMethod(),
+      period: BillingPlatformModel.InvoicesDataPeriod(),
       pg_data: Joi.any(),
       receipt_number: Joi.string().allow(""),
       statement_descriptor: Joi.string().allow(""),
-      status_trail: Joi.array().items(BillingModel.InvoiceDetailsStatusTrail()),
+      status_trail: Joi.array().items(
+        BillingPlatformModel.InvoiceDetailsStatusTrail()
+      ),
       subscriber_id: Joi.string().allow(""),
       subscription: Joi.string().allow(""),
       subtotal: Joi.number(),
       total: Joi.number(),
     });
   }
+
+  /** @returns {InvoicesDataClient} */
   static InvoicesDataClient() {
     return Joi.object({
       address_lines: Joi.array().items(Joi.string().allow("")),
@@ -344,17 +1043,23 @@ class BillingModel {
       phone: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoicesDataPaymentMethod} */
   static InvoicesDataPaymentMethod() {
     return Joi.object({
       pg_payment_method_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {InvoicesDataPeriod} */
   static InvoicesDataPeriod() {
     return Joi.object({
       end: Joi.string().allow(""),
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OneTimeChargeEntity} */
   static OneTimeChargeEntity() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -366,24 +1071,28 @@ class BillingModel {
       meta: Joi.any(),
       metadata: Joi.any(),
       name: Joi.string().allow(""),
-      price: BillingModel.EntityChargePrice(),
+      price: BillingPlatformModel.EntityChargePrice(),
       pricing_type: Joi.string().allow(""),
       return_url: Joi.string().allow(""),
       status: Joi.string().allow(""),
       subscriber_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OneTimeChargeItem} */
   static OneTimeChargeItem() {
     return Joi.object({
       capped_amount: Joi.number(),
       is_test: Joi.boolean(),
       metadata: Joi.any(),
       name: Joi.string().allow("").required(),
-      price: BillingModel.EntityChargePrice().required(),
+      price: BillingPlatformModel.EntityChargePrice().required(),
       pricing_type: Joi.string().allow("").required(),
       term: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -395,12 +1104,16 @@ class BillingModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Phone} */
   static Phone() {
     return Joi.object({
       phone_country_code: Joi.string().allow(""),
       phone_number: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Plan} */
   static Plan() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -417,24 +1130,30 @@ class BillingModel {
       name: Joi.string().allow(""),
       plan_group: Joi.string().allow(""),
       product_suite_id: Joi.string().allow(""),
-      recurring: BillingModel.PlanRecurring(),
+      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 {PlanRecurring} */
   static PlanRecurring() {
     return Joi.object({
       interval: Joi.string().allow(""),
       interval_count: Joi.number(),
     });
   }
+
+  /** @returns {ResourceNotFound} */
   static ResourceNotFound() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Subscription} */
   static Subscription() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -442,20 +1161,22 @@ class BillingModel {
       channel_type: Joi.string().allow(""),
       collection_method: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      current_period: BillingModel.SubscriptionCurrentPeriod(),
+      current_period: BillingPlatformModel.SubscriptionCurrentPeriod(),
       current_status: Joi.string().allow(""),
-      invoice_settings: BillingModel.SubscriptionInvoiceSettings(),
+      invoice_settings: BillingPlatformModel.SubscriptionInvoiceSettings(),
       is_active: Joi.boolean(),
       latest_invoice: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
-      pause_collection: BillingModel.SubscriptionPauseCollection(),
-      plan_data: BillingModel.Plan(),
+      pause_collection: BillingPlatformModel.SubscriptionPauseCollection(),
+      plan_data: BillingPlatformModel.Plan(),
       plan_id: Joi.string().allow(""),
       product_suite_id: Joi.string().allow(""),
       subscriber_id: Joi.string().allow(""),
-      trial: BillingModel.SubscriptionTrial(),
+      trial: BillingPlatformModel.SubscriptionTrial(),
     });
   }
+
+  /** @returns {SubscriptionActivateReq} */
   static SubscriptionActivateReq() {
     return Joi.object({
       payment_method: Joi.string().allow(""),
@@ -465,12 +1186,16 @@ class BillingModel {
       unique_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionActivateRes} */
   static SubscriptionActivateRes() {
     return Joi.object({
-      data: BillingModel.Subscription(),
+      data: BillingPlatformModel.Subscription(),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {SubscriptionBillingAddress} */
   static SubscriptionBillingAddress() {
     return Joi.object({
       city: Joi.string().allow(""),
@@ -481,6 +1206,8 @@ class BillingModel {
       state: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionCharge} */
   static SubscriptionCharge() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -488,65 +1215,77 @@ class BillingModel {
       billing_date: Joi.string().allow(""),
       cancelled_on: Joi.string().allow(""),
       capped_amount: Joi.number(),
-      current_period: BillingModel.CurrentPeriod(),
+      current_period: BillingPlatformModel.CurrentPeriod(),
       is_test: Joi.boolean(),
       metadata: Joi.any(),
       name: Joi.string().allow(""),
-      price: BillingModel.EntityChargePrice(),
+      price: BillingPlatformModel.EntityChargePrice(),
       pricing_type: Joi.string().allow(""),
-      recurring: BillingModel.EntityChargeRecurring(),
+      recurring: BillingPlatformModel.EntityChargeRecurring(),
       status: Joi.string().allow(""),
       term: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionCurrentPeriod} */
   static SubscriptionCurrentPeriod() {
     return Joi.object({
       end: Joi.string().allow(""),
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionCustomer} */
   static SubscriptionCustomer() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      billing_address: BillingModel.SubscriptionBillingAddress(),
+      billing_address: BillingPlatformModel.SubscriptionBillingAddress(),
       created_at: Joi.string().allow(""),
       data: Joi.any(),
       email: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      phone: BillingModel.Phone(),
+      phone: BillingPlatformModel.Phone(),
       type: Joi.string().allow(""),
       unique_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionCustomerCreate} */
   static SubscriptionCustomerCreate() {
     return Joi.object({
-      billing_address: BillingModel.SubscriptionBillingAddress(),
+      billing_address: BillingPlatformModel.SubscriptionBillingAddress(),
       email: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      phone: BillingModel.Phone(),
+      phone: BillingPlatformModel.Phone(),
       type: Joi.string().allow(""),
       unique_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionInvoiceSettings} */
   static SubscriptionInvoiceSettings() {
     return Joi.object({
       charging: Joi.boolean(),
       generation: Joi.boolean(),
     });
   }
+
+  /** @returns {SubscriptionLimit} */
   static SubscriptionLimit() {
     return Joi.object({
-      application: BillingModel.SubscriptionLimitApplication(),
-      extensions: BillingModel.SubscriptionLimitExtensions(),
-      integrations: BillingModel.SubscriptionLimitIntegrations(),
+      application: BillingPlatformModel.SubscriptionLimitApplication(),
+      extensions: BillingPlatformModel.SubscriptionLimitExtensions(),
+      integrations: BillingPlatformModel.SubscriptionLimitIntegrations(),
       is_trial_plan: Joi.boolean(),
-      marketplace: BillingModel.SubscriptionLimitMarketplace(),
-      other_platform: BillingModel.SubscriptionLimitOtherPlatform(),
-      products: BillingModel.SubscriptionLimitProducts(),
-      team: BillingModel.SubscriptionLimitTeam(),
+      marketplace: BillingPlatformModel.SubscriptionLimitMarketplace(),
+      other_platform: BillingPlatformModel.SubscriptionLimitOtherPlatform(),
+      products: BillingPlatformModel.SubscriptionLimitProducts(),
+      team: BillingPlatformModel.SubscriptionLimitTeam(),
     });
   }
+
+  /** @returns {SubscriptionLimitApplication} */
   static SubscriptionLimitApplication() {
     return Joi.object({
       enabled: Joi.boolean(),
@@ -554,76 +1293,102 @@ class BillingModel {
       soft_limit: Joi.number(),
     });
   }
+
+  /** @returns {SubscriptionLimitExtensions} */
   static SubscriptionLimitExtensions() {
     return Joi.object({
       enabled: Joi.boolean(),
       limit: Joi.number(),
     });
   }
+
+  /** @returns {SubscriptionLimitIntegrations} */
   static SubscriptionLimitIntegrations() {
     return Joi.object({
       enabled: Joi.boolean(),
       limit: Joi.number(),
     });
   }
+
+  /** @returns {SubscriptionLimitMarketplace} */
   static SubscriptionLimitMarketplace() {
     return Joi.object({
       enabled: Joi.boolean(),
     });
   }
+
+  /** @returns {SubscriptionLimitOtherPlatform} */
   static SubscriptionLimitOtherPlatform() {
     return Joi.object({
       enabled: Joi.boolean(),
     });
   }
+
+  /** @returns {SubscriptionLimitProducts} */
   static SubscriptionLimitProducts() {
     return Joi.object({
       bulk: Joi.boolean(),
       limit: Joi.number(),
     });
   }
+
+  /** @returns {SubscriptionLimitTeam} */
   static SubscriptionLimitTeam() {
     return Joi.object({
       limit: Joi.number(),
     });
   }
+
+  /** @returns {SubscriptionPauseCollection} */
   static SubscriptionPauseCollection() {
     return Joi.object({
       behavior: Joi.string().allow(""),
       resume_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionStatus} */
   static SubscriptionStatus() {
     return Joi.object({
-      current_subscriptions: Joi.array().items(BillingModel.Subscription()),
+      current_subscriptions: Joi.array().items(
+        BillingPlatformModel.Subscription()
+      ),
       is_enabled: Joi.boolean(),
-      latest_invoice: BillingModel.InvoicesData(),
+      latest_invoice: BillingPlatformModel.InvoicesData(),
       mandate_amount: Joi.string().allow(""),
-      next_plan: BillingModel.Plan(),
-      subscription: BillingModel.Subscription(),
+      next_plan: BillingPlatformModel.Plan(),
+      subscription: BillingPlatformModel.Subscription(),
     });
   }
+
+  /** @returns {SubscriptionTrial} */
   static SubscriptionTrial() {
     return Joi.object({
       end: Joi.string().allow(""),
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriptionTrialPeriod} */
   static SubscriptionTrialPeriod() {
     return Joi.object({
       end_date: Joi.string().allow(""),
       start_date: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UnauthenticatedApplication} */
   static UnauthenticatedApplication() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UnauthenticatedUser} */
   static UnauthenticatedUser() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
 }
-module.exports = BillingModel;
+module.exports = BillingPlatformModel;