@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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

@@ -1,33 +1,33 @@
 export = CatalogValidator;
 declare class CatalogValidator {
-    static getProductDetailBySlug(): any;
-    static getProductSizesBySlug(): any;
-    static getProductComparisonBySlugs(): any;
-    static getSimilarComparisonProductBySlug(): any;
-    static getComparedFrequentlyProductBySlug(): any;
-    static getProductVariantsBySlug(): any;
-    static getProductStockByIds(): any;
-    static getProductStockForTimeByIds(): any;
-    static getProducts(): any;
-    static getBrands(): any;
+    static followById(): any;
     static getBrandDetailBySlug(): any;
+    static getBrands(): any;
     static getCategories(): any;
     static getCategoryDetailBySlug(): any;
-    static getHomeProducts(): any;
-    static getDepartments(): any;
-    static getSearchResults(): any;
-    static getCollections(): any;
-    static getCollectionItemsBySlug(): any;
     static getCollectionDetailBySlug(): any;
+    static getCollectionItemsBySlug(): any;
+    static getCollections(): any;
+    static getComparedFrequentlyProductBySlug(): any;
+    static getDepartments(): any;
+    static getFollowIds(): any;
     static getFollowedListing(): any;
-    static followById(): any;
-    static unfollowById(): any;
     static getFollowerCountById(): any;
-    static getFollowIds(): any;
-    static getStores(): any;
+    static getHomeProducts(): any;
     static getInStockLocations(): any;
     static getLocationDetailsById(): any;
     static getProductBundlesBySlug(): any;
+    static getProductComparisonBySlugs(): any;
+    static getProductDetailBySlug(): any;
     static getProductPriceBySlug(): any;
     static getProductSellersBySlug(): any;
+    static getProductSizesBySlug(): any;
+    static getProductStockByIds(): any;
+    static getProductStockForTimeByIds(): any;
+    static getProductVariantsBySlug(): any;
+    static getProducts(): any;
+    static getSearchResults(): any;
+    static getSimilarComparisonProductBySlug(): any;
+    static getStores(): any;
+    static unfollowById(): any;
 }

package/sdk/application/Catalog/CatalogApplicationValidator.js

@@ -2,97 +2,92 @@ const Joi = require("joi");
 
 const CatalogModel = require("./CatalogApplicationModel");
 class CatalogValidator {
-  static getProductDetailBySlug() {
+  static followById() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
+      collectionType: Joi.string().allow("").required(),
+      collectionId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getProductSizesBySlug() {
+  static getBrandDetailBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      storeId: Joi.number(),
     }).required();
   }
 
-  static getProductComparisonBySlugs() {
+  static getBrands() {
     return Joi.object({
-      slug: Joi.array().items(Joi.string().allow("")).required(),
-    }).required();
+      department: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    });
   }
 
-  static getSimilarComparisonProductBySlug() {
+  static getCategories() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
-    }).required();
+      department: Joi.string().allow(""),
+    });
   }
 
-  static getComparedFrequentlyProductBySlug() {
+  static getCategoryDetailBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getProductVariantsBySlug() {
+  static getCollectionDetailBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getProductStockByIds() {
-    return Joi.object({
-      itemId: Joi.string().allow(""),
-      alu: Joi.string().allow(""),
-      skuCode: Joi.string().allow(""),
-      ean: Joi.string().allow(""),
-      upc: Joi.string().allow(""),
-    });
-  }
-
-  static getProductStockForTimeByIds() {
-    return Joi.object({
-      timestamp: Joi.string().allow("").required(),
-      pageSize: Joi.number(),
-      pageId: Joi.string().allow(""),
-    }).required();
-  }
-
-  static getProducts() {
+  static getCollectionItemsBySlug() {
     return Joi.object({
-      q: Joi.string().allow(""),
+      slug: Joi.string().allow("").required(),
       f: Joi.string().allow(""),
       filters: Joi.boolean(),
       sortOn: Joi.string().allow(""),
       pageId: Joi.string().allow(""),
       pageSize: Joi.number(),
-      pageNo: Joi.number(),
-      pageType: Joi.string().allow(""),
-    });
+    }).required();
   }
 
-  static getBrands() {
+  static getCollections() {
     return Joi.object({
-      department: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      tag: Joi.array().items(Joi.string().allow("")),
     });
   }
 
-  static getBrandDetailBySlug() {
+  static getComparedFrequentlyProductBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getCategories() {
+  static getDepartments() {
+    return Joi.object({});
+  }
+
+  static getFollowIds() {
     return Joi.object({
-      department: Joi.string().allow(""),
+      collectionType: Joi.string().allow(""),
     });
   }
 
-  static getCategoryDetailBySlug() {
+  static getFollowedListing() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
+      collectionType: Joi.string().allow("").required(),
+      pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  static getFollowerCountById() {
+    return Joi.object({
+      collectionType: Joi.string().allow("").required(),
+      collectionId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -104,131 +99,136 @@ class CatalogValidator {
     });
   }
 
-  static getDepartments() {
-    return Joi.object({});
+  static getInStockLocations() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      q: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      range: Joi.number(),
+      latitude: Joi.number(),
+      longitude: Joi.number(),
+    });
   }
 
-  static getSearchResults() {
+  static getLocationDetailsById() {
     return Joi.object({
-      q: Joi.string().allow("").required(),
+      locationId: Joi.number().required(),
     }).required();
   }
 
-  static getCollections() {
+  static getProductBundlesBySlug() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      tag: Joi.array().items(Joi.string().allow("")),
+      slug: Joi.string().allow(""),
+      id: Joi.string().allow(""),
     });
   }
 
-  static getCollectionItemsBySlug() {
+  static getProductComparisonBySlugs() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
-      f: Joi.string().allow(""),
-      filters: Joi.boolean(),
-      sortOn: Joi.string().allow(""),
-      pageId: Joi.string().allow(""),
-      pageSize: Joi.number(),
+      slug: Joi.array().items(Joi.string().allow("")).required(),
     }).required();
   }
 
-  static getCollectionDetailBySlug() {
+  static getProductDetailBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getFollowedListing() {
+  static getProductPriceBySlug() {
     return Joi.object({
-      collectionType: Joi.string().allow("").required(),
-      pageId: Joi.string().allow(""),
-      pageSize: Joi.number(),
+      slug: Joi.string().allow("").required(),
+      size: Joi.string().allow("").required(),
+      storeId: Joi.number(),
+      pincode: Joi.string().allow(""),
+      moq: Joi.number(),
     }).required();
   }
 
-  static followById() {
+  static getProductSellersBySlug() {
     return Joi.object({
-      collectionType: Joi.string().allow("").required(),
-      collectionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      size: Joi.string().allow("").required(),
+      pincode: Joi.string().allow(""),
+      strategy: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
-  static unfollowById() {
+  static getProductSizesBySlug() {
     return Joi.object({
-      collectionType: Joi.string().allow("").required(),
-      collectionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      storeId: Joi.number(),
     }).required();
   }
 
-  static getFollowerCountById() {
+  static getProductStockByIds() {
     return Joi.object({
-      collectionType: Joi.string().allow("").required(),
-      collectionId: Joi.string().allow("").required(),
-    }).required();
+      itemId: Joi.string().allow(""),
+      alu: Joi.string().allow(""),
+      skuCode: Joi.string().allow(""),
+      ean: Joi.string().allow(""),
+      upc: Joi.string().allow(""),
+    });
   }
 
-  static getFollowIds() {
+  static getProductStockForTimeByIds() {
     return Joi.object({
-      collectionType: Joi.string().allow(""),
-    });
+      timestamp: Joi.string().allow("").required(),
+      pageSize: Joi.number(),
+      pageId: Joi.string().allow(""),
+    }).required();
   }
 
-  static getStores() {
+  static getProductVariantsBySlug() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      q: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      range: Joi.number(),
-      latitude: Joi.number(),
-      longitude: Joi.number(),
-    });
+      slug: Joi.string().allow("").required(),
+    }).required();
   }
 
-  static getInStockLocations() {
+  static getProducts() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
       q: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      range: Joi.number(),
-      latitude: Joi.number(),
-      longitude: Joi.number(),
+      f: Joi.string().allow(""),
+      filters: Joi.boolean(),
+      sortOn: Joi.string().allow(""),
+      pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+      pageType: Joi.string().allow(""),
     });
   }
 
-  static getLocationDetailsById() {
+  static getSearchResults() {
     return Joi.object({
-      locationId: Joi.number().required(),
+      q: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getProductBundlesBySlug() {
-    return Joi.object({
-      slug: Joi.string().allow(""),
-      id: Joi.string().allow(""),
-    });
-  }
-
-  static getProductPriceBySlug() {
+  static getSimilarComparisonProductBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      size: Joi.string().allow("").required(),
-      storeId: Joi.number(),
-      pincode: Joi.string().allow(""),
-      moq: Joi.number(),
     }).required();
   }
 
-  static getProductSellersBySlug() {
+  static getStores() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
-      size: Joi.string().allow("").required(),
-      pincode: Joi.string().allow(""),
-      strategy: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      q: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      range: Joi.number(),
+      latitude: Joi.number(),
+      longitude: Joi.number(),
+    });
+  }
+
+  static unfollowById() {
+    return Joi.object({
+      collectionType: Joi.string().allow("").required(),
+      collectionId: Joi.string().allow("").required(),
     }).required();
   }
 }

package/sdk/application/Common/CommonApplicationClient.d.ts

@@ -3,23 +3,11 @@ declare class Common {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
-        searchApplication: string;
         getLocations: string;
+        searchApplication: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.authorization] -
-     * @param {string} [arg.query] - Provide application name
-     * @returns {Promise<ApplicationResponse>} - Success response
-     * @summary: Search Application
-     * @description: Provide application name or domain url
-     */
-    searchApplication({ authorization, query }?: {
-        authorization?: string;
-        query?: string;
-    }): Promise<ApplicationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.locationType] - Provide location type to query on.
@@ -35,4 +23,16 @@ declare class Common {
         locationType?: string;
         id?: string;
     }): Promise<Locations>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.authorization] -
+     * @param {string} [arg.query] - Provide application name
+     * @returns {Promise<ApplicationResponse>} - Success response
+     * @summary: Search Application
+     * @description: Provide application name or domain url
+     */
+    searchApplication({ authorization, query }?: {
+        authorization?: string;
+        query?: string;
+    }): Promise<ApplicationResponse>;
 }

package/sdk/application/Common/CommonApplicationClient.js

@@ -1,18 +1,19 @@
-const APIClient = require("../ApplicationAPIClient");
+const ApplicationAPIClient = require("../ApplicationAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const CommonValidator = require("./CommonApplicationValidator");
 const CommonModel = require("./CommonApplicationModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Common {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
+      getLocations: "/service/common/configuration/v1.0/location",
       searchApplication:
         "/service/common/configuration/v1.0/application/search-application",
-      getLocations: "/service/common/configuration/v1.0/location",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -32,15 +33,18 @@ class Common {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} [arg.authorization] -
-   * @param {string} [arg.query] - Provide application name
-   * @returns {Promise<ApplicationResponse>} - Success response
-   * @summary: Search Application
-   * @description: Provide application name or domain url
+   * @param {string} [arg.locationType] - Provide location type to query on.
+   *   Possible values : country, state, city
+   * @param {string} [arg.id] - Field is optional when location_type is
+   *   country. If querying for state, provide id of country. If querying for
+   *   city, provide id of state.
+   * @returns {Promise<Locations>} - Success response
+   * @summary: Get countries, states, cities
+   * @description:
    */
-  async searchApplication({ authorization, query } = {}) {
-    const { error } = CommonValidator.searchApplication().validate(
-      { authorization, query },
+  async getLocations({ locationType, id } = {}) {
+    const { error } = CommonValidator.getLocations().validate(
+      { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -48,29 +52,29 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.searchApplication().validate(
-      { authorization, query },
+    const { error: warrning } = CommonValidator.getLocations().validate(
+      { locationType, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for searchApplication",
+        message: "Parameter Validation warrnings for getLocations",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["query"] = query;
+    query_params["location_type"] = locationType;
+    query_params["id"] = id;
 
     const xHeaders = {};
-    xHeaders["authorization"] = authorization;
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["searchApplication"],
+        url: this._urls["getLocations"],
         params: {},
       }),
       query_params,
@@ -78,9 +82,7 @@ class Common {
       xHeaders
     );
 
-    const {
-      error: res_error,
-    } = CommonModel.ApplicationResponse().validate(response, {
+    const { error: res_error } = CommonModel.Locations().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -88,7 +90,7 @@ class Common {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for searchApplication",
+        message: "Response Validation Warnnings for getLocations",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -98,18 +100,15 @@ class Common {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} [arg.locationType] - Provide location type to query on.
-   *   Possible values : country, state, city
-   * @param {string} [arg.id] - Field is optional when location_type is
-   *   country. If querying for state, provide id of country. If querying for
-   *   city, provide id of state.
-   * @returns {Promise<Locations>} - Success response
-   * @summary: Get countries, states, cities
-   * @description:
+   * @param {string} [arg.authorization] -
+   * @param {string} [arg.query] - Provide application name
+   * @returns {Promise<ApplicationResponse>} - Success response
+   * @summary: Search Application
+   * @description: Provide application name or domain url
    */
-  async getLocations({ locationType, id } = {}) {
-    const { error } = CommonValidator.getLocations().validate(
-      { locationType, id },
+  async searchApplication({ authorization, query } = {}) {
+    const { error } = CommonValidator.searchApplication().validate(
+      { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -117,29 +116,29 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.getLocations().validate(
-      { locationType, id },
+    const { error: warrning } = CommonValidator.searchApplication().validate(
+      { authorization, query },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocations",
+        message: "Parameter Validation warrnings for searchApplication",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["location_type"] = locationType;
-    query_params["id"] = id;
+    query_params["query"] = query;
 
     const xHeaders = {};
+    xHeaders["authorization"] = authorization;
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getLocations"],
+        url: this._urls["searchApplication"],
         params: {},
       }),
       query_params,
@@ -147,7 +146,9 @@ class Common {
       xHeaders
     );
 
-    const { error: res_error } = CommonModel.Locations().validate(response, {
+    const {
+      error: res_error,
+    } = CommonModel.ApplicationResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -155,7 +156,7 @@ class Common {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: "Response Validation Warnnings for searchApplication",
       });
       Logger({ level: "WARN", message: res_error });
     }

package/sdk/application/Common/CommonApplicationModel.d.ts

@@ -1,20 +1,20 @@
 export = CommonModel;
 declare class CommonModel {
-    static ApplicationResponse(): any;
-    static Currency(): any;
-    static Domain(): any;
-    static ApplicationWebsite(): any;
-    static ApplicationCors(): any;
+    static Application(): any;
     static ApplicationAuth(): any;
-    static ApplicationRedirections(): any;
+    static ApplicationCors(): any;
     static ApplicationMeta(): any;
-    static SecureUrl(): any;
-    static Application(): any;
-    static NotFound(): any;
+    static ApplicationRedirections(): any;
+    static ApplicationResponse(): any;
+    static ApplicationWebsite(): any;
     static BadRequest(): any;
-    static Page(): any;
-    static LocationDefaultLanguage(): any;
-    static LocationDefaultCurrency(): any;
+    static Currency(): any;
+    static Domain(): any;
     static LocationCountry(): any;
+    static LocationDefaultCurrency(): any;
+    static LocationDefaultLanguage(): any;
     static Locations(): any;
+    static NotFound(): any;
+    static Page(): any;
+    static SecureUrl(): any;
 }