@gofynd/fdk-client-javascript 0.1.37 → 1.0.0

package/sdk/platform/Cart/CartPlatformApplicationClient.js

@@ -0,0 +1,755 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const CartValidator = require("./CartPlatformApplicationValidator");
+
+class Cart {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] -
+   * @param {number} [arg.pageSize] -
+   * @param {boolean} [arg.isArchived] -
+   * @param {string} [arg.title] -
+   * @param {boolean} [arg.isPublic] -
+   * @param {boolean} [arg.isDisplay] -
+   * @param {string} [arg.typeSlug] -
+   * @param {string} [arg.code] -
+   * @summary: Get with single coupon details or coupon list
+   * @description: Get coupon list with pagination
+   */
+  getCoupons({
+    pageNo,
+    pageSize,
+    isArchived,
+    title,
+    isPublic,
+    isDisplay,
+    typeSlug,
+    code,
+  } = {}) {
+    const { error } = CartValidator.getCoupons().validate(
+      {
+        pageNo,
+        pageSize,
+        isArchived,
+        title,
+        isPublic,
+        isDisplay,
+        typeSlug,
+        code,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["is_archived"] = isArchived;
+    query_params["title"] = title;
+    query_params["is_public"] = isPublic;
+    query_params["is_display"] = isDisplay;
+    query_params["type_slug"] = typeSlug;
+    query_params["code"] = code;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.companyId - Current company id
+   * @param {string} arg.applicationId - Current Application _id
+   * @param {number} [arg.pageSize] -
+   * @param {boolean} [arg.isArchived] -
+   * @param {string} [arg.title] -
+   * @param {boolean} [arg.isPublic] -
+   * @param {boolean} [arg.isDisplay] -
+   * @param {string} [arg.typeSlug] -
+   * @param {string} [arg.code] -
+   * @summary: Get with single coupon details or coupon list
+   * @description: Get coupon list with pagination
+   */
+  getCouponsPaginator({
+    companyId,
+    applicationId,
+    pageSize,
+    isArchived,
+    title,
+    isPublic,
+    isDisplay,
+    typeSlug,
+    code,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getCoupons({
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        isArchived: isArchived,
+        title: title,
+        isPublic: isPublic,
+        isDisplay: isDisplay,
+        typeSlug: typeSlug,
+        code: code,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {CouponAdd} arg.body
+   * @summary: Create new coupon
+   * @description: Create new coupon
+   */
+  createCoupon({ body } = {}) {
+    const { error } = CartValidator.createCoupon().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @summary: Get with single coupon details or coupon list
+   * @description: Get single coupon details with `id` in path param
+   */
+  getCouponById({ id } = {}) {
+    const { error } = CartValidator.getCouponById().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon/${id}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @param {CouponUpdate} arg.body
+   * @summary: Update existing coupon configuration
+   * @description: Update coupon with id sent in `id`
+   */
+  updateCoupon({ id, body } = {}) {
+    const { error } = CartValidator.updateCoupon().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon/${id}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @param {CouponPartialUpdate} arg.body
+   * @summary: Update coupon archive state and schedule
+   * @description: Update archive/unarchive and change schedule for coupon
+   */
+  updateCouponPartially({ id, body } = {}) {
+    const { error } = CartValidator.updateCouponPartially().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon/${id}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] -
+   * @param {number} [arg.pageSize] -
+   * @param {string} [arg.q] -
+   * @param {boolean} [arg.isActive] -
+   * @param {string} [arg.promoGroup] -
+   * @param {string} [arg.promotionType] -
+   * @param {string} [arg.fpPanel] -
+   * @param {string} [arg.promotionId] -
+   * @summary: Get promotion list
+   * @description: Get promotion list with pagination
+   */
+  getPromotions({
+    pageNo,
+    pageSize,
+    q,
+    isActive,
+    promoGroup,
+    promotionType,
+    fpPanel,
+    promotionId,
+  } = {}) {
+    const { error } = CartValidator.getPromotions().validate(
+      {
+        pageNo,
+        pageSize,
+        q,
+        isActive,
+        promoGroup,
+        promotionType,
+        fpPanel,
+        promotionId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["q"] = q;
+    query_params["is_active"] = isActive;
+    query_params["promo_group"] = promoGroup;
+    query_params["promotion_type"] = promotionType;
+    query_params["fp_panel"] = fpPanel;
+    query_params["promotion_id"] = promotionId;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.companyId - Current company id
+   * @param {string} arg.applicationId - Current Application _id
+   * @param {number} [arg.pageSize] -
+   * @param {string} [arg.q] -
+   * @param {boolean} [arg.isActive] -
+   * @param {string} [arg.promoGroup] -
+   * @param {string} [arg.promotionType] -
+   * @param {string} [arg.fpPanel] -
+   * @param {string} [arg.promotionId] -
+   * @summary: Get promotion list
+   * @description: Get promotion list with pagination
+   */
+  getPromotionsPaginator({
+    companyId,
+    applicationId,
+    pageSize,
+    q,
+    isActive,
+    promoGroup,
+    promotionType,
+    fpPanel,
+    promotionId,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getPromotions({
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+        isActive: isActive,
+        promoGroup: promoGroup,
+        promotionType: promotionType,
+        fpPanel: fpPanel,
+        promotionId: promotionId,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {PromotionAdd} arg.body
+   * @summary: Create new promotion
+   * @description: Create new promotion
+   */
+  createPromotion({ body } = {}) {
+    const { error } = CartValidator.createPromotion().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @summary: Get with single promotion details or promotion list
+   * @description: Get single promotion details with `id` in path param
+   */
+  getPromotionById({ id } = {}) {
+    const { error } = CartValidator.getPromotionById().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion/${id}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @param {PromotionUpdate} arg.body
+   * @summary: Update existing promotion configuration
+   * @description: Update promotion with id sent in `id`
+   */
+  updatePromotion({ id, body } = {}) {
+    const { error } = CartValidator.updatePromotion().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion/${id}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id -
+   * @param {PromotionPartialUpdate} arg.body
+   * @summary: Update promotion publish state and schedule
+   * @description: Update publish/unpublish and change schedule for promotion
+   */
+  updatePromotionPartially({ id, body } = {}) {
+    const { error } = CartValidator.updatePromotionPartially().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion/${id}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {OpenapiCartDetailsRequest} arg.body
+   * @summary: Fetch Cart Details
+   * @description: Get all the details of cart for a list of provided `cart_items`
+   */
+  fetchAndvalidateCartItems({ body } = {}) {
+    const { error } = CartValidator.fetchAndvalidateCartItems().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/validate`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {OpenApiCartServiceabilityRequest} arg.body
+   * @summary: Check Pincode Serviceability
+   * @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`
+   */
+  checkCartServiceability({ body } = {}) {
+    const { error } = CartValidator.checkCartServiceability().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/serviceability`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {OpenApiPlatformCheckoutReq} arg.body
+   * @summary: Create Fynd order with cart details
+   * @description: Generate Fynd order for cart details send with provided `cart_items`
+   */
+  checkoutCart({ body } = {}) {
+    const { error } = CartValidator.checkoutCart().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/checkout`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] -
+   * @param {number} [arg.pageSize] -
+   * @param {string} [arg.fromDate] -
+   * @param {string} [arg.toDate] -
+   * @param {boolean} [arg.anonymousCart] -
+   * @param {string} [arg.lastId] -
+   * @param {string} [arg.sortOn] -
+   * @summary: Get with abandoned cart list
+   * @description: Get abandoned cart list with pagination
+   */
+  getAbandonedCart({
+    pageNo,
+    pageSize,
+    fromDate,
+    toDate,
+    anonymousCart,
+    lastId,
+    sortOn,
+  } = {}) {
+    const { error } = CartValidator.getAbandonedCart().validate(
+      {
+        pageNo,
+        pageSize,
+        fromDate,
+        toDate,
+        anonymousCart,
+        lastId,
+        sortOn,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["from_date"] = fromDate;
+    query_params["to_date"] = toDate;
+    query_params["anonymous_cart"] = anonymousCart;
+    query_params["last_id"] = lastId;
+    query_params["sort_on"] = sortOn;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/abandoned/carts`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.companyId - Current company id
+   * @param {string} arg.applicationId - Current Application _id
+   * @param {number} [arg.pageSize] -
+   * @param {string} [arg.fromDate] -
+   * @param {string} [arg.toDate] -
+   * @param {boolean} [arg.anonymousCart] -
+   * @param {string} [arg.lastId] -
+   * @param {string} [arg.sortOn] -
+   * @summary: Get with abandoned cart list
+   * @description: Get abandoned cart list with pagination
+   */
+  getAbandonedCartPaginator({
+    companyId,
+    applicationId,
+    pageSize,
+    fromDate,
+    toDate,
+    anonymousCart,
+    lastId,
+    sortOn,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getAbandonedCart({
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        fromDate: fromDate,
+        toDate: toDate,
+        anonymousCart: anonymousCart,
+        lastId: lastId,
+        sortOn: sortOn,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.id] -
+   * @param {boolean} [arg.i] -
+   * @param {boolean} [arg.b] -
+   * @summary: Fetch all items added to the cart
+   * @description: Use this API to get details of all the items added to a cart.
+   */
+  getAbandonedCartDetails({ id, i, b } = {}) {
+    const { error } = CartValidator.getAbandonedCartDetails().validate(
+      {
+        id,
+        i,
+        b,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["id"] = id;
+    query_params["i"] = i;
+    query_params["b"] = b;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/abandoned/cart/detail`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.cartId - Current Cart _id
+   * @param {boolean} [arg.b] -
+   * @param {AddCartRequest} arg.body
+   * @summary: Add items to abandoned cart
+   * @description: Use this API to add items to the abandoned cart.
+   */
+  addItems({ cartId, body, b } = {}) {
+    const { error } = CartValidator.addItems().validate(
+      {
+        cartId,
+        body,
+        b,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["b"] = b;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/abandoned/carts/${cartId}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.cartId - Current Cart _id
+   * @param {boolean} [arg.b] -
+   * @param {UpdateCartRequest} arg.body
+   * @summary: Update items in the abandoned cart
+   * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font>  "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font>   "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font>  item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font>   "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font>  item position in the cart (must be greater than or equal to 0)</li> </ul>
+   */
+  updateCart({ cartId, body, b } = {}) {
+    const { error } = CartValidator.updateCart().validate(
+      {
+        cartId,
+        body,
+        b,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["b"] = b;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/abandoned/carts/${cartId}`,
+      query_params,
+      body
+    );
+  }
+}
+module.exports = Cart;