@gofynd/fdk-client-javascript 1.1.2 → 1.1.3

package/sdk/application/PosCart/PosCartApplicationClient.js

@@ -128,14 +128,15 @@ class PosCart {
    * @param {boolean} [arg.b] -
    * @param {string} [arg.areaCode] -
    * @param {boolean} [arg.buyNow] -
+   * @param {string} [arg.id] -
    * @param {AddCartRequest} arg.body
    * @returns {Promise<AddCartDetailResponse>} - Success response
    * @summary: Add items to cart
    * @description: Use this API to add items to the cart.
    */
-  async addItems({ body, i, b, areaCode, buyNow } = {}) {
+  async addItems({ body, i, b, areaCode, buyNow, id } = {}) {
     const { error } = PosCartValidator.addItems().validate(
-      { body, i, b, areaCode, buyNow },
+      { body, i, b, areaCode, buyNow, id },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -144,7 +145,7 @@ class PosCart {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = PosCartValidator.addItems().validate(
-      { body, i, b, areaCode, buyNow },
+      { body, i, b, areaCode, buyNow, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -160,6 +161,7 @@ class PosCart {
     query_params["b"] = b;
     query_params["area_code"] = areaCode;
     query_params["buy_now"] = buyNow;
+    query_params["id"] = id;
 
     const xHeaders = {};
 
@@ -1815,6 +1817,8 @@ class PosCart {
    *   getting a payment option in response.
    * @param {string} [arg.id] - The unique identifier of the cart
    * @param {string} [arg.addressId] - ID allotted to an address
+   * @param {string} [arg.areaCode] - The PIN Code of the destination address,
+   *   e.g. 400059
    * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
    *   - If the customer wants the order home-delivered PickAtStore - If the
    *   customer wants the handover of an order at the store itself.
@@ -1823,9 +1827,17 @@ class PosCart {
    * @summary: Update shipment delivery type and quantity before checkout
    * @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.
    */
-  async updateShipments({ body, i, p, id, addressId, orderType } = {}) {
+  async updateShipments({
+    body,
+    i,
+    p,
+    id,
+    addressId,
+    areaCode,
+    orderType,
+  } = {}) {
     const { error } = PosCartValidator.updateShipments().validate(
-      { body, i, p, id, addressId, orderType },
+      { body, i, p, id, addressId, areaCode, orderType },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -1834,7 +1846,7 @@ class PosCart {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = PosCartValidator.updateShipments().validate(
-      { body, i, p, id, addressId, orderType },
+      { body, i, p, id, addressId, areaCode, orderType },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -1850,6 +1862,7 @@ class PosCart {
     query_params["p"] = p;
     query_params["id"] = id;
     query_params["address_id"] = addressId;
+    query_params["area_code"] = areaCode;
     query_params["order_type"] = orderType;
 
     const xHeaders = {};
@@ -1893,6 +1906,10 @@ class PosCart {
    * @param {string} [arg.paymentIdentifier] -
    * @param {string} [arg.aggregatorName] -
    * @param {string} [arg.merchantCode] -
+   * @param {string} [arg.iin] -
+   * @param {string} [arg.network] -
+   * @param {string} [arg.type] -
+   * @param {string} [arg.cardId] -
    * @returns {Promise<PaymentCouponValidate>} - Success response
    * @summary: Verify the coupon eligibility against the payment mode
    * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
@@ -1905,6 +1922,10 @@ class PosCart {
     paymentIdentifier,
     aggregatorName,
     merchantCode,
+    iin,
+    network,
+    type,
+    cardId,
   } = {}) {
     const { error } = PosCartValidator.validateCouponForPayment().validate(
       {
@@ -1915,6 +1936,10 @@ class PosCart {
         paymentIdentifier,
         aggregatorName,
         merchantCode,
+        iin,
+        network,
+        type,
+        cardId,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -1934,6 +1959,10 @@ class PosCart {
         paymentIdentifier,
         aggregatorName,
         merchantCode,
+        iin,
+        network,
+        type,
+        cardId,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -1953,6 +1982,10 @@ class PosCart {
     query_params["payment_identifier"] = paymentIdentifier;
     query_params["aggregator_name"] = aggregatorName;
     query_params["merchant_code"] = merchantCode;
+    query_params["iin"] = iin;
+    query_params["network"] = network;
+    query_params["type"] = type;
+    query_params["card_id"] = cardId;
 
     const xHeaders = {};
 

package/sdk/application/PosCart/PosCartApplicationModel.d.ts

@@ -8,6 +8,7 @@ declare class PosCartModel {
     static AppliedFreeArticles(): any;
     static AppliedPromotion(): any;
     static ApplyCouponRequest(): any;
+    static ArticleGiftDetail(): any;
     static ArticlePriceInfo(): any;
     static BaseInfo(): any;
     static BasePrice(): any;
@@ -33,7 +34,9 @@ declare class PosCartModel {
     static CheckCart(): any;
     static Coupon(): any;
     static CouponBreakup(): any;
+    static CouponDetails(): any;
     static CouponValidity(): any;
+    static CustomerDetails(): any;
     static DeleteAddressResponse(): any;
     static DiscountRulesApp(): any;
     static DisplayBreakup(): any;
@@ -44,6 +47,7 @@ declare class PosCartModel {
     static GetCouponResponse(): any;
     static GetShareCartLinkRequest(): any;
     static GetShareCartLinkResponse(): any;
+    static GiftDetail(): any;
     static LoyaltyPoints(): any;
     static OfferItem(): any;
     static OfferPrice(): any;
@@ -74,6 +78,8 @@ declare class PosCartModel {
     static ShipmentResponse(): any;
     static StaffCheckout(): any;
     static StoreDetailsResponse(): any;
+    static StoreInfo(): any;
+    static Tags(): any;
     static UpdateAddressResponse(): any;
     static UpdateCartDetailResponse(): any;
     static UpdateCartPaymentRequest(): any;

package/sdk/application/PosCart/PosCartApplicationModel.js

@@ -17,6 +17,7 @@ class PosCartModel {
   static AddCartRequest() {
     return Joi.object({
       items: Joi.array().items(PosCartModel.AddProductCart()),
+      new_cart: Joi.boolean(),
     });
   }
   static AddProductCart() {
@@ -28,6 +29,7 @@ class PosCartModel {
       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 PosCartModel {
   }
   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 PosCartModel {
       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: PosCartModel.GeoLocation(),
       google_map_point: Joi.any(),
@@ -97,6 +101,11 @@ class PosCartModel {
       coupon_code: Joi.string().allow("").required(),
     });
   }
+  static ArticleGiftDetail() {
+    return Joi.object({
+      article_id: PosCartModel.GiftDetail(),
+    });
+  }
   static ArticlePriceInfo() {
     return Joi.object({
       base: PosCartModel.BasePrice(),
@@ -189,6 +198,8 @@ class PosCartModel {
       items: Joi.array().items(PosCartModel.CartProductInfo()),
       last_modified: Joi.string().allow(""),
       message: Joi.string().allow(""),
+      pan_config: Joi.any(),
+      pan_no: Joi.string().allow(""),
       payment_selection_lock: PosCartModel.PaymentSelectionLock(),
       restrict_checkout: Joi.boolean(),
     });
@@ -207,12 +218,15 @@ class PosCartModel {
     return Joi.object({
       checkout_mode: Joi.string().allow(""),
       comment: Joi.string().allow(""),
+      delivery_slots: Joi.any(),
+      gift_details: PosCartModel.ArticleGiftDetail(),
       gstin: Joi.string().allow(""),
       pick_up_customer_details: Joi.any(),
     });
   }
   static CartMetaResponse() {
     return Joi.object({
+      is_valid: Joi.boolean(),
       message: Joi.string().allow(""),
     });
   }
@@ -224,9 +238,11 @@ class PosCartModel {
       billing_address_id: Joi.string().allow(""),
       callback_url: Joi.string().allow("").allow(null),
       custom_meta: Joi.array().items(PosCartModel.CartCheckoutCustomMeta()),
+      customer_details: PosCartModel.CustomerDetails(),
       delivery_address: Joi.any(),
       extra_meta: Joi.any(),
       files: Joi.array().items(PosCartModel.Files()),
+      id: Joi.string().allow("").allow(null),
       merchant_code: Joi.string().allow(""),
       meta: Joi.any(),
       order_type: Joi.string().allow("").required(),
@@ -242,12 +258,16 @@ class PosCartModel {
   }
   static CartProduct() {
     return Joi.object({
+      _custom_json: Joi.any(),
       action: PosCartModel.ProductAction(),
       brand: PosCartModel.BaseInfo(),
       categories: Joi.array().items(PosCartModel.CategoryInfo()),
       images: Joi.array().items(PosCartModel.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: PosCartModel.Tags(),
       type: Joi.string().allow(""),
       uid: Joi.number(),
     });
@@ -262,7 +282,9 @@ class PosCartModel {
       article: PosCartModel.ProductArticle(),
       availability: PosCartModel.ProductAvailability(),
       bulk_offer: Joi.any(),
+      coupon: PosCartModel.CouponDetails(),
       coupon_message: Joi.string().allow(""),
+      custom_order: Joi.any(),
       delivery_promise: PosCartModel.ShipmentPromise(),
       discount: Joi.string().allow(""),
       identifiers: PosCartModel.CartProductIdentifer().required(),
@@ -374,15 +396,30 @@ class PosCartModel {
       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(),
     });
   }
+  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(""),
@@ -453,6 +490,12 @@ class PosCartModel {
       token: Joi.string().allow(""),
     });
   }
+  static GiftDetail() {
+    return Joi.object({
+      gift_message: Joi.string().allow(""),
+      is_gift_applied: Joi.boolean(),
+    });
+  }
   static LoyaltyPoints() {
     return Joi.object({
       applicable: Joi.number(),
@@ -546,8 +589,13 @@ class PosCartModel {
   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: PosCartModel.ArticlePriceInfo(),
       product_group_tags: Joi.array().items(Joi.string().allow("")),
@@ -555,7 +603,7 @@ class PosCartModel {
       seller: PosCartModel.BaseInfo(),
       seller_identifier: Joi.string().allow(""),
       size: Joi.string().allow(""),
-      store: PosCartModel.BaseInfo(),
+      store: PosCartModel.StoreInfo(),
       type: Joi.string().allow(""),
       uid: Joi.string().allow(""),
     });
@@ -627,6 +675,7 @@ class PosCartModel {
       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(),
@@ -726,6 +775,18 @@ class PosCartModel {
       items: Joi.array().items(PosCartModel.PickupStoreDetail()),
     });
   }
+  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(""),
@@ -780,6 +841,7 @@ class PosCartModel {
       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/PosCart/PosCartApplicationValidator.js

@@ -14,6 +14,7 @@ class PosCartValidator {
       b: Joi.boolean(),
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      id: Joi.string().allow(""),
       body: PosCartModel.AddCartRequest().required(),
     }).required();
   }
@@ -216,6 +217,7 @@ class PosCartValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       addressId: Joi.string().allow(""),
+      areaCode: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
       body: PosCartModel.UpdateCartShipmentRequest().required(),
     }).required();
@@ -230,6 +232,10 @@ class PosCartValidator {
       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/index.d.ts

@@ -1,20 +1,20 @@
 export const ApplicationConfig: typeof import("./ApplicationConfig");
 export const ApplicationClient: typeof import("./ApplicationClient");
 export namespace ApplicationModel {
-    const CatalogApplicationModel: typeof import("./Catalog/CatalogApplicationModel");
     const CartApplicationModel: typeof import("./Cart/CartApplicationModel");
+    const CatalogApplicationModel: typeof import("./Catalog/CatalogApplicationModel");
     const CommonApplicationModel: typeof import("./Common/CommonApplicationModel");
-    const LeadApplicationModel: typeof import("./Lead/LeadApplicationModel");
-    const ThemeApplicationModel: typeof import("./Theme/ThemeApplicationModel");
-    const UserApplicationModel: typeof import("./User/UserApplicationModel");
-    const ContentApplicationModel: typeof import("./Content/ContentApplicationModel");
     const CommunicationApplicationModel: typeof import("./Communication/CommunicationApplicationModel");
-    const ShareApplicationModel: typeof import("./Share/ShareApplicationModel");
-    const FileStorageApplicationModel: typeof import("./FileStorage/FileStorageApplicationModel");
     const ConfigurationApplicationModel: typeof import("./Configuration/ConfigurationApplicationModel");
-    const PaymentApplicationModel: typeof import("./Payment/PaymentApplicationModel");
+    const ContentApplicationModel: typeof import("./Content/ContentApplicationModel");
+    const FileStorageApplicationModel: typeof import("./FileStorage/FileStorageApplicationModel");
+    const LeadApplicationModel: typeof import("./Lead/LeadApplicationModel");
+    const LogisticApplicationModel: typeof import("./Logistic/LogisticApplicationModel");
     const OrderApplicationModel: typeof import("./Order/OrderApplicationModel");
-    const RewardsApplicationModel: typeof import("./Rewards/RewardsApplicationModel");
+    const PaymentApplicationModel: typeof import("./Payment/PaymentApplicationModel");
     const PosCartApplicationModel: typeof import("./PosCart/PosCartApplicationModel");
-    const LogisticApplicationModel: typeof import("./Logistic/LogisticApplicationModel");
+    const RewardsApplicationModel: typeof import("./Rewards/RewardsApplicationModel");
+    const ShareApplicationModel: typeof import("./Share/ShareApplicationModel");
+    const ThemeApplicationModel: typeof import("./Theme/ThemeApplicationModel");
+    const UserApplicationModel: typeof import("./User/UserApplicationModel");
 }

package/sdk/application/index.js

@@ -2,36 +2,36 @@ module.exports = {
   ApplicationConfig: require("./ApplicationConfig"),
   ApplicationClient: require("./ApplicationClient"),
   ApplicationModel: {
-    CatalogApplicationModel: require("./Catalog/CatalogApplicationModel"),
-
     CartApplicationModel: require("./Cart/CartApplicationModel"),
 
-    CommonApplicationModel: require("./Common/CommonApplicationModel"),
+    CatalogApplicationModel: require("./Catalog/CatalogApplicationModel"),
 
-    LeadApplicationModel: require("./Lead/LeadApplicationModel"),
+    CommonApplicationModel: require("./Common/CommonApplicationModel"),
 
-    ThemeApplicationModel: require("./Theme/ThemeApplicationModel"),
+    CommunicationApplicationModel: require("./Communication/CommunicationApplicationModel"),
 
-    UserApplicationModel: require("./User/UserApplicationModel"),
+    ConfigurationApplicationModel: require("./Configuration/ConfigurationApplicationModel"),
 
     ContentApplicationModel: require("./Content/ContentApplicationModel"),
 
-    CommunicationApplicationModel: require("./Communication/CommunicationApplicationModel"),
+    FileStorageApplicationModel: require("./FileStorage/FileStorageApplicationModel"),
 
-    ShareApplicationModel: require("./Share/ShareApplicationModel"),
+    LeadApplicationModel: require("./Lead/LeadApplicationModel"),
 
-    FileStorageApplicationModel: require("./FileStorage/FileStorageApplicationModel"),
+    LogisticApplicationModel: require("./Logistic/LogisticApplicationModel"),
 
-    ConfigurationApplicationModel: require("./Configuration/ConfigurationApplicationModel"),
+    OrderApplicationModel: require("./Order/OrderApplicationModel"),
 
     PaymentApplicationModel: require("./Payment/PaymentApplicationModel"),
 
-    OrderApplicationModel: require("./Order/OrderApplicationModel"),
+    PosCartApplicationModel: require("./PosCart/PosCartApplicationModel"),
 
     RewardsApplicationModel: require("./Rewards/RewardsApplicationModel"),
 
-    PosCartApplicationModel: require("./PosCart/PosCartApplicationModel"),
+    ShareApplicationModel: require("./Share/ShareApplicationModel"),
 
-    LogisticApplicationModel: require("./Logistic/LogisticApplicationModel"),
+    ThemeApplicationModel: require("./Theme/ThemeApplicationModel"),
+
+    UserApplicationModel: require("./User/UserApplicationModel"),
   },
 };

package/sdk/common/Constant.d.ts

@@ -44,6 +44,7 @@ export namespace AVAILABLE_PAGE_TYPE {
     const REGISTER: string;
     const SHIPPING_POLICY: string;
     const RETURN_POLICY: string;
+    const ORDER_STATUS: string;
 }
 export const NAVIGATORS: {
     "about-us": {
@@ -282,4 +283,8 @@ export const NAVIGATORS: {
         name: string;
         link: string;
     };
+    "order-status": {
+        name: string;
+        link: string;
+    };
 };

package/sdk/common/Constant.js

@@ -44,6 +44,7 @@ const AVAILABLE_PAGE_TYPE = {
   REGISTER: "register",
   SHIPPING_POLICY: "shipping-policy",
   RETURN_POLICY: "return-policy",
+  ORDER_STATUS: "order-status",
 };
 
 Object.freeze(AVAILABLE_PAGE_TYPE);
@@ -313,6 +314,10 @@ const NAVIGATORS = {
     name: "Return policy",
     link: "/return-policy",
   },
+  "order-status": {
+    name: "Order status",
+    link: "/cart/order-status",
+  },
 };
 
 module.exports = {

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -100,6 +100,7 @@ class BillingModel {
   }
   static DetailedPlanComponents() {
     return Joi.object({
+      config: Joi.any(),
       description: Joi.string().allow(""),
       display_text: Joi.string().allow(""),
       enabled: Joi.boolean(),
@@ -438,6 +439,7 @@ class BillingModel {
     return Joi.object({
       _id: Joi.string().allow(""),
       cancel_at_period_end: Joi.boolean(),
+      channel_type: Joi.string().allow(""),
       collection_method: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       current_period: BillingModel.SubscriptionCurrentPeriod(),
@@ -593,8 +595,11 @@ class BillingModel {
   }
   static SubscriptionStatus() {
     return Joi.object({
+      current_subscriptions: Joi.array().items(BillingModel.Subscription()),
       is_enabled: Joi.boolean(),
-      mandate_amount: Joi.number(),
+      latest_invoice: BillingModel.InvoicesData(),
+      mandate_amount: Joi.string().allow(""),
+      next_plan: BillingModel.Plan(),
       subscription: BillingModel.Subscription(),
     });
   }