@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

package/sdk/application/Logistic/LogisticApplicationClient.d.ts

@@ -0,0 +1,53 @@
+export = Logistic;
+declare class Logistic {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getPincodeCity: string;
+        getTatProduct: string;
+        getAllCountries: string;
+        getPincodeZones: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.pincode - A `pincode` contains a specific address of
+     *   a location.
+     * @param {string} [arg.countryCode] - A 3 alphabetic country code
+     * @returns {Promise<PincodeApiResponse>} - Success response
+     * @summary: Get Pincode API
+     * @description: Get pincode data
+     */
+    getPincodeCity({ pincode, countryCode }?: {
+        pincode: string;
+        countryCode?: string;
+    }): Promise<PincodeApiResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {TATViewRequest} arg.body
+     * @returns {Promise<TATViewResponse>} - Success response
+     * @summary: Get TAT API
+     * @description: Get TAT data
+     */
+    getTatProduct({ body }?: {
+        body: TATViewRequest;
+    }): Promise<TATViewResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<CountryListResponse>} - Success response
+     * @summary: Get Country List
+     * @description: Get all countries
+     */
+    getAllCountries({}?: any): Promise<CountryListResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {GetZoneFromPincodeViewRequest} arg.body
+     * @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
+     * @summary: GET zone from the Pincode.
+     * @description: This API returns zone from the Pincode View.
+     */
+    getPincodeZones({ body }?: {
+        body: GetZoneFromPincodeViewRequest;
+    }): Promise<GetZoneFromPincodeViewResponse>;
+}

package/sdk/application/{client → Logistic}/LogisticApplicationClient.js

@@ -1,16 +1,17 @@
 const APIClient = require("../ApplicationAPIClient");
-const Paginator = require("../../common/Paginator");
 const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const LogisticValidator = require("../models/LogisticValidator");
+const LogisticValidator = require("./LogisticApplicationValidator");
 
 class Logistic {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      getTatProduct: "/service/application/logistics/v1.0",
-      getPincodeZones: "/service/application/logistics/v1.0/pincode/zones",
       getPincodeCity: "/service/application/logistics/v1.0/pincode/{pincode}",
+      getTatProduct: "/service/application/logistics/v1.0/",
+      getAllCountries: "/service/application/logistics/v1.0/country-list",
+      getPincodeZones: "/service/application/logistics/v1.0/pincode/zones",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -30,10 +31,45 @@ class Logistic {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {GetTatProductReqBody} arg.body
-   * @returns {Promise<GetTatProductResponse>} - Success response
-   * @summary: Get TAT of a product
-   * @description: Use this API to know the delivery turnaround time (TAT) by entering the product details along with the PIN Code of the location.
+   * @param {string} arg.pincode - A `pincode` contains a specific address of
+   *   a location.
+   * @param {string} [arg.countryCode] - A 3 alphabetic country code
+   * @returns {Promise<PincodeApiResponse>} - Success response
+   * @summary: Get Pincode API
+   * @description: Get pincode data
+   */
+  getPincodeCity({ pincode, countryCode } = {}) {
+    const { error } = LogisticValidator.getPincodeCity().validate(
+      { pincode, countryCode },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["country_code"] = countryCode;
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getPincodeCity"],
+        params: { pincode },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {TATViewRequest} arg.body
+   * @returns {Promise<TATViewResponse>} - Success response
+   * @summary: Get TAT API
+   * @description: Get TAT data
    */
   getTatProduct({ body } = {}) {
     const { error } = LogisticValidator.getTatProduct().validate(
@@ -62,14 +98,13 @@ class Logistic {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {GetPincodeZonesReqBody} arg.body
-   * @returns {Promise<GetPincodeZonesResponse>} - Success response
-   * @summary: Get Pincode Zones
-   * @description: Get to know the zones of a specefic pincode
+   * @returns {Promise<CountryListResponse>} - Success response
+   * @summary: Get Country List
+   * @description: Get all countries
    */
-  getPincodeZones({ body } = {}) {
-    const { error } = LogisticValidator.getPincodeZones().validate(
-      { body },
+  getAllCountries({} = {}) {
+    const { error } = LogisticValidator.getAllCountries().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -81,27 +116,27 @@ class Logistic {
 
     return APIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["getPincodeZones"],
+        url: this._urls["getAllCountries"],
         params: {},
       }),
       query_params,
-      body,
+      undefined,
       xHeaders
     );
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.pincode - The PIN Code of the area, e.g. 400059
-   * @returns {Promise<GetPincodeCityResponse>} - Success response
-   * @summary: Get city from PIN Code
-   * @description: Use this API to retrieve a city by its PIN Code.
+   * @param {GetZoneFromPincodeViewRequest} arg.body
+   * @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
+   * @summary: GET zone from the Pincode.
+   * @description: This API returns zone from the Pincode View.
    */
-  getPincodeCity({ pincode } = {}) {
-    const { error } = LogisticValidator.getPincodeCity().validate(
-      { pincode },
+  getPincodeZones({ body } = {}) {
+    const { error } = LogisticValidator.getPincodeZones().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -113,13 +148,13 @@ class Logistic {
 
     return APIClient.execute(
       this._conf,
-      "get",
+      "post",
       constructUrl({
-        url: this._urls["getPincodeCity"],
-        params: { pincode },
+        url: this._urls["getPincodeZones"],
+        params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
   }

package/sdk/application/Logistic/LogisticApplicationModel.d.ts

@@ -0,0 +1,26 @@
+export = LogisticModel;
+declare class LogisticModel {
+    static CountryMetaResponse(): any;
+    static PincodeErrorSchemaResponse(): any;
+    static PincodeMetaResponse(): any;
+    static PincodeParentsResponse(): any;
+    static PincodeDataResponse(): any;
+    static PincodeApiResponse(): any;
+    static TATCategoryRequest(): any;
+    static TATArticlesRequest(): any;
+    static TATLocationDetailsRequest(): any;
+    static TATViewRequest(): any;
+    static TATErrorSchemaResponse(): any;
+    static TATFormattedResponse(): any;
+    static TATTimestampResponse(): any;
+    static TATPromiseResponse(): any;
+    static TATArticlesResponse(): any;
+    static TATLocationDetailsResponse(): any;
+    static TATViewResponse(): any;
+    static DP(): any;
+    static LogisticsResponse(): any;
+    static CountryEntityResponse(): any;
+    static CountryListResponse(): any;
+    static GetZoneFromPincodeViewRequest(): any;
+    static GetZoneFromPincodeViewResponse(): any;
+}

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -0,0 +1,286 @@
+const Joi = require("joi");
+
+class LogisticModel {
+  static CountryMetaResponse() {
+    return Joi.object({
+      isd_code: Joi.string().allow(""),
+
+      country_code: Joi.string().allow(""),
+    });
+  }
+
+  static PincodeErrorSchemaResponse() {
+    return Joi.object({
+      type: Joi.string().allow("").allow(null),
+
+      message: Joi.string().allow("").allow(null),
+
+      value: Joi.string().allow("").allow(null),
+    });
+  }
+
+  static PincodeMetaResponse() {
+    return Joi.object({
+      zone: Joi.string().allow(""),
+
+      internal_zone_id: Joi.number(),
+    });
+  }
+
+  static PincodeParentsResponse() {
+    return Joi.object({
+      sub_type: Joi.string().allow(""),
+
+      display_name: Joi.string().allow(""),
+
+      uid: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+    });
+  }
+
+  static PincodeDataResponse() {
+    return Joi.object({
+      meta_code: LogisticModel.CountryMetaResponse(),
+
+      sub_type: Joi.string().allow(""),
+
+      error: LogisticModel.PincodeErrorSchemaResponse().required(),
+
+      display_name: Joi.string().allow(""),
+
+      uid: Joi.string().allow(""),
+
+      meta: LogisticModel.PincodeMetaResponse(),
+
+      parents: Joi.array().items(LogisticModel.PincodeParentsResponse()),
+
+      name: Joi.string().allow(""),
+    });
+  }
+
+  static PincodeApiResponse() {
+    return Joi.object({
+      data: Joi.array().items(LogisticModel.PincodeDataResponse()),
+
+      error: LogisticModel.PincodeErrorSchemaResponse().required(),
+
+      success: Joi.boolean().required(),
+    });
+  }
+
+  static TATCategoryRequest() {
+    return Joi.object({
+      level: Joi.string().allow(""),
+
+      id: Joi.number(),
+    });
+  }
+
+  static TATArticlesRequest() {
+    return Joi.object({
+      category: LogisticModel.TATCategoryRequest(),
+
+      manufacturing_time: Joi.number(),
+
+      manufacturing_time_unit: Joi.string().allow(""),
+    });
+  }
+
+  static TATLocationDetailsRequest() {
+    return Joi.object({
+      fulfillment_id: Joi.number(),
+
+      articles: Joi.array().items(LogisticModel.TATArticlesRequest()),
+
+      from_pincode: Joi.string().allow(""),
+    });
+  }
+
+  static TATViewRequest() {
+    return Joi.object({
+      journey: Joi.string().allow(""),
+
+      to_pincode: Joi.string().allow(""),
+
+      action: Joi.string().allow(""),
+
+      identifier: Joi.string().allow(""),
+
+      source: Joi.string().allow(""),
+
+      location_details: Joi.array().items(
+        LogisticModel.TATLocationDetailsRequest()
+      ),
+    });
+  }
+
+  static TATErrorSchemaResponse() {
+    return Joi.object({
+      type: Joi.string().allow("").allow(null),
+
+      message: Joi.string().allow("").allow(null),
+
+      value: Joi.string().allow("").allow(null),
+    });
+  }
+
+  static TATFormattedResponse() {
+    return Joi.object({
+      min: Joi.string().allow(""),
+
+      max: Joi.string().allow(""),
+    });
+  }
+
+  static TATTimestampResponse() {
+    return Joi.object({
+      min: Joi.number(),
+
+      max: Joi.number(),
+    });
+  }
+
+  static TATPromiseResponse() {
+    return Joi.object({
+      formatted: LogisticModel.TATFormattedResponse(),
+
+      timestamp: LogisticModel.TATTimestampResponse(),
+    });
+  }
+
+  static TATArticlesResponse() {
+    return Joi.object({
+      category: LogisticModel.TATCategoryRequest(),
+
+      error: LogisticModel.TATErrorSchemaResponse(),
+
+      promise: LogisticModel.TATPromiseResponse(),
+
+      manufacturing_time: Joi.number(),
+
+      manufacturing_time_unit: Joi.string().allow(""),
+
+      _manufacturing_time_seconds: Joi.number(),
+
+      is_cod_available: Joi.boolean(),
+    });
+  }
+
+  static TATLocationDetailsResponse() {
+    return Joi.object({
+      fulfillment_id: Joi.number(),
+
+      articles: Joi.array().items(LogisticModel.TATArticlesResponse()),
+
+      from_pincode: Joi.string().allow(""),
+    });
+  }
+
+  static TATViewResponse() {
+    return Joi.object({
+      journey: Joi.string().allow(""),
+
+      to_pincode: Joi.string().allow(""),
+
+      payment_mode: Joi.string().allow(""),
+
+      success: Joi.boolean(),
+
+      stormbreaker_uuid: Joi.string().allow(""),
+
+      error: LogisticModel.TATErrorSchemaResponse(),
+
+      action: Joi.string().allow(""),
+
+      identifier: Joi.string().allow(""),
+
+      to_city: Joi.string().allow(""),
+
+      source: Joi.string().allow(""),
+
+      request_uuid: Joi.string().allow(""),
+
+      location_details: Joi.array().items(
+        LogisticModel.TATLocationDetailsResponse()
+      ),
+
+      is_cod_available: Joi.boolean(),
+    });
+  }
+
+  static DP() {
+    return Joi.object({
+      fm_priority: Joi.number().required(),
+
+      lm_priority: Joi.number().required(),
+
+      rvp_priority: Joi.number().required(),
+
+      payment_mode: Joi.string().allow("").required(),
+
+      operations: Joi.array().items(Joi.string().allow("")).required(),
+
+      area_code: Joi.string().allow("").allow(null),
+
+      assign_dp_from_sb: Joi.boolean(),
+
+      internal_account_id: Joi.string().allow(""),
+
+      external_account_id: Joi.string().allow("").allow(null),
+
+      transport_mode: Joi.string().allow(""),
+    });
+  }
+
+  static LogisticsResponse() {
+    return Joi.object({
+      dp: Joi.object().pattern(/\S/, this.DP()),
+    });
+  }
+
+  static CountryEntityResponse() {
+    return Joi.object({
+      parent_id: Joi.string().allow(""),
+
+      sub_type: Joi.string().allow(""),
+
+      display_name: Joi.string().allow(""),
+
+      uid: Joi.string().allow(""),
+
+      logistics: LogisticModel.LogisticsResponse(),
+
+      type: Joi.string().allow(""),
+
+      meta: LogisticModel.CountryMetaResponse(),
+
+      is_active: Joi.boolean(),
+
+      name: Joi.string().allow(""),
+    });
+  }
+
+  static CountryListResponse() {
+    return Joi.object({
+      results: Joi.array().items(LogisticModel.CountryEntityResponse()),
+    });
+  }
+
+  static GetZoneFromPincodeViewRequest() {
+    return Joi.object({
+      country: Joi.string().allow("").required(),
+
+      pincode: Joi.string().allow("").required(),
+    });
+  }
+
+  static GetZoneFromPincodeViewResponse() {
+    return Joi.object({
+      zones: Joi.array().items(Joi.string().allow("")).required(),
+
+      serviceability_type: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = LogisticModel;

package/sdk/application/{models/LogisticValidator.d.ts → Logistic/LogisticApplicationValidator.d.ts}

@@ -1,6 +1,7 @@
 export = LogisticValidator;
 declare class LogisticValidator {
+    static getPincodeCity(): any;
     static getTatProduct(): any;
+    static getAllCountries(): any;
     static getPincodeZones(): any;
-    static getPincodeCity(): any;
 }

package/sdk/application/{models/LogisticValidator.js → Logistic/LogisticApplicationValidator.js}

@@ -1,21 +1,27 @@
 const Joi = require("joi");
-const { Validator } = require("../ApplicationModels");
+
+const LogisticModel = require("./LogisticApplicationModel");
 class LogisticValidator {
-  static getTatProduct() {
+  static getPincodeCity() {
     return Joi.object({
-      body: Validator.GetTatProductReqBody().required(),
+      pincode: Joi.string().allow("").required(),
+      countryCode: Joi.string().allow(""),
     }).required();
   }
 
-  static getPincodeZones() {
+  static getTatProduct() {
     return Joi.object({
-      body: Validator.GetPincodeZonesReqBody().required(),
+      body: LogisticModel.TATViewRequest().required(),
     }).required();
   }
 
-  static getPincodeCity() {
+  static getAllCountries() {
+    return Joi.object({});
+  }
+
+  static getPincodeZones() {
     return Joi.object({
-      pincode: Joi.string().allow("").required(),
+      body: LogisticModel.GetZoneFromPincodeViewRequest().required(),
     }).required();
   }
 }

package/sdk/application/{client → Order}/OrderApplicationClient.js

@@ -1,8 +1,8 @@
 const APIClient = require("../ApplicationAPIClient");
-const Paginator = require("../../common/Paginator");
 const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const OrderValidator = require("../models/OrderValidator");
+const OrderValidator = require("./OrderApplicationValidator");
 
 class Order {
   constructor(_conf) {

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

@@ -0,0 +1,67 @@
+export = OrderModel;
+declare class OrderModel {
+    static OrderStatuses(): any;
+    static OrderFilters(): any;
+    static BreakupValues(): any;
+    static UserInfo(): any;
+    static BagsForReorderArticleAssignment(): any;
+    static BagsForReorder(): any;
+    static TimeStampData(): any;
+    static Promise(): any;
+    static ShipmentUserInfo(): any;
+    static ShipmentTotalDetails(): any;
+    static ShipmentPayment(): any;
+    static ShipmentStatus(): any;
+    static DeliveryAddress(): any;
+    static FulfillingCompany(): any;
+    static CurrentStatus(): any;
+    static ItemBrand(): any;
+    static Item(): any;
+    static Prices(): any;
+    static AppliedFreeArticles(): any;
+    static AppliedPromos(): any;
+    static Identifiers(): any;
+    static FinancialBreakup(): any;
+    static Bags(): any;
+    static FulfillingStore(): any;
+    static Invoice(): any;
+    static NestedTrackingDetails(): any;
+    static TrackingDetails(): any;
+    static Shipments(): any;
+    static OrderSchema(): any;
+    static OrderPage(): any;
+    static OrderList(): any;
+    static ApefaceApiError(): any;
+    static OrderById(): any;
+    static ShipmentById(): any;
+    static ResponseGetInvoiceShipment(): any;
+    static Track(): any;
+    static ShipmentTrack(): any;
+    static CustomerDetailsResponse(): any;
+    static SendOtpToCustomerResponse(): any;
+    static VerifyOtp(): any;
+    static VerifyOtpResponse(): any;
+    static QuestionSet(): any;
+    static BagReasonMeta(): any;
+    static BagReasons(): any;
+    static ShipmentBagReasons(): any;
+    static ShipmentReason(): any;
+    static ShipmentReasons(): any;
+    static EntityReasonData(): any;
+    static EntitiesReasons(): any;
+    static ProductsReasonsFilters(): any;
+    static ProductsReasonsData(): any;
+    static ProductsReasons(): any;
+    static ReasonsData(): any;
+    static EntitiesDataUpdates(): any;
+    static ProductsDataUpdatesFilters(): any;
+    static ProductsDataUpdates(): any;
+    static DataUpdates(): any;
+    static Products(): any;
+    static ShipmentsRequest(): any;
+    static StatuesRequest(): any;
+    static UpdateShipmentStatusRequest(): any;
+    static StatusesBodyResponse(): any;
+    static ShipmentApplicationStatusResponse(): any;
+    static ErrorResponse(): any;
+}