@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -108,14 +108,15 @@ class LogisticModel {
       articles: Joi.array().items(Joi.any()).required(),
       configuration: Joi.any().required(),
       identifier: Joi.string().allow("").required(),
-      ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
+      ignored_locations: Joi.array().items(Joi.number()).required(),
       to_pincode: Joi.string().allow("").required(),
     });
   }
   static ReAssignStoreResponse() {
     return Joi.object({
-      articles: Joi.array().items(Joi.any()),
+      assigned_stores: Joi.array().items(Joi.any()),
       error: Joi.any().required(),
+      pystormbreaker_uuid: Joi.string().allow("").required(),
       success: Joi.boolean().required(),
       to_pincode: Joi.string().allow("").required(),
     });

package/sdk/application/Order/OrderApplicationClient.d.ts

@@ -83,13 +83,13 @@ declare class Order {
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId - A unique number used for identifying and
      *   tracking your orders.
-     * @returns {Promise<OrderList>} - Success response
+     * @returns {Promise<OrderById>} - Success response
      * @summary: Get POS Order
      * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
      */
     getPosOrderById({ orderId }?: {
         orderId: string;
-    }): Promise<OrderList>;
+    }): Promise<OrderById>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId - ID of the bag. An order may contain

package/sdk/application/Order/OrderApplicationClient.js

@@ -336,7 +336,7 @@ class Order {
    * @param {Object} arg - Arg object.
    * @param {string} arg.orderId - A unique number used for identifying and
    *   tracking your orders.
-   * @returns {Promise<OrderList>} - Success response
+   * @returns {Promise<OrderById>} - Success response
    * @summary: Get POS Order
    * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
    */
@@ -378,7 +378,7 @@ class Order {
       xHeaders
     );
 
-    const { error: res_error } = OrderModel.OrderList().validate(response, {
+    const { error: res_error } = OrderModel.OrderById().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });

package/sdk/application/Order/OrderApplicationModel.js

@@ -51,15 +51,16 @@ class OrderModel {
       currency_code: Joi.string().allow(""),
       currency_symbol: Joi.string().allow(""),
       current_status: OrderModel.CurrentStatus(),
-      delivery_date: Joi.string().allow(""),
+      delivery_date: Joi.string().allow("").allow(null),
       financial_breakup: Joi.array().items(OrderModel.FinancialBreakup()),
       id: Joi.number(),
       item: OrderModel.Item(),
       line_number: Joi.number(),
+      meta: Joi.any(),
       parent_promo_bags: Joi.any(),
       prices: OrderModel.Prices(),
       quantity: Joi.number(),
-      returnable_date: Joi.string().allow(""),
+      returnable_date: Joi.string().allow("").allow(null),
       seller_identifier: Joi.string().allow(""),
     });
   }
@@ -90,7 +91,7 @@ class OrderModel {
   }
   static CurrentStatus() {
     return Joi.object({
-      journey_type: Joi.string().allow(""),
+      journey_type: Joi.string().allow("").allow(null),
       name: Joi.string().allow(""),
       status: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
@@ -127,8 +128,8 @@ class OrderModel {
       created_at: Joi.string().allow(""),
       email: Joi.string().allow(""),
       landmark: Joi.string().allow(""),
-      latitude: Joi.number(),
-      longitude: Joi.number(),
+      latitude: Joi.number().allow(null),
+      longitude: Joi.number().allow(null),
       name: Joi.string().allow(""),
       phone: Joi.string().allow(""),
       pincode: Joi.string().allow(""),
@@ -229,6 +230,9 @@ class OrderModel {
       code: Joi.string().allow(""),
       id: Joi.number(),
       image: Joi.array().items(Joi.string().allow("")),
+      l1_categories: Joi.array().items(Joi.string().allow("")),
+      l2_categories: Joi.array().items(Joi.string().allow("")),
+      l3_category_name: Joi.string().allow(""),
       name: Joi.string().allow(""),
       seller_identifier: Joi.string().allow(""),
       size: Joi.string().allow(""),
@@ -444,20 +448,20 @@ class OrderModel {
       comment: Joi.string().allow(""),
       custom_meta: Joi.array().items(Joi.any()),
       delivery_address: OrderModel.DeliveryAddress(),
-      delivery_date: Joi.string().allow(""),
+      delivery_date: Joi.string().allow("").allow(null),
       dp_name: Joi.string().allow(""),
       fulfilling_company: OrderModel.FulfillingCompany(),
       fulfilling_store: OrderModel.FulfillingStore(),
       invoice: OrderModel.Invoice(),
       need_help_url: Joi.string().allow(""),
       order_id: Joi.string().allow(""),
-      order_type: Joi.string().allow(""),
+      order_type: Joi.string().allow("").allow(null),
       payment: OrderModel.ShipmentPayment(),
       prices: OrderModel.Prices(),
       promise: OrderModel.Promise(),
       refund_details: Joi.any(),
       return_meta: Joi.any(),
-      returnable_date: Joi.string().allow(""),
+      returnable_date: Joi.string().allow("").allow(null),
       shipment_created_at: Joi.string().allow(""),
       shipment_id: Joi.string().allow(""),
       shipment_status: OrderModel.ShipmentStatus(),
@@ -484,6 +488,7 @@ class OrderModel {
     return Joi.object({
       hex_code: Joi.string().allow(""),
       title: Joi.string().allow(""),
+      value: Joi.string().allow("").allow(null),
     });
   }
   static ShipmentTotalDetails() {
@@ -500,10 +505,12 @@ class OrderModel {
   }
   static ShipmentUserInfo() {
     return Joi.object({
+      email: Joi.string().allow(""),
       first_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       mobile: Joi.string().allow(""),
+      name: Joi.string().allow(""),
     });
   }
   static StatuesRequest() {
@@ -543,6 +550,7 @@ class OrderModel {
       status: Joi.string().allow(""),
       time: Joi.string().allow(""),
       tracking_details: Joi.array().items(OrderModel.NestedTrackingDetails()),
+      value: Joi.string().allow("").allow(null),
     });
   }
   static UpdateShipmentStatusRequest() {
@@ -557,7 +565,9 @@ class OrderModel {
   static UserInfo() {
     return Joi.object({
       email: Joi.string().allow(""),
+      first_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
+      last_name: Joi.string().allow(""),
       mobile: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });

package/sdk/application/Payment/PaymentApplicationClient.d.ts

@@ -7,6 +7,7 @@ declare class Payment {
         addRefundBankAccountUsingOTP: string;
         attachCardToCustomer: string;
         cancelPaymentLink: string;
+        cardDetails: string;
         checkAndUpdatePaymentStatus: string;
         checkAndUpdatePaymentStatusPaymentLink: string;
         checkCredit: string;
@@ -30,6 +31,8 @@ declare class Payment {
         getUserBeneficiariesDetail: string;
         initialisePayment: string;
         initialisePaymentPaymentLink: string;
+        outstandingOrderDetails: string;
+        paidOrderDetails: string;
         pollingPaymentLink: string;
         redirectToAggregator: string;
         renderHTML: string;
@@ -85,6 +88,18 @@ declare class Payment {
     cancelPaymentLink({ body }?: {
         body: CancelOrResendPaymentLinkRequest;
     }): Promise<CancelPaymentLinkResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.cardInfo - Card first 6 digit IIN(prefix) number.
+     * @param {string} [arg.aggregator] -
+     * @returns {Promise<CardDetailsResponse>} - Success response
+     * @summary: API to get Card info from PG
+     * @description: API to get Card info from PG
+     */
+    cardDetails({ cardInfo, aggregator }?: {
+        cardInfo: string;
+        aggregator?: string;
+    }): Promise<CardDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {PaymentStatusUpdateRequest} arg.body
@@ -348,6 +363,26 @@ declare class Payment {
     initialisePaymentPaymentLink({ body }?: {
         body: PaymentInitializationRequest;
     }): Promise<PaymentInitializationResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.aggregator] -
+     * @returns {Promise<OutstandingOrderDetailsResponse>} - Success response
+     * @summary: API to fetch the outstanding order details
+     * @description: Use this API to fetch the outstanding order details.
+     */
+    outstandingOrderDetails({ aggregator }?: {
+        aggregator?: string;
+    }): Promise<OutstandingOrderDetailsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.aggregator] -
+     * @returns {Promise<PaidOrderDetailsResponse>} - Success response
+     * @summary: API to fetch the paid order details
+     * @description: Use this API to fetch the paid order details.
+     */
+    paidOrderDetails({ aggregator }?: {
+        aggregator?: string;
+    }): Promise<PaidOrderDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.paymentLinkId] -

package/sdk/application/Payment/PaymentApplicationClient.js

@@ -17,6 +17,7 @@ class Payment {
       attachCardToCustomer: "/service/application/payment/v1.0/card/attach",
       cancelPaymentLink:
         "/service/application/payment/v1.0/cancel-payment-link/",
+      cardDetails: "/service/application/payment/v1.0/cards/info/{card_info}",
       checkAndUpdatePaymentStatus:
         "/service/application/payment/v1.0/payment/confirm/polling",
       checkAndUpdatePaymentStatusPaymentLink:
@@ -55,6 +56,10 @@ class Payment {
       initialisePayment: "/service/application/payment/v1.0/payment/request",
       initialisePaymentPaymentLink:
         "/service/application/payment/v1.0/payment/request/link/",
+      outstandingOrderDetails:
+        "/service/application/payment/v1.0/payment/outstanding-orders/",
+      paidOrderDetails:
+        "/service/application/payment/v1.0/payment/paid-orders/",
       pollingPaymentLink:
         "/service/application/payment/v1.0/polling-payment-link/",
       redirectToAggregator:
@@ -353,6 +358,71 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.cardInfo - Card first 6 digit IIN(prefix) number.
+   * @param {string} [arg.aggregator] -
+   * @returns {Promise<CardDetailsResponse>} - Success response
+   * @summary: API to get Card info from PG
+   * @description: API to get Card info from PG
+   */
+  async cardDetails({ cardInfo, aggregator } = {}) {
+    const { error } = PaymentValidator.cardDetails().validate(
+      { cardInfo, aggregator },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.cardDetails().validate(
+      { cardInfo, aggregator },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for cardDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+    query_params["aggregator"] = aggregator;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["cardDetails"],
+        params: { cardInfo },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = PaymentModel.CardDetailsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for cardDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {PaymentStatusUpdateRequest} arg.body
@@ -1958,6 +2028,136 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.aggregator] -
+   * @returns {Promise<OutstandingOrderDetailsResponse>} - Success response
+   * @summary: API to fetch the outstanding order details
+   * @description: Use this API to fetch the outstanding order details.
+   */
+  async outstandingOrderDetails({ aggregator } = {}) {
+    const { error } = PaymentValidator.outstandingOrderDetails().validate(
+      { aggregator },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.outstandingOrderDetails().validate(
+      { aggregator },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for outstandingOrderDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+    query_params["aggregator"] = aggregator;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["outstandingOrderDetails"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = PaymentModel.OutstandingOrderDetailsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for outstandingOrderDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.aggregator] -
+   * @returns {Promise<PaidOrderDetailsResponse>} - Success response
+   * @summary: API to fetch the paid order details
+   * @description: Use this API to fetch the paid order details.
+   */
+  async paidOrderDetails({ aggregator } = {}) {
+    const { error } = PaymentValidator.paidOrderDetails().validate(
+      { aggregator },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.paidOrderDetails().validate(
+      { aggregator },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for paidOrderDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+    query_params["aggregator"] = aggregator;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["paidOrderDetails"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = PaymentModel.PaidOrderDetailsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for paidOrderDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.paymentLinkId] -

package/sdk/application/Payment/PaymentApplicationModel.d.ts

@@ -17,6 +17,8 @@ declare class PaymentModel {
     static CancelOrResendPaymentLinkRequest(): any;
     static CancelPaymentLinkResponse(): any;
     static Card(): any;
+    static CardDetails(): any;
+    static CardDetailsResponse(): any;
     static CardPaymentGateway(): any;
     static ChargeCustomerRequest(): any;
     static ChargeCustomerResponse(): any;
@@ -55,6 +57,8 @@ declare class PaymentModel {
     static OnboardSummary(): any;
     static OrderBeneficiaryDetails(): any;
     static OrderBeneficiaryResponse(): any;
+    static OutstandingOrderDetailsResponse(): any;
+    static PaidOrderDetailsResponse(): any;
     static PaymentFlow(): any;
     static PaymentInitializationRequest(): any;
     static PaymentInitializationResponse(): any;

package/sdk/application/Payment/PaymentApplicationModel.js

@@ -91,9 +91,9 @@ class PaymentModel {
   }
   static BalanceDetails() {
     return Joi.object({
-      currency: Joi.string().allow("").required(),
-      formatted_value: Joi.string().allow("").required(),
-      value: Joi.number().required(),
+      currency: Joi.string().allow("").allow(null),
+      formatted_value: Joi.string().allow("").allow(null),
+      value: Joi.number().allow(null),
     });
   }
   static BankDetailsForOTP() {
@@ -168,6 +168,32 @@ class PaymentModel {
       nickname: Joi.string().allow("").allow(null),
     });
   }
+  static CardDetails() {
+    return Joi.object({
+      bank: Joi.string().allow("").required(),
+      bank_code: Joi.string().allow("").allow(null).required(),
+      card_brand: Joi.string().allow("").required(),
+      card_exp_month: Joi.string().allow(""),
+      card_exp_year: Joi.string().allow(""),
+      card_object: Joi.string().allow("").required(),
+      card_sub_type: Joi.string().allow("").allow(null).required(),
+      card_token: Joi.string().allow(""),
+      country: Joi.string().allow("").required(),
+      extended_card_type: Joi.string().allow("").required(),
+      id: Joi.string().allow("").required(),
+      is_domestic_card: Joi.boolean().required(),
+      name_on_card: Joi.string().allow(""),
+      status: Joi.boolean().required(),
+      type: Joi.string().allow("").required(),
+      user: Joi.string().allow(""),
+    });
+  }
+  static CardDetailsResponse() {
+    return Joi.object({
+      data: PaymentModel.CardDetails().required(),
+      success: Joi.boolean().required(),
+    });
+  }
   static CardPaymentGateway() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -281,10 +307,13 @@ class PaymentModel {
   }
   static CreditSummary() {
     return Joi.object({
+      amount_available: PaymentModel.BalanceDetails(),
       balance: PaymentModel.BalanceDetails(),
-      merchant_customer_ref_id: Joi.string().allow("").required(),
-      status: Joi.string().allow("").required(),
-      status_message: Joi.string().allow("").required(),
+      buyer_status: Joi.string().allow("").allow(null),
+      credit_line_id: Joi.string().allow("").allow(null),
+      merchant_customer_ref_id: Joi.string().allow("").allow(null),
+      status: Joi.string().allow("").allow(null),
+      status_message: Joi.string().allow("").allow(null),
     });
   }
   static CustomerCreditSummaryResponse() {
@@ -492,8 +521,25 @@ class PaymentModel {
       show_beneficiary_details: Joi.boolean(),
     });
   }
+  static OutstandingOrderDetailsResponse() {
+    return Joi.object({
+      data: Joi.array().items(Joi.any()),
+      message: Joi.string().allow("").allow(null),
+      status_code: Joi.number().required(),
+      success: Joi.boolean().required(),
+    });
+  }
+  static PaidOrderDetailsResponse() {
+    return Joi.object({
+      data: Joi.array().items(Joi.any()),
+      message: Joi.string().allow("").allow(null),
+      status_code: Joi.number().required(),
+      success: Joi.boolean().required(),
+    });
+  }
   static PaymentFlow() {
     return Joi.object({
+      ajiodhan: PaymentModel.AggregatorRoute(),
       bqr_razorpay: PaymentModel.AggregatorRoute(),
       ccavenue: PaymentModel.AggregatorRoute(),
       epaylater: PaymentModel.AggregatorRoute(),
@@ -516,6 +562,7 @@ class PaymentModel {
       contact: Joi.string().allow("").required(),
       currency: Joi.string().allow("").required(),
       customer_id: Joi.string().allow("").required(),
+      device_id: Joi.string().allow("").allow(null),
       email: Joi.string().allow("").required(),
       merchant_order_id: Joi.string().allow("").required(),
       method: Joi.string().allow("").required(),
@@ -533,6 +580,7 @@ class PaymentModel {
       bqr_image: Joi.string().allow("").allow(null),
       currency: Joi.string().allow("").allow(null),
       customer_id: Joi.string().allow("").allow(null),
+      device_id: Joi.string().allow("").allow(null),
       merchant_order_id: Joi.string().allow("").required(),
       method: Joi.string().allow("").required(),
       polling_url: Joi.string().allow("").required(),
@@ -618,12 +666,14 @@ class PaymentModel {
       contact: Joi.string().allow("").required(),
       currency: Joi.string().allow("").required(),
       customer_id: Joi.string().allow("").required(),
+      device_id: Joi.string().allow("").allow(null),
       email: Joi.string().allow("").required(),
       merchant_order_id: Joi.string().allow("").required(),
+      merchant_transaction_id: Joi.string().allow("").required(),
       method: Joi.string().allow("").required(),
       order_id: Joi.string().allow("").required(),
       status: Joi.string().allow("").required(),
-      vpa: Joi.string().allow("").required(),
+      vpa: Joi.string().allow(""),
     });
   }
   static PaymentStatusUpdateResponse() {
@@ -682,6 +732,7 @@ class PaymentModel {
   }
   static ResendOrCancelPaymentRequest() {
     return Joi.object({
+      device_id: Joi.string().allow("").allow(null),
       order_id: Joi.string().allow("").required(),
       request_type: Joi.string().allow("").required(),
     });

package/sdk/application/Payment/PaymentApplicationValidator.d.ts

@@ -4,6 +4,7 @@ declare class PaymentValidator {
     static addRefundBankAccountUsingOTP(): any;
     static attachCardToCustomer(): any;
     static cancelPaymentLink(): any;
+    static cardDetails(): any;
     static checkAndUpdatePaymentStatus(): any;
     static checkAndUpdatePaymentStatusPaymentLink(): any;
     static checkCredit(): any;
@@ -27,6 +28,8 @@ declare class PaymentValidator {
     static getUserBeneficiariesDetail(): any;
     static initialisePayment(): any;
     static initialisePaymentPaymentLink(): any;
+    static outstandingOrderDetails(): any;
+    static paidOrderDetails(): any;
     static pollingPaymentLink(): any;
     static redirectToAggregator(): any;
     static renderHTML(): any;

package/sdk/application/Payment/PaymentApplicationValidator.js

@@ -26,6 +26,13 @@ class PaymentValidator {
     }).required();
   }
 
+  static cardDetails() {
+    return Joi.object({
+      cardInfo: Joi.string().allow("").required(),
+      aggregator: Joi.string().allow(""),
+    }).required();
+  }
+
   static checkAndUpdatePaymentStatus() {
     return Joi.object({
       body: PaymentModel.PaymentStatusUpdateRequest().required(),
@@ -172,6 +179,18 @@ class PaymentValidator {
     }).required();
   }
 
+  static outstandingOrderDetails() {
+    return Joi.object({
+      aggregator: Joi.string().allow(""),
+    });
+  }
+
+  static paidOrderDetails() {
+    return Joi.object({
+      aggregator: Joi.string().allow(""),
+    });
+  }
+
   static pollingPaymentLink() {
     return Joi.object({
       paymentLinkId: Joi.string().allow(""),