@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

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

@@ -34,11 +34,7 @@ export = BillingPlatformValidator;
  */
 /** @typedef GetCustomerDetailParam */
 /** @typedef GetEnterprisePlansParam */
-/**
- * @typedef GetFeatureLimitConfigParam
- * @property {string} [productSuite]
- * @property {string} [type]
- */
+/** @typedef GetFeatureLimitConfigParam */
 /**
  * @typedef GetInvoiceByIdParam
  * @property {string} invoiceId - Invoice id
@@ -50,14 +46,6 @@ export = BillingPlatformValidator;
  * @property {string} extensionId - Extension _id
  * @property {string} subscriptionId - Subscription charge _id
  */
-/**
- * @typedef GetentityDetailParam
- * @property {string} entityName - Entity name.
- * @property {string} [entityId] - Entity unique id.
- * @property {string} channel - Ordering channel.
- * @property {string} [component] - The coponents the user would like to know.
- * @property {string} [componentName] - The name of component the preferred to be fetched.
- */
 /**
  * @typedef PlanStatusUpdateParam
  * @property {BillingPlatformModel.PlanStatusUpdateReq} body
@@ -90,7 +78,7 @@ declare class BillingPlatformValidator {
     /** @returns {GetEnterprisePlansParam} */
     static getEnterprisePlans(): any;
     /** @returns {GetFeatureLimitConfigParam} */
-    static getFeatureLimitConfig(): GetFeatureLimitConfigParam;
+    static getFeatureLimitConfig(): any;
     /** @returns {GetInvoiceByIdParam} */
     static getInvoiceById(): GetInvoiceByIdParam;
     /** @returns {GetInvoicesParam} */
@@ -99,8 +87,6 @@ declare class BillingPlatformValidator {
     static getSubscription(): any;
     /** @returns {GetSubscriptionChargeParam} */
     static getSubscriptionCharge(): GetSubscriptionChargeParam;
-    /** @returns {GetentityDetailParam} */
-    static getentityDetail(): GetentityDetailParam;
     /** @returns {PlanStatusUpdateParam} */
     static planStatusUpdate(): PlanStatusUpdateParam;
     /** @returns {SubscripePlanParam} */
@@ -109,7 +95,7 @@ declare class BillingPlatformValidator {
     static upsertCustomerDetail(): UpsertCustomerDetailParam;
 }
 declare namespace BillingPlatformValidator {
-    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, GetChargeDetailsParam, GetCustomerDetailParam, GetEnterprisePlansParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetSubscriptionParam, GetSubscriptionChargeParam, GetentityDetailParam, PlanStatusUpdateParam, SubscripePlanParam, UpsertCustomerDetailParam };
+    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, GetChargeDetailsParam, GetCustomerDetailParam, GetEnterprisePlansParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetSubscriptionParam, GetSubscriptionChargeParam, PlanStatusUpdateParam, SubscripePlanParam, UpsertCustomerDetailParam };
 }
 type ActivateSubscriptionPlanParam = {
     body: BillingPlatformModel.SubscriptionActivateReq;
@@ -161,10 +147,6 @@ type GetChargeDetailsParam = {
      */
     chargeId: string;
 };
-type GetFeatureLimitConfigParam = {
-    productSuite?: string;
-    type?: string;
-};
 type GetInvoiceByIdParam = {
     /**
      * - Invoice id
@@ -181,28 +163,6 @@ type GetSubscriptionChargeParam = {
      */
     subscriptionId: string;
 };
-type GetentityDetailParam = {
-    /**
-     * - Entity name.
-     */
-    entityName: string;
-    /**
-     * - Entity unique id.
-     */
-    entityId?: string;
-    /**
-     * - Ordering channel.
-     */
-    channel: string;
-    /**
-     * - The coponents the user would like to know.
-     */
-    component?: string;
-    /**
-     * - The name of component the preferred to be fetched.
-     */
-    componentName?: string;
-};
 type PlanStatusUpdateParam = {
     body: BillingPlatformModel.PlanStatusUpdateReq;
 };
@@ -214,6 +174,7 @@ type UpsertCustomerDetailParam = {
 };
 type GetCustomerDetailParam = any;
 type GetEnterprisePlansParam = any;
+type GetFeatureLimitConfigParam = any;
 type GetInvoicesParam = any;
 type GetSubscriptionParam = any;
 import BillingPlatformModel = require("./BillingPlatformModel");

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -46,11 +46,7 @@ const BillingPlatformModel = require("./BillingPlatformModel");
 
 /** @typedef GetEnterprisePlansParam */
 
-/**
- * @typedef GetFeatureLimitConfigParam
- * @property {string} [productSuite]
- * @property {string} [type]
- */
+/** @typedef GetFeatureLimitConfigParam */
 
 /**
  * @typedef GetInvoiceByIdParam
@@ -67,15 +63,6 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {string} subscriptionId - Subscription charge _id
  */
 
-/**
- * @typedef GetentityDetailParam
- * @property {string} entityName - Entity name.
- * @property {string} [entityId] - Entity unique id.
- * @property {string} channel - Ordering channel.
- * @property {string} [component] - The coponents the user would like to know.
- * @property {string} [componentName] - The name of component the preferred to be fetched.
- */
-
 /**
  * @typedef PlanStatusUpdateParam
  * @property {BillingPlatformModel.PlanStatusUpdateReq} body
@@ -158,10 +145,7 @@ class BillingPlatformValidator {
 
   /** @returns {GetFeatureLimitConfigParam} */
   static getFeatureLimitConfig() {
-    return Joi.object({
-      productSuite: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    }).required();
+    return Joi.object({}).required();
   }
 
   /** @returns {GetInvoiceByIdParam} */
@@ -189,17 +173,6 @@ class BillingPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetentityDetailParam} */
-  static getentityDetail() {
-    return Joi.object({
-      entityName: Joi.string().allow("").required(),
-      entityId: Joi.string().allow(""),
-      channel: Joi.string().allow("").required(),
-      component: Joi.string().allow(""),
-      componentName: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {PlanStatusUpdateParam} */
   static planStatusUpdate() {
     return Joi.object({

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

@@ -207,7 +207,7 @@ declare class Cart {
      * @summary: Fetch Coupon
      * @description: Use this API to get a list of available coupons along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
      */
-    getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
+    getAppCoupons({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
     /**
      * @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
      *   - Arg object
@@ -338,6 +338,16 @@ declare class Cart {
      * @description: Use this API to get the total number of items present in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
      */
     getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
+    /**
+     * @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
+     * @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>;
     /**
      * @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
      *   - Arg object

package/sdk/platform/Cart/CartPlatformApplicationClient.js

@@ -1452,15 +1452,13 @@ class Cart {
    * @description: Use this API to get a list of available coupons along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
    */
   async getAppCoupons(
-    { id, buyNow, slug, storeId, requestHeaders } = { requestHeaders: {} },
+    { id, buyNow, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = CartPlatformApplicationValidator.getAppCoupons().validate(
       {
         id,
         buyNow,
-        slug,
-        storeId,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -1475,8 +1473,6 @@ class Cart {
       {
         id,
         buyNow,
-        slug,
-        storeId,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -1490,8 +1486,6 @@ class Cart {
     const query_params = {};
     query_params["id"] = id;
     query_params["buy_now"] = buyNow;
-    query_params["slug"] = slug;
-    query_params["store_id"] = storeId;
 
     const response = await PlatformAPIClient.execute(
       this.config,
@@ -2424,6 +2418,86 @@ class Cart {
     return response;
   }
 
+  /**
+   * @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
+   * @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/).
+   */
+  async getPriceAdjustments(
+    { cartId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CartPlatformApplicationValidator.getPriceAdjustments().validate(
+      {
+        cartId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CartPlatformApplicationValidator.getPriceAdjustments().validate(
+      {
+        cartId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Cart > getPriceAdjustments \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["cart_id"] = cartId;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/price-adjustment`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CartPlatformModel.PriceAdjustmentResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Cart > getPriceAdjustments \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
    *   - Arg object

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

@@ -94,8 +94,6 @@ export = CartPlatformApplicationValidator;
  * @typedef GetAppCouponsParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {string} [slug]
- * @property {string} [storeId]
  */
 /**
  * @typedef GetAvailableDeliveryModesParam
@@ -150,6 +148,10 @@ export = CartPlatformApplicationValidator;
  * @property {string} [id] - The unique identifier of the cart.
  * @property {boolean} [buyNow]
  */
+/**
+ * @typedef GetPriceAdjustmentsParam
+ * @property {string} cartId - Cart Id
+ */
 /**
  * @typedef GetPromosCouponConfigParam
  * @property {string} [entityType] - Entity_type as promotion or coupon
@@ -400,6 +402,8 @@ declare class CartPlatformApplicationValidator {
     static getCoupons(): GetCouponsParam;
     /** @returns {GetItemCountParam} */
     static getItemCount(): GetItemCountParam;
+    /** @returns {GetPriceAdjustmentsParam} */
+    static getPriceAdjustments(): GetPriceAdjustmentsParam;
     /** @returns {GetPromosCouponConfigParam} */
     static getPromosCouponConfig(): GetPromosCouponConfigParam;
     /** @returns {GetPromotionByIdParam} */
@@ -462,7 +466,7 @@ declare class CartPlatformApplicationValidator {
     static validateCouponForPayment(): ValidateCouponForPaymentParam;
 }
 declare namespace CartPlatformApplicationValidator {
-    export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
+    export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
 }
 type AddAddressParam = {
     body: CartPlatformModel.PlatformAddress;
@@ -548,8 +552,6 @@ type GetAddressesParam = {
 type GetAppCouponsParam = {
     id?: string;
     buyNow?: boolean;
-    slug?: string;
-    storeId?: string;
 };
 type GetAvailableDeliveryModesParam = {
     areaCode: string;
@@ -600,6 +602,12 @@ type GetItemCountParam = {
     id?: string;
     buyNow?: boolean;
 };
+type GetPriceAdjustmentsParam = {
+    /**
+     * - Cart Id
+     */
+    cartId: string;
+};
 type GetPromosCouponConfigParam = {
     /**
      * - Entity_type as promotion or coupon

package/sdk/platform/Cart/CartPlatformApplicationValidator.js

@@ -113,8 +113,6 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @typedef GetAppCouponsParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {string} [slug]
- * @property {string} [storeId]
  */
 
 /**
@@ -180,6 +178,11 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [buyNow]
  */
 
+/**
+ * @typedef GetPriceAdjustmentsParam
+ * @property {string} cartId - Cart Id
+ */
+
 /**
  * @typedef GetPromosCouponConfigParam
  * @property {string} [entityType] - Entity_type as promotion or coupon
@@ -551,8 +554,6 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      slug: Joi.string().allow(""),
-      storeId: Joi.string().allow(""),
     }).required();
   }
 
@@ -640,6 +641,13 @@ class CartPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetPriceAdjustmentsParam} */
+  static getPriceAdjustments() {
+    return Joi.object({
+      cartId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetPromosCouponConfigParam} */
   static getPromosCouponConfig() {
     return Joi.object({