@gofynd/fdk-client-javascript 0.1.37 → 1.0.0

package/sdk/platform/{models/BillingValidator.js → Billing/BillingPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const BillingModel = require("./BillingPlatformModel");
 class BillingValidator {
   static checkCouponValidity() {
     return Joi.object({
@@ -11,7 +12,7 @@ class BillingValidator {
   static createSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: Validator.CreateSubscriptionCharge().required(),
+      body: BillingModel.CreateSubscriptionCharge().required(),
     }).required();
   }
 
@@ -45,7 +46,7 @@ class BillingValidator {
 
   static upsertCustomerDetail() {
     return Joi.object({
-      body: Validator.SubscriptionCustomerCreate().required(),
+      body: BillingModel.SubscriptionCustomerCreate().required(),
     }).required();
   }
 
@@ -59,13 +60,13 @@ class BillingValidator {
 
   static activateSubscriptionPlan() {
     return Joi.object({
-      body: Validator.SubscriptionActivateReq().required(),
+      body: BillingModel.SubscriptionActivateReq().required(),
     }).required();
   }
 
   static cancelSubscriptionPlan() {
     return Joi.object({
-      body: Validator.CancelSubscriptionReq().required(),
+      body: BillingModel.CancelSubscriptionReq().required(),
     }).required();
   }
 }

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

@@ -0,0 +1,293 @@
+export = Cart;
+declare class Cart {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @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, }?: {
+        pageNo?: number;
+        pageSize?: number;
+        isArchived?: boolean;
+        title?: string;
+        isPublic?: boolean;
+        isDisplay?: boolean;
+        typeSlug?: string;
+        code?: string;
+    }): Promise<any>;
+    /**
+     * @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, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        isArchived?: boolean;
+        title?: string;
+        isPublic?: boolean;
+        isDisplay?: boolean;
+        typeSlug?: string;
+        code?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CouponAdd} arg.body
+     * @summary: Create new coupon
+     * @description: Create new coupon
+     */
+    createCoupon({ body }?: {
+        body: CouponAdd;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+        body: CouponUpdate;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+        body: CouponPartialUpdate;
+    }): Promise<any>;
+    /**
+     * @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, }?: {
+        pageNo?: number;
+        pageSize?: number;
+        q?: string;
+        isActive?: boolean;
+        promoGroup?: string;
+        promotionType?: string;
+        fpPanel?: string;
+        promotionId?: string;
+    }): Promise<any>;
+    /**
+     * @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, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        q?: string;
+        isActive?: boolean;
+        promoGroup?: string;
+        promotionType?: string;
+        fpPanel?: string;
+        promotionId?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PromotionAdd} arg.body
+     * @summary: Create new promotion
+     * @description: Create new promotion
+     */
+    createPromotion({ body }?: {
+        body: PromotionAdd;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+        body: PromotionUpdate;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        id: string;
+        body: PromotionPartialUpdate;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        body: OpenapiCartDetailsRequest;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        body: OpenApiCartServiceabilityRequest;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        body: OpenApiPlatformCheckoutReq;
+    }): Promise<any>;
+    /**
+     * @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, }?: {
+        pageNo?: number;
+        pageSize?: number;
+        fromDate?: string;
+        toDate?: string;
+        anonymousCart?: boolean;
+        lastId?: string;
+        sortOn?: string;
+    }): Promise<any>;
+    /**
+     * @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, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        fromDate?: string;
+        toDate?: string;
+        anonymousCart?: boolean;
+        lastId?: string;
+        sortOn?: string;
+    }): 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 }?: {
+        id?: string;
+        i?: boolean;
+        b?: boolean;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        cartId: string;
+        b?: boolean;
+        body: AddCartRequest;
+    }): Promise<any>;
+    /**
+     * @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 }?: {
+        cartId: string;
+        b?: boolean;
+        body: UpdateCartRequest;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");