@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-beta.2

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -18,6 +18,11 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {BillingPlatformModel.CancelSubscriptionReq} body
  */
 
+/**
+ * @typedef ChangePlanParam
+ * @property {BillingPlatformModel.SubscriptionActivateReq} body
+ */
+
 /**
  * @typedef CheckCouponValidityParam
  * @property {string} plan - ID of the plan.
@@ -31,11 +36,26 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  */
 
 /**
- * @typedef CreateSubscriptionChargeParam
- * @property {string} extensionId - Extension _id
- * @property {BillingPlatformModel.CreateSubscriptionCharge} body
+ * @typedef CreditTransactionParam
+ * @property {number} uniqueId - Unique ID of the company
+ * @property {string} productSuite - Product suite
+ * @property {string} type - Type of the company
+ * @property {number} [pageSize] - Number of items per page
+ * @property {number} [pageNo] - Page number
+ * @property {string} [startDate] - Start date
+ * @property {string} [endDate] - End date
+ * @property {string} [searchType] - Search Type
+ * @property {string} [searchValue] - Search Value
+ */
+
+/**
+ * @typedef CurrentAppLimitParam
+ * @property {string} [productSuite]
+ * @property {string} [type]
  */
 
+/** @typedef GetBankListParam */
+
 /**
  * @typedef GetChargeDetailsParam
  * @property {string} extensionId - Extension _id
@@ -59,6 +79,16 @@ const BillingPlatformModel = require("./BillingPlatformModel");
 
 /** @typedef GetInvoicesParam */
 
+/**
+ * @typedef GetPaymentOptionsParam
+ * @property {string} transactionId - ID of the payment transaction.
+ */
+
+/**
+ * @typedef GetPaymentTransactionParam
+ * @property {string} transactionId - Payment Transaction unique id.
+ */
+
 /** @typedef GetSubscriptionParam */
 
 /**
@@ -76,14 +106,116 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {string} [componentName] - The name of component the preferred to be fetched.
  */
 
+/**
+ * @typedef GlobalSettingsParam
+ * @property {number} pageNo - Number of pages needed
+ * @property {number} pageSize - Number of items to be there in page
+ * @property {Object} query - Field which will be used in db query
+ */
+
+/**
+ * @typedef MethodDefaultParam
+ * @property {BillingPlatformModel.DefaultReq} body
+ */
+
+/**
+ * @typedef PaymentCollectParam
+ * @property {BillingPlatformModel.PaymentCollectReq} body
+ */
+
+/**
+ * @typedef PaymentInitiateParam
+ * @property {BillingPlatformModel.SunscribePlan} body
+ */
+
+/**
+ * @typedef PaymentOptionsParam
+ * @property {string} code - Payment options unique code.
+ */
+
+/**
+ * @typedef PaymentStatusParam
+ * @property {string} orderId - Unique ID of the company
+ */
+
+/**
+ * @typedef PlanDowngradeParam
+ * @property {BillingPlatformModel.DowngradePlanReq} body
+ */
+
+/** @typedef PlanDowngradeGetParam */
+
 /**
  * @typedef PlanStatusUpdateParam
  * @property {BillingPlatformModel.PlanStatusUpdateReq} body
  */
 
 /**
- * @typedef SubscripePlanParam
- * @property {BillingPlatformModel.SunscribePlan} body
+ * @typedef SetupIntentParam
+ * @property {BillingPlatformModel.IntentReq} body
+ */
+
+/**
+ * @typedef SetupMandateParam
+ * @property {BillingPlatformModel.SetupMandateReq} body
+ */
+
+/**
+ * @typedef SetupPaymentParam
+ * @property {BillingPlatformModel.SetupPaymentReq} body
+ */
+
+/** @typedef SubscriptionConfigsParam */
+
+/**
+ * @typedef SubscriptionMethodsParam
+ * @property {string} uniqueExternalId - Unique id for external company
+ */
+
+/**
+ * @typedef SubscriptionMethodsDeleteParam
+ * @property {string} uniqueExternalId - Unique id for external company
+ * @property {string} paymentMethodId - Payment method id
+ */
+
+/**
+ * @typedef SubscriptionPlanChangeParam
+ * @property {string} [productSuite]
+ * @property {string} [coupon]
+ * @property {number} [uniqueId]
+ * @property {string} [platform]
+ * @property {string} [planId]
+ */
+
+/**
+ * @typedef SubscriptionRenewParam
+ * @property {BillingPlatformModel.SubscriptionRenewReq} body
+ */
+
+/**
+ * @typedef TopupCancelCreditParam
+ * @property {BillingPlatformModel.CancelTopupReq} body
+ */
+
+/**
+ * @typedef TopupCreditParam
+ * @property {BillingPlatformModel.TopupReq} body
+ */
+
+/**
+ * @typedef UpdateConsentParam
+ * @property {string} subscriberId - Customer unique id. In case of company it
+ *   will be company id.
+ */
+
+/**
+ * @typedef UpdateSetupIntentParam
+ * @property {BillingPlatformModel.PutIntentReq} body
+ */
+
+/**
+ * @typedef UpgradePlanParam
+ * @property {BillingPlatformModel.SubscriptionMethodsReq} body
  */
 
 /**
@@ -91,6 +223,11 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {BillingPlatformModel.SubscriptionCustomerCreate} body
  */
 
+/**
+ * @typedef VerifyPaymentParam
+ * @property {BillingPlatformModel.VerifyPaymentReq} body
+ */
+
 class BillingPlatformValidator {
   /** @returns {ActivateSubscriptionPlanParam} */
   static activateSubscriptionPlan() {
@@ -114,6 +251,13 @@ class BillingPlatformValidator {
     }).required();
   }
 
+  /** @returns {ChangePlanParam} */
+  static changePlan() {
+    return Joi.object({
+      body: BillingPlatformModel.SubscriptionActivateReq().required(),
+    }).required();
+  }
+
   /** @returns {CheckCouponValidityParam} */
   static checkCouponValidity() {
     return Joi.object({
@@ -130,14 +274,34 @@ class BillingPlatformValidator {
     }).required();
   }
 
-  /** @returns {CreateSubscriptionChargeParam} */
-  static createSubscriptionCharge() {
+  /** @returns {CreditTransactionParam} */
+  static creditTransaction() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      body: BillingPlatformModel.CreateSubscriptionCharge().required(),
+      uniqueId: Joi.number().required(),
+      productSuite: Joi.string().allow("").required(),
+      type: Joi.string().allow("").required(),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {CurrentAppLimitParam} */
+  static currentAppLimit() {
+    return Joi.object({
+      productSuite: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetBankListParam} */
+  static getBankList() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetChargeDetailsParam} */
   static getChargeDetails() {
     return Joi.object({
@@ -176,6 +340,20 @@ class BillingPlatformValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetPaymentOptionsParam} */
+  static getPaymentOptions() {
+    return Joi.object({
+      transactionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetPaymentTransactionParam} */
+  static getPaymentTransaction() {
+    return Joi.object({
+      transactionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetSubscriptionParam} */
   static getSubscription() {
     return Joi.object({}).required();
@@ -200,6 +378,62 @@ class BillingPlatformValidator {
     }).required();
   }
 
+  /** @returns {GlobalSettingsParam} */
+  static globalSettings() {
+    return Joi.object({
+      pageNo: Joi.number().required(),
+      pageSize: Joi.number().required(),
+      query: Joi.any().required(),
+    }).required();
+  }
+
+  /** @returns {MethodDefaultParam} */
+  static methodDefault() {
+    return Joi.object({
+      body: BillingPlatformModel.DefaultReq().required(),
+    }).required();
+  }
+
+  /** @returns {PaymentCollectParam} */
+  static paymentCollect() {
+    return Joi.object({
+      body: BillingPlatformModel.PaymentCollectReq().required(),
+    }).required();
+  }
+
+  /** @returns {PaymentInitiateParam} */
+  static paymentInitiate() {
+    return Joi.object({
+      body: BillingPlatformModel.SunscribePlan().required(),
+    }).required();
+  }
+
+  /** @returns {PaymentOptionsParam} */
+  static paymentOptions() {
+    return Joi.object({
+      code: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {PaymentStatusParam} */
+  static paymentStatus() {
+    return Joi.object({
+      orderId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {PlanDowngradeParam} */
+  static planDowngrade() {
+    return Joi.object({
+      body: BillingPlatformModel.DowngradePlanReq().required(),
+    }).required();
+  }
+
+  /** @returns {PlanDowngradeGetParam} */
+  static planDowngradeGet() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {PlanStatusUpdateParam} */
   static planStatusUpdate() {
     return Joi.object({
@@ -207,10 +441,97 @@ class BillingPlatformValidator {
     }).required();
   }
 
-  /** @returns {SubscripePlanParam} */
-  static subscripePlan() {
+  /** @returns {SetupIntentParam} */
+  static setupIntent() {
     return Joi.object({
-      body: BillingPlatformModel.SunscribePlan().required(),
+      body: BillingPlatformModel.IntentReq().required(),
+    }).required();
+  }
+
+  /** @returns {SetupMandateParam} */
+  static setupMandate() {
+    return Joi.object({
+      body: BillingPlatformModel.SetupMandateReq().required(),
+    }).required();
+  }
+
+  /** @returns {SetupPaymentParam} */
+  static setupPayment() {
+    return Joi.object({
+      body: BillingPlatformModel.SetupPaymentReq().required(),
+    }).required();
+  }
+
+  /** @returns {SubscriptionConfigsParam} */
+  static subscriptionConfigs() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {SubscriptionMethodsParam} */
+  static subscriptionMethods() {
+    return Joi.object({
+      uniqueExternalId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {SubscriptionMethodsDeleteParam} */
+  static subscriptionMethodsDelete() {
+    return Joi.object({
+      uniqueExternalId: Joi.string().allow("").required(),
+      paymentMethodId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {SubscriptionPlanChangeParam} */
+  static subscriptionPlanChange() {
+    return Joi.object({
+      productSuite: Joi.string().allow(""),
+      coupon: Joi.string().allow(""),
+      uniqueId: Joi.number(),
+      platform: Joi.string().allow(""),
+      planId: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {SubscriptionRenewParam} */
+  static subscriptionRenew() {
+    return Joi.object({
+      body: BillingPlatformModel.SubscriptionRenewReq().required(),
+    }).required();
+  }
+
+  /** @returns {TopupCancelCreditParam} */
+  static topupCancelCredit() {
+    return Joi.object({
+      body: BillingPlatformModel.CancelTopupReq().required(),
+    }).required();
+  }
+
+  /** @returns {TopupCreditParam} */
+  static topupCredit() {
+    return Joi.object({
+      body: BillingPlatformModel.TopupReq().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateConsentParam} */
+  static updateConsent() {
+    return Joi.object({
+      subscriberId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {UpdateSetupIntentParam} */
+  static updateSetupIntent() {
+    return Joi.object({
+      body: BillingPlatformModel.PutIntentReq().required(),
+    }).required();
+  }
+
+  /** @returns {UpgradePlanParam} */
+  static upgradePlan() {
+    return Joi.object({
+      body: BillingPlatformModel.SubscriptionMethodsReq().required(),
     }).required();
   }
 
@@ -220,6 +541,13 @@ class BillingPlatformValidator {
       body: BillingPlatformModel.SubscriptionCustomerCreate().required(),
     }).required();
   }
+
+  /** @returns {VerifyPaymentParam} */
+  static verifyPayment() {
+    return Joi.object({
+      body: BillingPlatformModel.VerifyPaymentReq().required(),
+    }).required();
+  }
 }
 
 module.exports = BillingPlatformValidator;

package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts

@@ -205,7 +205,7 @@ declare class Cart {
      * @summary: Get a cart
      * @description: Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
      */
-    getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
+    getCart({ id, userId, orderType, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
     /**
      * @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -292,12 +292,12 @@ declare class Cart {
      * @param {CartPlatformApplicationValidator.GetPriceAdjustmentsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
+     * @returns {Promise<CartPlatformModel.GetPriceAdjustmentResponse>} - Success response
      * @name getPriceAdjustments
      * @summary: Get a list of all price adjustments associated with a cart
      * @description: This API helps to get price adjustments data associated to a particular cart - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPriceAdjustments/).
      */
-    getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
+    getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetPriceAdjustmentResponse>;
     /**
      * @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
      *   - Arg object
@@ -332,6 +332,29 @@ declare class Cart {
      * @description: Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
      */
     getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
+    /**
+     * @param {CartPlatformApplicationValidator.GetPromotionOffersParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CartPlatformModel.PromotionOffersResponse>} - Success response
+     * @name getPromotionOffers
+     * @summary: List available promotion offers
+     * @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
+     */
+    getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersResponse>;
+    /**
+     * @param {CartPlatformApplicationValidator.GetPromotionPaymentOffersParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CartPlatformModel.PromotionPaymentOffersResponse>} -
+     *   Success response
+     * @name getPromotionPaymentOffers
+     * @summary: Fetch available promotions payment offers
+     * @description: Use this API to get top 5 payment offers available for current product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionPaymentOffers/).
+     */
+    getPromotionPaymentOffers({ id, uid, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionPaymentOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionPaymentOffersResponse>;
     /**
      * @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -384,7 +407,7 @@ declare class Cart {
      * @summary: Add items to cart
      * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
      */
-    platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
+    platformAddItems({ body, i, b, buyNow, orderType, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
     /**
      * @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
      *   - Arg object
@@ -418,7 +441,7 @@ declare class Cart {
      * @summary: Update cart items
      * @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
      */
-    platformUpdateCart({ body, id, i, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
+    platformUpdateCart({ body, id, i, orderType, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
     /**
      * @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`