@gofynd/fdk-client-javascript 1.1.1 → 1.1.3

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

@@ -11,7 +11,12 @@ declare class OrderModel {
     static BreakupValues(): any;
     static CurrentStatus(): any;
     static CustomerDetailsResponse(): any;
+    static DataUpdates(): any;
     static DeliveryAddress(): any;
+    static EntitiesDataUpdates(): any;
+    static EntitiesReasons(): any;
+    static EntityReasonData(): any;
+    static ErrorResponse(): any;
     static FinancialBreakup(): any;
     static FulfillingCompany(): any;
     static FulfillingStore(): any;
@@ -27,23 +32,35 @@ declare class OrderModel {
     static OrderSchema(): any;
     static OrderStatuses(): any;
     static Prices(): any;
+    static Products(): any;
+    static ProductsDataUpdates(): any;
+    static ProductsDataUpdatesFilters(): any;
+    static ProductsReasons(): any;
+    static ProductsReasonsData(): any;
+    static ProductsReasonsFilters(): any;
     static Promise(): any;
     static QuestionSet(): any;
+    static ReasonsData(): any;
     static ResponseGetInvoiceShipment(): any;
     static SendOtpToCustomerResponse(): any;
+    static ShipmentApplicationStatusResponse(): any;
     static ShipmentBagReasons(): any;
     static ShipmentById(): any;
     static ShipmentPayment(): any;
     static ShipmentReason(): any;
     static ShipmentReasons(): any;
     static Shipments(): any;
+    static ShipmentsRequest(): any;
     static ShipmentStatus(): any;
     static ShipmentTotalDetails(): any;
     static ShipmentTrack(): any;
     static ShipmentUserInfo(): any;
+    static StatuesRequest(): any;
+    static StatusesBodyResponse(): any;
     static TimeStampData(): any;
     static Track(): any;
     static TrackingDetails(): any;
+    static UpdateShipmentStatusRequest(): any;
     static UserInfo(): any;
     static VerifyOtp(): any;
     static VerifyOtpResponse(): any;

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(""),
@@ -105,6 +106,12 @@ class OrderModel {
       shipment_id: Joi.string().allow(""),
     });
   }
+  static DataUpdates() {
+    return Joi.object({
+      entities: Joi.array().items(OrderModel.EntitiesDataUpdates()),
+      products: Joi.array().items(OrderModel.ProductsDataUpdates()),
+    });
+  }
   static DeliveryAddress() {
     return Joi.object({
       address: Joi.string().allow(""),
@@ -121,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(""),
@@ -131,6 +138,33 @@ class OrderModel {
       version: Joi.string().allow(""),
     });
   }
+  static EntitiesDataUpdates() {
+    return Joi.object({
+      data: Joi.any(),
+      filters: Joi.array().items(Joi.any()),
+    });
+  }
+  static EntitiesReasons() {
+    return Joi.object({
+      data: OrderModel.EntityReasonData(),
+      filters: Joi.array().items(Joi.any()),
+    });
+  }
+  static EntityReasonData() {
+    return Joi.object({
+      reason_id: Joi.number(),
+      reason_text: Joi.string().allow(""),
+    });
+  }
+  static ErrorResponse() {
+    return Joi.object({
+      code: Joi.string().allow("").allow(null),
+      exception: Joi.string().allow("").allow(null),
+      message: Joi.string().allow("").allow(null),
+      stack_trace: Joi.string().allow("").allow(null),
+      status: Joi.number(),
+    });
+  }
   static FinancialBreakup() {
     return Joi.object({
       added_to_fynd_cash: Joi.boolean(),
@@ -196,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(""),
@@ -286,6 +323,44 @@ class OrderModel {
       value_of_good: Joi.number(),
     });
   }
+  static Products() {
+    return Joi.object({
+      identifier: Joi.string().allow(""),
+      line_number: Joi.number(),
+      quantity: Joi.number(),
+    });
+  }
+  static ProductsDataUpdates() {
+    return Joi.object({
+      data: Joi.any(),
+      filters: Joi.array().items(OrderModel.ProductsDataUpdatesFilters()),
+    });
+  }
+  static ProductsDataUpdatesFilters() {
+    return Joi.object({
+      identifier: Joi.string().allow(""),
+      line_number: Joi.number(),
+    });
+  }
+  static ProductsReasons() {
+    return Joi.object({
+      data: OrderModel.ProductsReasonsData(),
+      filters: Joi.array().items(OrderModel.ProductsReasonsFilters()),
+    });
+  }
+  static ProductsReasonsData() {
+    return Joi.object({
+      reason_id: Joi.number(),
+      reason_text: Joi.string().allow(""),
+    });
+  }
+  static ProductsReasonsFilters() {
+    return Joi.object({
+      identifier: Joi.string().allow(""),
+      line_number: Joi.number(),
+      quantity: Joi.number(),
+    });
+  }
   static Promise() {
     return Joi.object({
       show_promise: Joi.boolean(),
@@ -298,6 +373,12 @@ class OrderModel {
       id: Joi.number(),
     });
   }
+  static ReasonsData() {
+    return Joi.object({
+      entities: Joi.array().items(OrderModel.EntitiesReasons()),
+      products: Joi.array().items(OrderModel.ProductsReasons()),
+    });
+  }
   static ResponseGetInvoiceShipment() {
     return Joi.object({
       presigned_type: Joi.string().allow("").required(),
@@ -314,6 +395,11 @@ class OrderModel {
       success: Joi.boolean(),
     });
   }
+  static ShipmentApplicationStatusResponse() {
+    return Joi.object({
+      statuses: Joi.array().items(OrderModel.StatusesBodyResponse()),
+    });
+  }
   static ShipmentBagReasons() {
     return Joi.object({
       reasons: Joi.array().items(OrderModel.BagReasons()),
@@ -362,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(),
@@ -390,10 +476,19 @@ class OrderModel {
       user_info: OrderModel.ShipmentUserInfo(),
     });
   }
+  static ShipmentsRequest() {
+    return Joi.object({
+      data_updates: OrderModel.DataUpdates(),
+      identifier: Joi.string().allow("").required(),
+      products: Joi.array().items(OrderModel.Products()),
+      reasons: OrderModel.ReasonsData(),
+    });
+  }
   static ShipmentStatus() {
     return Joi.object({
       hex_code: Joi.string().allow(""),
       title: Joi.string().allow(""),
+      value: Joi.string().allow("").allow(null),
     });
   }
   static ShipmentTotalDetails() {
@@ -410,10 +505,24 @@ 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() {
+    return Joi.object({
+      exclude_bags_next_state: Joi.string().allow(""),
+      shipments: Joi.array().items(OrderModel.ShipmentsRequest()),
+      status: Joi.string().allow(""),
+    });
+  }
+  static StatusesBodyResponse() {
+    return Joi.object({
+      shipments: Joi.array().items(Joi.any()),
     });
   }
   static TimeStampData() {
@@ -441,12 +550,24 @@ 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() {
+    return Joi.object({
+      force_transition: Joi.boolean(),
+      lock_after_transition: Joi.boolean(),
+      statuses: Joi.array().items(OrderModel.StatuesRequest()),
+      task: Joi.boolean(),
+      unlock_before_transition: Joi.boolean(),
     });
   }
   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/Order/OrderApplicationValidator.d.ts

@@ -10,5 +10,6 @@ declare class OrderValidator {
     static getShipmentReasons(): any;
     static sendOtpToShipmentCustomer(): any;
     static trackShipment(): any;
+    static updateShipmentStatus(): any;
     static verifyOtpShipmentCustomer(): any;
 }

package/sdk/application/Order/OrderApplicationValidator.js

@@ -70,6 +70,13 @@ class OrderValidator {
     }).required();
   }
 
+  static updateShipmentStatus() {
+    return Joi.object({
+      shipmentId: Joi.string().allow("").required(),
+      body: OrderModel.UpdateShipmentStatusRequest().required(),
+    }).required();
+  }
+
   static verifyOtpShipmentCustomer() {
     return Joi.object({
       orderId: Joi.string().allow("").required(),

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;