@gofynd/fdk-client-javascript 1.1.1 → 1.1.3

package/sdk/application/Cart/CartApplicationModel.d.ts

@@ -5,16 +5,20 @@ declare class CartModel {
     static AddCartRequest(): any;
     static AddProductCart(): any;
     static Address(): any;
+    static AppliedFreeArticles(): any;
     static AppliedPromotion(): any;
     static ApplyCouponRequest(): any;
+    static ArticleGiftDetail(): any;
     static ArticlePriceInfo(): any;
     static BaseInfo(): any;
     static BasePrice(): any;
     static BulkPriceOffer(): any;
     static BulkPriceResponse(): any;
+    static BuyRules(): any;
     static CartBreakup(): any;
     static CartCheckoutCustomMeta(): any;
     static CartCheckoutDetailRequest(): any;
+    static CartCheckoutDetailV2Request(): any;
     static CartCheckoutResponse(): any;
     static CartCurrency(): any;
     static CartDetailResponse(): any;
@@ -30,15 +34,22 @@ declare class CartModel {
     static CheckCart(): any;
     static Coupon(): any;
     static CouponBreakup(): any;
+    static CouponDetails(): any;
     static CouponValidity(): any;
     static CurrencyInfo(): any;
+    static CustomerDetails(): any;
     static DeleteAddressResponse(): any;
+    static DeleteCartDetailResponse(): any;
+    static DiscountRulesApp(): any;
     static DisplayBreakup(): any;
+    static FreeGiftItem(): any;
+    static FreeGiftItems(): any;
     static GeoLocation(): any;
     static GetAddressesResponse(): any;
     static GetCouponResponse(): any;
     static GetShareCartLinkRequest(): any;
     static GetShareCartLinkResponse(): any;
+    static GiftDetail(): any;
     static LadderOfferItem(): any;
     static LadderPrice(): any;
     static LadderPriceOffer(): any;
@@ -51,6 +62,8 @@ declare class CartModel {
     static Ownership(): any;
     static PageCoupon(): any;
     static PaymentCouponValidate(): any;
+    static PaymentMeta(): any;
+    static PaymentMethod(): any;
     static PaymentSelectionLock(): any;
     static ProductAction(): any;
     static ProductArticle(): any;
@@ -74,6 +87,8 @@ declare class CartModel {
     static ShipmentPromise(): any;
     static ShipmentResponse(): any;
     static StaffCheckout(): any;
+    static StoreInfo(): any;
+    static Tags(): any;
     static UpdateAddressResponse(): any;
     static UpdateCartDetailResponse(): any;
     static UpdateCartPaymentRequest(): any;

package/sdk/application/Cart/CartApplicationModel.js

@@ -17,6 +17,7 @@ class CartModel {
   static AddCartRequest() {
     return Joi.object({
       items: Joi.array().items(CartModel.AddProductCart()),
+      new_cart: Joi.boolean(),
     });
   }
   static AddProductCart() {
@@ -28,6 +29,7 @@ class CartModel {
       extra_meta: Joi.any(),
       item_id: Joi.number(),
       item_size: Joi.string().allow(""),
+      meta: Joi.any(),
       parent_item_identifiers: Joi.array().items(
         Joi.object().pattern(/\S/, Joi.string().allow(""))
       ),
@@ -40,6 +42,7 @@ class CartModel {
   }
   static Address() {
     return Joi.object({
+      _custom_json: Joi.any(),
       address: Joi.string().allow(""),
       address_type: Joi.string().allow(""),
       area: Joi.string().allow(""),
@@ -51,6 +54,7 @@ class CartModel {
       country_code: Joi.string().allow(""),
       country_iso_code: Joi.string().allow(""),
       country_phone_code: Joi.string().allow(""),
+      created_by_user_id: Joi.string().allow(""),
       email: Joi.string().allow(""),
       geo_location: CartModel.GeoLocation(),
       google_map_point: Joi.any(),
@@ -66,14 +70,27 @@ class CartModel {
       user_id: Joi.string().allow(""),
     });
   }
+  static AppliedFreeArticles() {
+    return Joi.object({
+      article_id: Joi.string().allow(""),
+      free_gift_item_details: CartModel.FreeGiftItem(),
+      parent_item_identifier: Joi.string().allow(""),
+      quantity: Joi.number(),
+    });
+  }
   static AppliedPromotion() {
     return Joi.object({
       amount: Joi.number(),
+      applied_free_articles: Joi.array().items(CartModel.AppliedFreeArticles()),
       article_quantity: Joi.number(),
+      buy_rules: Joi.array().items(CartModel.BuyRules()),
+      discount_rules: Joi.array().items(CartModel.DiscountRulesApp()),
       mrp_promotion: Joi.boolean(),
       offer_text: Joi.string().allow(""),
       ownership: CartModel.Ownership(),
       promo_id: Joi.string().allow(""),
+      promotion_group: Joi.string().allow(""),
+      promotion_name: Joi.string().allow(""),
       promotion_type: Joi.string().allow(""),
     });
   }
@@ -82,6 +99,11 @@ class CartModel {
       coupon_code: Joi.string().allow("").required(),
     });
   }
+  static ArticleGiftDetail() {
+    return Joi.object({
+      article_id: CartModel.GiftDetail(),
+    });
+  }
   static ArticlePriceInfo() {
     return Joi.object({
       base: CartModel.BasePrice(),
@@ -113,6 +135,12 @@ class CartModel {
       data: Joi.array().items(CartModel.BulkPriceOffer()),
     });
   }
+  static BuyRules() {
+    return Joi.object({
+      cart_conditions: Joi.any(),
+      item_criteria: Joi.any(),
+    });
+  }
   static CartBreakup() {
     return Joi.object({
       coupon: CartModel.CouponBreakup(),
@@ -135,10 +163,13 @@ class CartModel {
       billing_address_id: Joi.string().allow(""),
       callback_url: Joi.string().allow("").allow(null),
       custom_meta: Joi.array().items(CartModel.CartCheckoutCustomMeta()),
+      customer_details: CartModel.CustomerDetails(),
       delivery_address: Joi.any(),
       extra_meta: Joi.any(),
+      id: Joi.string().allow("").allow(null),
       merchant_code: Joi.string().allow(""),
       meta: Joi.any(),
+      order_type: Joi.string().allow(""),
       ordering_store: Joi.number().allow(null),
       payment_auto_confirm: Joi.boolean(),
       payment_identifier: Joi.string().allow("").allow(null),
@@ -147,6 +178,31 @@ class CartModel {
       staff: CartModel.StaffCheckout(),
     });
   }
+  static CartCheckoutDetailV2Request() {
+    return Joi.object({
+      address_id: Joi.string().allow(""),
+      aggregator: Joi.string().allow(""),
+      billing_address: Joi.any(),
+      billing_address_id: Joi.string().allow(""),
+      callback_url: Joi.string().allow("").allow(null),
+      cart_id: Joi.string().allow(""),
+      custom_meta: Joi.any(),
+      customer_details: CartModel.CustomerDetails(),
+      delivery_address: Joi.any(),
+      extra_meta: Joi.any(),
+      id: Joi.string().allow("").allow(null),
+      merchant_code: Joi.string().allow(""),
+      meta: Joi.any(),
+      order_type: Joi.string().allow(""),
+      ordering_store: Joi.number().allow(null),
+      payment_auto_confirm: Joi.boolean(),
+      payment_identifier: Joi.string().allow("").allow(null),
+      payment_methods: Joi.array().items(CartModel.PaymentMethod()).required(),
+      payment_mode: Joi.string().allow("").required(),
+      payment_params: Joi.any().allow(null),
+      staff: CartModel.StaffCheckout(),
+    });
+  }
   static CartCheckoutResponse() {
     return Joi.object({
       app_intercept_url: Joi.string().allow(""),
@@ -182,6 +238,8 @@ class CartModel {
       items: Joi.array().items(CartModel.CartProductInfo()),
       last_modified: Joi.string().allow(""),
       message: Joi.string().allow(""),
+      pan_config: Joi.any(),
+      pan_no: Joi.string().allow(""),
       payment_selection_lock: CartModel.PaymentSelectionLock(),
       restrict_checkout: Joi.boolean(),
     });
@@ -200,23 +258,30 @@ class CartModel {
     return Joi.object({
       checkout_mode: Joi.string().allow(""),
       comment: Joi.string().allow(""),
+      delivery_slots: Joi.any(),
+      gift_details: CartModel.ArticleGiftDetail(),
       gstin: Joi.string().allow(""),
       pick_up_customer_details: Joi.any(),
     });
   }
   static CartMetaResponse() {
     return Joi.object({
+      is_valid: Joi.boolean(),
       message: Joi.string().allow(""),
     });
   }
   static CartProduct() {
     return Joi.object({
+      _custom_json: Joi.any(),
       action: CartModel.ProductAction(),
       brand: CartModel.BaseInfo(),
       categories: Joi.array().items(CartModel.CategoryInfo()),
       images: Joi.array().items(CartModel.ProductImage()),
+      item_code: Joi.string().allow("").allow(null),
       name: Joi.string().allow(""),
       slug: Joi.string().allow(""),
+      tags: Joi.array().items(Joi.string().allow("")),
+      teaser_tag: CartModel.Tags(),
       type: Joi.string().allow(""),
       uid: Joi.number(),
     });
@@ -231,7 +296,9 @@ class CartModel {
       article: CartModel.ProductArticle(),
       availability: CartModel.ProductAvailability(),
       bulk_offer: Joi.any(),
+      coupon: CartModel.CouponDetails(),
       coupon_message: Joi.string().allow(""),
+      custom_order: Joi.any(),
       delivery_promise: CartModel.ShipmentPromise(),
       discount: Joi.string().allow(""),
       identifiers: CartModel.CartProductIdentifer().required(),
@@ -313,7 +380,9 @@ class CartModel {
   static Coupon() {
     return Joi.object({
       coupon_code: Joi.string().allow(""),
+      coupon_type: Joi.string().allow("").allow(null),
       coupon_value: Joi.number(),
+      description: Joi.string().allow("").allow(null),
       expires_on: Joi.string().allow(""),
       is_applicable: Joi.boolean(),
       is_applied: Joi.boolean(),
@@ -327,18 +396,33 @@ class CartModel {
   static CouponBreakup() {
     return Joi.object({
       code: Joi.string().allow(""),
+      coupon_type: Joi.string().allow("").allow(null),
+      coupon_value: Joi.number(),
+      description: Joi.string().allow("").allow(null),
       is_applied: Joi.boolean(),
+      max_discount_value: Joi.number(),
       message: Joi.string().allow(""),
+      minimum_cart_value: Joi.number(),
+      sub_title: Joi.string().allow("").allow(null),
+      title: Joi.string().allow("").allow(null),
       type: Joi.string().allow(""),
       uid: Joi.string().allow(""),
       value: Joi.number(),
     });
   }
+  static CouponDetails() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      discount_single_quantity: Joi.number(),
+      discount_total_quantity: Joi.number(),
+    });
+  }
   static CouponValidity() {
     return Joi.object({
       code: Joi.string().allow("").allow(null),
       discount: Joi.number(),
       display_message_en: Joi.string().allow("").allow(null),
+      next_validation_required: Joi.boolean().allow(null),
       title: Joi.string().allow(""),
       valid: Joi.boolean(),
     });
@@ -349,12 +433,33 @@ class CartModel {
       symbol: Joi.string().allow(""),
     });
   }
+  static CustomerDetails() {
+    return Joi.object({
+      email: Joi.string().allow("").allow(null),
+      mobile: Joi.string().allow("").required(),
+      name: Joi.string().allow(""),
+    });
+  }
   static DeleteAddressResponse() {
     return Joi.object({
       id: Joi.string().allow(""),
       is_deleted: Joi.boolean(),
     });
   }
+  static DeleteCartDetailResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+      success: Joi.boolean(),
+    });
+  }
+  static DiscountRulesApp() {
+    return Joi.object({
+      item_criteria: Joi.any(),
+      matched_buy_rules: Joi.array().items(Joi.string().allow("")),
+      offer: Joi.any(),
+      raw_offer: Joi.any(),
+    });
+  }
   static DisplayBreakup() {
     return Joi.object({
       currency_code: Joi.string().allow(""),
@@ -365,6 +470,26 @@ class CartModel {
       value: Joi.number(),
     });
   }
+  static FreeGiftItem() {
+    return Joi.object({
+      item_brand_name: Joi.string().allow(""),
+      item_id: Joi.number(),
+      item_images_url: Joi.array().items(Joi.string().allow("")),
+      item_name: Joi.string().allow(""),
+      item_price_details: Joi.any(),
+      item_slug: Joi.string().allow(""),
+    });
+  }
+  static FreeGiftItems() {
+    return Joi.object({
+      item_brand_name: Joi.string().allow(""),
+      item_id: Joi.number(),
+      item_images_url: Joi.array().items(Joi.string().allow("")),
+      item_name: Joi.string().allow(""),
+      item_price_details: Joi.any(),
+      item_slug: Joi.string().allow(""),
+    });
+  }
   static GeoLocation() {
     return Joi.object({
       latitude: Joi.number(),
@@ -395,6 +520,12 @@ class CartModel {
       token: Joi.string().allow(""),
     });
   }
+  static GiftDetail() {
+    return Joi.object({
+      gift_message: Joi.string().allow(""),
+      is_gift_applied: Joi.boolean(),
+    });
+  }
   static LadderOfferItem() {
     return Joi.object({
       margin: Joi.number(),
@@ -415,7 +546,11 @@ class CartModel {
   }
   static LadderPriceOffer() {
     return Joi.object({
+      buy_rules: Joi.any(),
+      calculate_on: Joi.string().allow(""),
       description: Joi.string().allow(""),
+      discount_rules: Joi.array().items(Joi.any()),
+      free_gift_items: Joi.array().items(CartModel.FreeGiftItems()),
       id: Joi.string().allow(""),
       offer_prices: Joi.array().items(CartModel.LadderOfferItem()),
       offer_text: Joi.string().allow(""),
@@ -491,6 +626,23 @@ class CartModel {
       success: Joi.boolean().required(),
     });
   }
+  static PaymentMeta() {
+    return Joi.object({
+      merchant_code: Joi.string().allow(""),
+      payment_gateway: Joi.string().allow(""),
+      payment_identifier: Joi.string().allow("").allow(null),
+      type: Joi.string().allow(""),
+    });
+  }
+  static PaymentMethod() {
+    return Joi.object({
+      amount: Joi.number().allow(null),
+      mode: Joi.string().allow("").required(),
+      name: Joi.string().allow(""),
+      payment: Joi.string().allow(""),
+      payment_meta: CartModel.PaymentMeta().required(),
+    });
+  }
   static PaymentSelectionLock() {
     return Joi.object({
       default_options: Joi.string().allow(""),
@@ -508,14 +660,21 @@ class CartModel {
   static ProductArticle() {
     return Joi.object({
       _custom_json: Joi.any(),
+      cart_item_meta: Joi.any(),
       extra_meta: Joi.any(),
+      gift_card: Joi.any(),
+      identifier: Joi.any(),
+      is_gift_visible: Joi.boolean(),
+      meta: Joi.any(),
+      mto_quantity: Joi.number(),
       parent_item_identifiers: Joi.any(),
       price: CartModel.ArticlePriceInfo(),
       product_group_tags: Joi.array().items(Joi.string().allow("")),
       quantity: Joi.number(),
       seller: CartModel.BaseInfo(),
+      seller_identifier: Joi.string().allow(""),
       size: Joi.string().allow(""),
-      store: CartModel.BaseInfo(),
+      store: CartModel.StoreInfo(),
       type: Joi.string().allow(""),
       uid: Joi.string().allow(""),
     });
@@ -579,7 +738,10 @@ class CartModel {
   }
   static PromotionOffer() {
     return Joi.object({
+      buy_rules: Joi.any(),
       description: Joi.string().allow(""),
+      discount_rules: Joi.array().items(Joi.any()),
+      free_gift_items: Joi.array().items(CartModel.FreeGiftItems()),
       id: Joi.string().allow(""),
       offer_text: Joi.string().allow(""),
       promotion_group: Joi.string().allow(""),
@@ -599,6 +761,7 @@ class CartModel {
       delivery_charge: Joi.number(),
       discount: Joi.number(),
       fynd_cash: Joi.number(),
+      gift_card: Joi.number(),
       gst_charges: Joi.number(),
       mrp_total: Joi.number(),
       subtotal: Joi.number(),
@@ -693,6 +856,18 @@ class CartModel {
       user: Joi.string().allow("").required(),
     });
   }
+  static StoreInfo() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      store_code: Joi.string().allow(""),
+      uid: Joi.number(),
+    });
+  }
+  static Tags() {
+    return Joi.object({
+      tags: Joi.any(),
+    });
+  }
   static UpdateAddressResponse() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -733,6 +908,7 @@ class CartModel {
       item_id: Joi.number(),
       item_index: Joi.number(),
       item_size: Joi.string().allow(""),
+      meta: Joi.any(),
       parent_item_identifiers: Joi.any(),
       quantity: Joi.number(),
     });

package/sdk/application/Cart/CartApplicationValidator.d.ts

@@ -5,6 +5,8 @@ declare class CartValidator {
     static applyCoupon(): any;
     static applyRewardPoints(): any;
     static checkoutCart(): any;
+    static checkoutCartV2(): any;
+    static deleteCart(): any;
     static getAddressById(): any;
     static getAddresses(): any;
     static getBulkDiscountOffers(): any;

package/sdk/application/Cart/CartApplicationValidator.js

@@ -14,6 +14,7 @@ class CartValidator {
       b: Joi.boolean(),
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      id: Joi.string().allow(""),
       body: CartModel.AddCartRequest().required(),
     }).required();
   }
@@ -46,6 +47,19 @@ class CartValidator {
     }).required();
   }
 
+  static checkoutCartV2() {
+    return Joi.object({
+      buyNow: Joi.boolean(),
+      body: CartModel.CartCheckoutDetailV2Request().required(),
+    }).required();
+  }
+
+  static deleteCart() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+    });
+  }
+
   static getAddressById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -135,6 +149,7 @@ class CartValidator {
       slug: Joi.string().allow(""),
       pageSize: Joi.number(),
       promotionGroup: Joi.string().allow(""),
+      storeId: Joi.number(),
     });
   }
 
@@ -145,6 +160,7 @@ class CartValidator {
       buyNow: Joi.boolean(),
       addressId: Joi.string().allow(""),
       areaCode: Joi.string().allow(""),
+      orderType: Joi.string().allow(""),
     });
   }
 
@@ -221,6 +237,10 @@ class CartValidator {
       paymentIdentifier: Joi.string().allow(""),
       aggregatorName: Joi.string().allow(""),
       merchantCode: Joi.string().allow(""),
+      iin: Joi.string().allow(""),
+      network: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      cardId: Joi.string().allow(""),
     });
   }
 }

package/sdk/application/Catalog/CatalogApplicationClient.d.ts

@@ -139,6 +139,8 @@ declare class Catalog {
      *   will be passed in f parameter as shown in the example below. Double
      *   Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
      *   indicates a new filter paramater applied as an AND condition.
+     * @param {string} [arg.q] - The search query for entering partial or full
+     *   name of product, brand, category, or collection.
      * @param {boolean} [arg.filters] - This is a boolean value, True for
      *   fetching all filter parameters and False for disabling the filter parameters.
      * @param {string} [arg.sortOn] - The order in which the list of products
@@ -153,9 +155,10 @@ declare class Catalog {
      * @summary: Get the items in a collection
      * @description: Get items in a collection specified by its `slug`.
      */
-    getCollectionItemsBySlug({ slug, f, filters, sortOn, pageId, pageSize, pageNo, pageType, }?: {
+    getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, }?: {
         slug: string;
         f?: string;
+        q?: string;
         filters?: boolean;
         sortOn?: string;
         pageId?: string;
@@ -172,6 +175,8 @@ declare class Catalog {
      *   will be passed in f parameter as shown in the example below. Double
      *   Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
      *   indicates a new filter paramater applied as an AND condition.
+     * @param {string} [arg.q] - The search query for entering partial or full
+     *   name of product, brand, category, or collection.
      * @param {boolean} [arg.filters] - This is a boolean value, True for
      *   fetching all filter parameters and False for disabling the filter parameters.
      * @param {string} [arg.sortOn] - The order in which the list of products
@@ -181,9 +186,10 @@ declare class Catalog {
      * @summary: Get the items in a collection
      * @description: Get items in a collection specified by its `slug`.
      */
-    getCollectionItemsBySlugPaginator({ slug, f, filters, sortOn, pageSize, }?: {
+    getCollectionItemsBySlugPaginator({ slug, f, q, filters, sortOn, pageSize, }?: {
         slug: string;
         f?: string;
+        q?: string;
         filters?: boolean;
         sortOn?: string;
         pageSize?: number;
@@ -194,25 +200,29 @@ declare class Catalog {
      *   given set of results.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
      * @param {string[]} [arg.tag] - List of tags to filter collections
+     * @param {string} [arg.q] - Name of the collection to filter collection
      * @returns {Promise<GetCollectionListingResponse>} - Success response
      * @summary: List all the collections
      * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
      */
-    getCollections({ pageNo, pageSize, tag }?: {
+    getCollections({ pageNo, pageSize, tag, q }?: {
         pageNo?: number;
         pageSize?: number;
         tag?: string[];
+        q?: string;
     }): Promise<GetCollectionListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
      * @param {string[]} [arg.tag] - List of tags to filter collections
+     * @param {string} [arg.q] - Name of the collection to filter collection
      * @summary: List all the collections
      * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
      */
-    getCollectionsPaginator({ pageSize, tag }?: {
+    getCollectionsPaginator({ pageSize, tag, q }?: {
         pageSize?: number;
         tag?: string[];
+        q?: string;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.