@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -0,0 +1,906 @@
+const Joi = require("joi");
+
+class BillingModel {
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static UnauthenticatedUser() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static UnauthenticatedApplication() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static BadRequest() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static ResourceNotFound() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static InternalServerError() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static CheckValidityResponse() {
+    return Joi.object({
+      is_valid: Joi.boolean(),
+
+      discount_amount: Joi.number(),
+    });
+  }
+
+  static PlanRecurring() {
+    return Joi.object({
+      interval: Joi.string().allow(""),
+
+      interval_count: Joi.number(),
+    });
+  }
+
+  static Plan() {
+    return Joi.object({
+      recurring: BillingModel.PlanRecurring(),
+
+      is_trial_plan: Joi.boolean(),
+
+      plan_group: Joi.string().allow(""),
+
+      tag_lines: Joi.array().items(Joi.string().allow("")),
+
+      currency: Joi.string().allow(""),
+
+      is_active: Joi.boolean(),
+
+      is_visible: Joi.boolean(),
+
+      trial_period: Joi.number(),
+
+      addons: Joi.array().items(Joi.string().allow("")),
+
+      tags: Joi.array().items(Joi.string().allow("")),
+
+      type: Joi.string().allow(""),
+
+      country: Joi.string().allow(""),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      amount: Joi.number(),
+
+      product_suite_id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+    });
+  }
+
+  static DetailedPlanComponents() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      slug: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      group: Joi.string().allow(""),
+
+      icon: Joi.string().allow(""),
+
+      links: Joi.any(),
+
+      enabled: Joi.boolean(),
+
+      display_text: Joi.string().allow(""),
+    });
+  }
+
+  static DetailedPlan() {
+    return Joi.object({
+      recurring: BillingModel.PlanRecurring(),
+
+      is_trial_plan: Joi.boolean(),
+
+      plan_group: Joi.string().allow(""),
+
+      tag_lines: Joi.array().items(Joi.string().allow("")),
+
+      currency: Joi.string().allow(""),
+
+      is_active: Joi.boolean(),
+
+      is_visible: Joi.boolean(),
+
+      trial_period: Joi.number(),
+
+      addons: Joi.array().items(Joi.string().allow("")),
+
+      tags: Joi.array().items(Joi.string().allow("")),
+
+      type: Joi.string().allow(""),
+
+      country: Joi.string().allow(""),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      amount: Joi.number(),
+
+      product_suite_id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+
+      components: Joi.array().items(BillingModel.DetailedPlanComponents()),
+    });
+  }
+
+  static SubscriptionTrialPeriod() {
+    return Joi.object({
+      start_date: Joi.string().allow(""),
+
+      end_date: Joi.string().allow(""),
+    });
+  }
+
+  static EntityChargePrice() {
+    return Joi.object({
+      amount: Joi.number().required(),
+
+      currency_code: Joi.string().allow("").required(),
+    });
+  }
+
+  static EntityChargeRecurring() {
+    return Joi.object({
+      interval: Joi.string().allow("").required(),
+    });
+  }
+
+  static ChargeLineItem() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+
+      term: Joi.string().allow("").required(),
+
+      pricing_type: Joi.string().allow("").required(),
+
+      price: BillingModel.EntityChargePrice().required(),
+
+      recurring: BillingModel.EntityChargeRecurring(),
+
+      capped_amount: Joi.number(),
+
+      trial_days: Joi.number(),
+
+      is_test: Joi.boolean(),
+
+      metadata: Joi.any(),
+    });
+  }
+
+  static CreateSubscriptionCharge() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+
+      trial_days: Joi.number(),
+
+      line_items: Joi.array().items(BillingModel.ChargeLineItem()).required(),
+
+      is_test: Joi.boolean(),
+
+      return_url: Joi.string().allow("").required(),
+    });
+  }
+
+  static CurrentPeriod() {
+    return Joi.object({
+      start_date: Joi.string().allow(""),
+
+      end_date: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionCharge() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      term: Joi.string().allow(""),
+
+      pricing_type: Joi.string().allow(""),
+
+      price: BillingModel.EntityChargePrice(),
+
+      recurring: BillingModel.EntityChargeRecurring(),
+
+      capped_amount: Joi.number(),
+
+      activated_on: Joi.string().allow(""),
+
+      cancelled_on: Joi.string().allow(""),
+
+      billing_date: Joi.string().allow(""),
+
+      current_period: BillingModel.CurrentPeriod(),
+
+      status: Joi.string().allow(""),
+
+      is_test: Joi.boolean(),
+
+      metadata: Joi.any(),
+    });
+  }
+
+  static EntitySubscription() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      status: Joi.string().allow(""),
+
+      company_id: Joi.number(),
+
+      activated_on: Joi.string().allow(""),
+
+      cancelled_on: Joi.string().allow(""),
+
+      trial_days: Joi.number(),
+
+      trial_period: BillingModel.SubscriptionTrialPeriod(),
+
+      metadata: Joi.any(),
+
+      line_items: Joi.array().items(BillingModel.SubscriptionCharge()),
+    });
+  }
+
+  static CreateSubscriptionResponse() {
+    return Joi.object({
+      subscription: BillingModel.EntitySubscription(),
+
+      confirm_url: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsPeriod() {
+    return Joi.object({
+      start: Joi.string().allow(""),
+
+      end: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsClient() {
+    return Joi.object({
+      address_lines: Joi.array().items(Joi.string().allow("")),
+
+      name: Joi.string().allow(""),
+
+      email: Joi.string().allow(""),
+
+      phone: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsStatusTrail() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      value: Joi.string().allow(""),
+
+      timestamp: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsPaymentMethodsDataChecks() {
+    return Joi.object({
+      cvc_check: Joi.string().allow(""),
+
+      address_line1_check: Joi.string().allow(""),
+
+      address_postal_code_check: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsPaymentMethodsDataNetworks() {
+    return Joi.object({
+      available: Joi.array().items(Joi.string().allow("")),
+
+      preferred: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetailsPaymentMethodsDataThreeDSecureUsage() {
+    return Joi.object({
+      supported: Joi.boolean(),
+    });
+  }
+
+  static InvoiceDetailsPaymentMethodsData() {
+    return Joi.object({
+      brand: Joi.string().allow(""),
+
+      last4: Joi.string().allow(""),
+
+      checks: BillingModel.InvoiceDetailsPaymentMethodsDataChecks(),
+
+      wallet: Joi.string().allow(""),
+
+      country: Joi.string().allow(""),
+
+      funding: Joi.string().allow(""),
+
+      exp_year: Joi.number(),
+
+      networks: BillingModel.InvoiceDetailsPaymentMethodsDataNetworks(),
+
+      exp_month: Joi.number(),
+
+      fingerprint: Joi.string().allow(""),
+
+      generated_from: Joi.string().allow(""),
+
+      three_d_secure_usage: BillingModel.InvoiceDetailsPaymentMethodsDataThreeDSecureUsage(),
+    });
+  }
+
+  static InvoiceDetailsPaymentMethods() {
+    return Joi.object({
+      id: Joi.number(),
+
+      type: Joi.string().allow(""),
+
+      pg_payment_method_id: Joi.string().allow(""),
+
+      data: BillingModel.InvoiceDetailsPaymentMethodsData(),
+
+      is_default: Joi.boolean(),
+    });
+  }
+
+  static InvoicePaymentMethod() {
+    return Joi.object({
+      pg_payment_method_id: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceDetails() {
+    return Joi.object({
+      period: BillingModel.InvoiceDetailsPeriod(),
+
+      client: BillingModel.InvoiceDetailsClient(),
+
+      auto_advance: Joi.boolean(),
+
+      currency: Joi.string().allow(""),
+
+      paid: Joi.boolean(),
+
+      attemp: Joi.number(),
+
+      _id: Joi.string().allow(""),
+
+      collection_method: Joi.string().allow(""),
+
+      subscriber_id: Joi.string().allow(""),
+
+      invoice_url: Joi.string().allow(""),
+
+      number: Joi.string().allow(""),
+
+      pg_data: Joi.any(),
+
+      receipt_number: Joi.string().allow(""),
+
+      statement_descriptor: Joi.string().allow(""),
+
+      current_status: Joi.string().allow(""),
+
+      status_trail: Joi.array().items(BillingModel.InvoiceDetailsStatusTrail()),
+
+      subtotal: Joi.number(),
+
+      total: Joi.number(),
+
+      subscription: Joi.string().allow(""),
+
+      next_action_time: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+
+      hash_identifier: Joi.string().allow(""),
+
+      payment_method: BillingModel.InvoicePaymentMethod(),
+    });
+  }
+
+  static InvoiceItemsPlanRecurring() {
+    return Joi.object({
+      interval: Joi.string().allow(""),
+
+      interval_count: Joi.number(),
+    });
+  }
+
+  static InvoiceItemsPlan() {
+    return Joi.object({
+      recurring: BillingModel.InvoiceItemsPlanRecurring(),
+
+      is_trial_plan: Joi.boolean(),
+
+      plan_group: Joi.string().allow(""),
+
+      tag_lines: Joi.array().items(Joi.string().allow("")),
+
+      currency: Joi.string().allow(""),
+
+      is_active: Joi.boolean(),
+
+      is_visible: Joi.boolean(),
+
+      trial_period: Joi.number(),
+
+      addons: Joi.array().items(Joi.string().allow("")),
+
+      tags: Joi.array().items(Joi.string().allow("")),
+
+      type: Joi.string().allow(""),
+
+      country: Joi.string().allow(""),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      amount: Joi.number(),
+
+      product_suite_id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceItemsPeriod() {
+    return Joi.object({
+      start: Joi.string().allow(""),
+
+      end: Joi.string().allow(""),
+    });
+  }
+
+  static InvoiceItems() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      currency: Joi.string().allow(""),
+
+      plan: BillingModel.InvoiceItemsPlan(),
+
+      name: Joi.string().allow(""),
+
+      quantity: Joi.number(),
+
+      description: Joi.string().allow(""),
+
+      period: BillingModel.InvoiceItemsPeriod(),
+
+      unit_amount: Joi.number(),
+
+      amount: Joi.number(),
+
+      type: Joi.string().allow(""),
+
+      invoice_id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+    });
+  }
+
+  static Invoice() {
+    return Joi.object({
+      invoice: BillingModel.InvoiceDetails(),
+
+      invoice_items: Joi.array().items(BillingModel.InvoiceItems()),
+    });
+  }
+
+  static InvoicesDataClient() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      email: Joi.string().allow(""),
+
+      phone: Joi.string().allow(""),
+
+      address_lines: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  static InvoicesDataPeriod() {
+    return Joi.object({
+      start: Joi.string().allow(""),
+
+      end: Joi.string().allow(""),
+    });
+  }
+
+  static InvoicesDataPaymentMethod() {
+    return Joi.object({
+      pg_payment_method_id: Joi.string().allow(""),
+    });
+  }
+
+  static InvoicesData() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      client: BillingModel.InvoicesDataClient(),
+
+      auto_advance: Joi.boolean(),
+
+      currency: Joi.string().allow(""),
+
+      paid: Joi.boolean(),
+
+      attemp: Joi.number(),
+
+      collection_method: Joi.string().allow(""),
+
+      subscriber_id: Joi.string().allow(""),
+
+      invoice_url: Joi.string().allow(""),
+
+      number: Joi.string().allow(""),
+
+      pg_data: Joi.any(),
+
+      period: BillingModel.InvoicesDataPeriod(),
+
+      receipt_number: Joi.string().allow(""),
+
+      statement_descriptor: Joi.string().allow(""),
+
+      current_status: Joi.string().allow(""),
+
+      status_trail: Joi.array().items(BillingModel.InvoiceDetailsStatusTrail()),
+
+      subtotal: Joi.number(),
+
+      total: Joi.number(),
+
+      subscription: Joi.string().allow(""),
+
+      next_action_time: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+
+      hash_identifier: Joi.string().allow(""),
+
+      payment_method: BillingModel.InvoicesDataPaymentMethod(),
+
+      invoice_items: Joi.array().items(BillingModel.InvoiceItems()),
+    });
+  }
+
+  static Invoices() {
+    return Joi.object({
+      data: Joi.array().items(BillingModel.InvoicesData()),
+
+      start: Joi.number(),
+
+      end: Joi.number(),
+
+      limit: Joi.number(),
+
+      page: Joi.number(),
+
+      total: Joi.number(),
+    });
+  }
+
+  static Phone() {
+    return Joi.object({
+      phone_number: Joi.string().allow(""),
+
+      phone_country_code: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionBillingAddress() {
+    return Joi.object({
+      country: Joi.string().allow(""),
+
+      state: Joi.string().allow(""),
+
+      city: Joi.string().allow(""),
+
+      line1: Joi.string().allow(""),
+
+      line2: Joi.string().allow(""),
+
+      postal_code: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionCustomer() {
+    return Joi.object({
+      phone: BillingModel.Phone(),
+
+      billing_address: BillingModel.SubscriptionBillingAddress(),
+
+      _id: Joi.string().allow(""),
+
+      unique_id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      email: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+
+      data: Joi.any(),
+    });
+  }
+
+  static SubscriptionCustomerCreate() {
+    return Joi.object({
+      phone: BillingModel.Phone(),
+
+      billing_address: BillingModel.SubscriptionBillingAddress(),
+
+      unique_id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      email: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionCurrentPeriod() {
+    return Joi.object({
+      start: Joi.string().allow(""),
+
+      end: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionPauseCollection() {
+    return Joi.object({
+      behavior: Joi.string().allow(""),
+
+      resume_at: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionTrial() {
+    return Joi.object({
+      start: Joi.string().allow(""),
+
+      end: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionInvoiceSettings() {
+    return Joi.object({
+      generation: Joi.boolean(),
+
+      charging: Joi.boolean(),
+    });
+  }
+
+  static Subscription() {
+    return Joi.object({
+      current_period: BillingModel.SubscriptionCurrentPeriod(),
+
+      pause_collection: BillingModel.SubscriptionPauseCollection(),
+
+      trial: BillingModel.SubscriptionTrial(),
+
+      invoice_settings: BillingModel.SubscriptionInvoiceSettings(),
+
+      is_active: Joi.boolean(),
+
+      cancel_at_period_end: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      subscriber_id: Joi.string().allow(""),
+
+      plan_id: Joi.string().allow(""),
+
+      product_suite_id: Joi.string().allow(""),
+
+      plan_data: BillingModel.Plan(),
+
+      current_status: Joi.string().allow(""),
+
+      collection_method: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      modified_at: Joi.string().allow(""),
+
+      latest_invoice: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionStatus() {
+    return Joi.object({
+      is_enabled: Joi.boolean(),
+
+      subscription: BillingModel.Subscription(),
+    });
+  }
+
+  static SubscriptionLimitApplication() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+
+      hard_limit: Joi.number(),
+
+      soft_limit: Joi.number(),
+    });
+  }
+
+  static SubscriptionLimitMarketplace() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+    });
+  }
+
+  static SubscriptionLimitOtherPlatform() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+    });
+  }
+
+  static SubscriptionLimitTeam() {
+    return Joi.object({
+      limit: Joi.number(),
+    });
+  }
+
+  static SubscriptionLimitProducts() {
+    return Joi.object({
+      bulk: Joi.boolean(),
+
+      limit: Joi.number(),
+    });
+  }
+
+  static SubscriptionLimitExtensions() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+
+      limit: Joi.number(),
+    });
+  }
+
+  static SubscriptionLimitIntegrations() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+
+      limit: Joi.number(),
+    });
+  }
+
+  static SubscriptionLimit() {
+    return Joi.object({
+      application: BillingModel.SubscriptionLimitApplication(),
+
+      marketplace: BillingModel.SubscriptionLimitMarketplace(),
+
+      other_platform: BillingModel.SubscriptionLimitOtherPlatform(),
+
+      team: BillingModel.SubscriptionLimitTeam(),
+
+      products: BillingModel.SubscriptionLimitProducts(),
+
+      extensions: BillingModel.SubscriptionLimitExtensions(),
+
+      integrations: BillingModel.SubscriptionLimitIntegrations(),
+
+      is_trial_plan: Joi.boolean(),
+    });
+  }
+
+  static SubscriptionActivateReq() {
+    return Joi.object({
+      unique_id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      product_suite: Joi.string().allow(""),
+
+      plan_id: Joi.string().allow(""),
+
+      payment_method: Joi.string().allow(""),
+    });
+  }
+
+  static SubscriptionActivateRes() {
+    return Joi.object({
+      success: Joi.boolean(),
+
+      data: BillingModel.Subscription(),
+    });
+  }
+
+  static CancelSubscriptionReq() {
+    return Joi.object({
+      unique_id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      product_suite: Joi.string().allow(""),
+
+      subscription_id: Joi.string().allow(""),
+    });
+  }
+
+  static CancelSubscriptionRes() {
+    return Joi.object({
+      success: Joi.boolean(),
+
+      data: BillingModel.Subscription(),
+    });
+  }
+}
+module.exports = BillingModel;