@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,15 +1,15 @@
 export = BillingValidator;
 declare class BillingValidator {
+    static activateSubscriptionPlan(): any;
+    static cancelSubscriptionCharge(): any;
+    static cancelSubscriptionPlan(): any;
     static checkCouponValidity(): any;
     static createSubscriptionCharge(): any;
-    static getSubscriptionCharge(): any;
-    static cancelSubscriptionCharge(): any;
-    static getInvoices(): any;
-    static getInvoiceById(): any;
     static getCustomerDetail(): any;
-    static upsertCustomerDetail(): any;
-    static getSubscription(): any;
     static getFeatureLimitConfig(): any;
-    static activateSubscriptionPlan(): any;
-    static cancelSubscriptionPlan(): any;
+    static getInvoiceById(): any;
+    static getInvoices(): any;
+    static getSubscription(): any;
+    static getSubscriptionCharge(): any;
+    static upsertCustomerDetail(): any;
 }

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -2,41 +2,36 @@ const Joi = require("joi");
 
 const BillingModel = require("./BillingPlatformModel");
 class BillingValidator {
-  static checkCouponValidity() {
+  static activateSubscriptionPlan() {
     return Joi.object({
-      plan: Joi.string().allow("").required(),
-      couponCode: Joi.string().allow("").required(),
+      body: BillingModel.SubscriptionActivateReq().required(),
     }).required();
   }
 
-  static createSubscriptionCharge() {
+  static cancelSubscriptionCharge() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: BillingModel.CreateSubscriptionCharge().required(),
+      subscriptionId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getSubscriptionCharge() {
+  static cancelSubscriptionPlan() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      subscriptionId: Joi.string().allow("").required(),
+      body: BillingModel.CancelSubscriptionReq().required(),
     }).required();
   }
 
-  static cancelSubscriptionCharge() {
+  static checkCouponValidity() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      subscriptionId: Joi.string().allow("").required(),
+      plan: Joi.string().allow("").required(),
+      couponCode: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getInvoices() {
-    return Joi.object({}).required();
-  }
-
-  static getInvoiceById() {
+  static createSubscriptionCharge() {
     return Joi.object({
-      invoiceId: Joi.string().allow("").required(),
+      extensionId: Joi.string().allow("").required(),
+      body: BillingModel.CreateSubscriptionCharge().required(),
     }).required();
   }
 
@@ -44,29 +39,34 @@ class BillingValidator {
     return Joi.object({}).required();
   }
 
-  static upsertCustomerDetail() {
+  static getFeatureLimitConfig() {
+    return Joi.object({}).required();
+  }
+
+  static getInvoiceById() {
     return Joi.object({
-      body: BillingModel.SubscriptionCustomerCreate().required(),
+      invoiceId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getSubscription() {
+  static getInvoices() {
     return Joi.object({}).required();
   }
 
-  static getFeatureLimitConfig() {
+  static getSubscription() {
     return Joi.object({}).required();
   }
 
-  static activateSubscriptionPlan() {
+  static getSubscriptionCharge() {
     return Joi.object({
-      body: BillingModel.SubscriptionActivateReq().required(),
+      extensionId: Joi.string().allow("").required(),
+      subscriptionId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static cancelSubscriptionPlan() {
+  static upsertCustomerDetail() {
     return Joi.object({
-      body: BillingModel.CancelSubscriptionReq().required(),
+      body: BillingModel.SubscriptionCustomerCreate().required(),
     }).required();
   }
 }

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

@@ -3,6 +3,139 @@ declare class Cart {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.cartId - Current Cart _id
+     * @param {boolean} [arg.b] -
+     * @param {AddCartRequest} arg.body
+     * @returns {Promise<AddCartDetailResponse>} - Success response
+     * @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<AddCartDetailResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OpenApiCartServiceabilityRequest} arg.body
+     * @returns {Promise<OpenApiCartServiceabilityResponse>} - Success response
+     * @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<OpenApiCartServiceabilityResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OpenApiPlatformCheckoutReq} arg.body
+     * @returns {Promise<OpenApiCheckoutResponse>} - Success response
+     * @summary: Create Fynd order with cart details
+     * @description: Generate Fynd order for cart details send with provided `cart_items`
+     */
+    checkoutCart({ body }?: {
+        body: OpenApiPlatformCheckoutReq;
+    }): Promise<OpenApiCheckoutResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CouponAdd} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
+     * @summary: Create new coupon
+     * @description: Create new coupon
+     */
+    createCoupon({ body }?: {
+        body: CouponAdd;
+    }): Promise<SuccessMessage>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PromotionAdd} arg.body
+     * @returns {Promise<PromotionAdd>} - Success response
+     * @summary: Create new promotion
+     * @description: Create new promotion
+     */
+    createPromotion({ body }?: {
+        body: PromotionAdd;
+    }): Promise<PromotionAdd>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OpenapiCartDetailsRequest} arg.body
+     * @returns {Promise<OpenapiCartDetailsResponse>} - Success response
+     * @summary: Fetch Cart Details
+     * @description: Get all the details of cart for a list of provided `cart_items`
+     */
+    fetchAndvalidateCartItems({ body }?: {
+        body: OpenapiCartDetailsRequest;
+    }): Promise<OpenapiCartDetailsResponse>;
+    /**
+     * @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] -
+     * @returns {Promise<AbandonedCartResponse>} - Success response
+     * @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<AbandonedCartResponse>;
+    /**
+     * @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] -
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @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<CartDetailResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id -
+     * @returns {Promise<CouponUpdate>} - Success response
+     * @summary: Get with single coupon details or coupon list
+     * @description: Get single coupon details with `id` in path param
+     */
+    getCouponById({ id }?: {
+        id: string;
+    }): Promise<CouponUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -13,6 +146,7 @@ declare class Cart {
      * @param {boolean} [arg.isDisplay] -
      * @param {string} [arg.typeSlug] -
      * @param {string} [arg.code] -
+     * @returns {Promise<CouponsResponse>} - Success response
      * @summary: Get with single coupon details or coupon list
      * @description: Get coupon list with pagination
      */
@@ -25,7 +159,7 @@ declare class Cart {
         isDisplay?: boolean;
         typeSlug?: string;
         code?: string;
-    }): Promise<any>;
+    }): Promise<CouponsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -51,46 +185,16 @@ declare class Cart {
         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
+     * @returns {Promise<PromotionUpdate>} - Success response
+     * @summary: Get with single promotion details or promotion list
+     * @description: Get single promotion details with `id` in path param
      */
-    updateCouponPartially({ id, body }?: {
+    getPromotionById({ id }?: {
         id: string;
-        body: CouponPartialUpdate;
-    }): Promise<any>;
+    }): Promise<PromotionUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -101,6 +205,7 @@ declare class Cart {
      * @param {string} [arg.promotionType] -
      * @param {string} [arg.fpPanel] -
      * @param {string} [arg.promotionId] -
+     * @returns {Promise<PromotionsResponse>} - Success response
      * @summary: Get promotion list
      * @description: Get promotion list with pagination
      */
@@ -113,7 +218,7 @@ declare class Cart {
         promotionType?: string;
         fpPanel?: string;
         promotionId?: string;
-    }): Promise<any>;
+    }): Promise<PromotionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -141,153 +246,65 @@ declare class Cart {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {PromotionAdd} arg.body
-     * @summary: Create new promotion
-     * @description: Create new promotion
+     * @param {string} arg.cartId - Current Cart _id
+     * @param {boolean} [arg.b] -
+     * @param {UpdateCartRequest} arg.body
+     * @returns {Promise<UpdateCartDetailResponse>} - Success response
+     * @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>
      */
-    createPromotion({ body }?: {
-        body: PromotionAdd;
-    }): Promise<any>;
+    updateCart({ cartId, body, b }?: {
+        cartId: string;
+        b?: boolean;
+        body: UpdateCartRequest;
+    }): Promise<UpdateCartDetailResponse>;
     /**
      * @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
+     * @param {CouponUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
+     * @summary: Update existing coupon configuration
+     * @description: Update coupon with id sent in `id`
      */
-    getPromotionById({ id }?: {
+    updateCoupon({ id, body }?: {
         id: string;
-    }): Promise<any>;
+        body: CouponUpdate;
+    }): Promise<SuccessMessage>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id -
+     * @param {CouponPartialUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
+     * @summary: Update coupon archive state and schedule
+     * @description: Update archive/unarchive and change schedule for coupon
+     */
+    updateCouponPartially({ id, body }?: {
+        id: string;
+        body: CouponPartialUpdate;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {PromotionUpdate} arg.body
+     * @returns {Promise<PromotionUpdate>} - Success response
      * @summary: Update existing promotion configuration
      * @description: Update promotion with id sent in `id`
      */
     updatePromotion({ id, body }?: {
         id: string;
         body: PromotionUpdate;
-    }): Promise<any>;
+    }): Promise<PromotionUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {PromotionPartialUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
      * @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>;
+    }): Promise<SuccessMessage>;
 }
 import Paginator = require("../../common/Paginator");