@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/Common/CommonPlatformClient.d.ts

@@ -2,17 +2,6 @@ export = Common;
 declare class Common {
     constructor(config: any);
     config: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.authorization] -
-     * @param {string} [arg.query] - Provide application name
-     * @summary: Search Application
-     * @description: Provide application name or domain url
-     */
-    searchApplication({ authorization, query }?: {
-        authorization?: string;
-        query?: string;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.locationType] - Provide location type to query on.
@@ -20,11 +9,24 @@ declare class Common {
      * @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:
      */
     getLocations({ locationType, id }?: {
         locationType?: string;
         id?: string;
-    }): Promise<any>;
+    }): 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/platform/Common/CommonPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const CommonValidator = require("./CommonPlatformValidator");
+const CommonModel = require("./CommonPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Common {
   constructor(config) {
     this.config = config;
@@ -9,16 +12,20 @@ class Common {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} [arg.authorization] -
-   * @param {string} [arg.query] - Provide application name
-   * @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:
    */
-  searchApplication({ authorization, query } = {}) {
-    const { error } = CommonValidator.searchApplication().validate(
+  async getLocations({ locationType, id } = {}) {
+    const { error } = CommonValidator.getLocations().validate(
       {
-        authorization,
-        query,
+        locationType,
+        id,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -27,49 +34,65 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.searchApplication().validate(
+    const { error: warrning } = CommonValidator.getLocations().validate(
       {
-        authorization,
-        query,
+        locationType,
+        id,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for searchApplication");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        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;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/common/configuration/v1.0/application/search-application`,
+      `/service/common/configuration/v1.0/location`,
       query_params,
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = CommonModel.Locations().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getLocations",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @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.
-   * @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
    */
-  getLocations({ locationType, id } = {}) {
-    const { error } = CommonValidator.getLocations().validate(
+  async searchApplication({ authorization, query } = {}) {
+    const { error } = CommonValidator.searchApplication().validate(
       {
-        locationType,
-        id,
+        authorization,
+        query,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -78,32 +101,52 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.getLocations().validate(
+    const { error: warrning } = CommonValidator.searchApplication().validate(
       {
-        locationType,
-        id,
+        authorization,
+        query,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getLocations");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        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;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/common/configuration/v1.0/location`,
+      `/service/common/configuration/v1.0/application/search-application`,
       query_params,
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = CommonModel.ApplicationResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for searchApplication",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 

package/sdk/platform/Common/CommonPlatformModel.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;
 }

package/sdk/platform/Common/CommonPlatformModel.js

@@ -1,228 +1,151 @@
 const Joi = require("joi");
 
 class CommonModel {
-  static ApplicationResponse() {
-    return Joi.object({
-      application: CommonModel.Application(),
-    });
-  }
-
-  static Currency() {
+  static Application() {
     return Joi.object({
+      __v: Joi.number(),
       _id: Joi.string().allow(""),
-
+      app_type: Joi.string().allow(""),
+      auth: CommonModel.ApplicationAuth(),
+      banner: CommonModel.SecureUrl(),
+      cache_ttl: Joi.number(),
+      channel_type: Joi.string().allow(""),
+      company_id: Joi.number(),
+      cors: CommonModel.ApplicationCors(),
+      created_at: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      domain: CommonModel.Domain(),
+      domains: Joi.array().items(CommonModel.Domain()),
+      favicon: CommonModel.SecureUrl(),
       is_active: Joi.boolean(),
-
+      is_internal: Joi.boolean(),
+      logo: CommonModel.SecureUrl(),
+      meta: Joi.array().items(CommonModel.ApplicationMeta()),
+      mobile_logo: CommonModel.SecureUrl(),
       name: Joi.string().allow(""),
-
-      code: Joi.string().allow(""),
-
-      created_at: Joi.string().allow(""),
-
+      owner: Joi.string().allow(""),
+      redirections: Joi.array().items(CommonModel.ApplicationRedirections()),
+      token: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
-
-      decimal_digits: Joi.number(),
-
-      symbol: Joi.string().allow(""),
-    });
-  }
-
-  static Domain() {
-    return Joi.object({
-      verified: Joi.boolean(),
-
-      is_primary: Joi.boolean(),
-
-      is_shortlink: Joi.boolean(),
-
-      _id: Joi.string().allow(""),
-
-      name: Joi.string().allow(""),
-
-      is_predefined: Joi.boolean(),
+      website: CommonModel.ApplicationWebsite(),
     });
   }
-
-  static ApplicationWebsite() {
+  static ApplicationAuth() {
     return Joi.object({
       enabled: Joi.boolean(),
-
-      basepath: Joi.string().allow(""),
     });
   }
-
   static ApplicationCors() {
     return Joi.object({
       domains: Joi.array().items(Joi.string().allow("")),
     });
   }
-
-  static ApplicationAuth() {
+  static ApplicationMeta() {
     return Joi.object({
-      enabled: Joi.boolean(),
+      name: Joi.string().allow(""),
+      value: Joi.string().allow(""),
     });
   }
-
   static ApplicationRedirections() {
     return Joi.object({
       redirect_from: Joi.string().allow(""),
-
       redirect_to: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
     });
   }
-
-  static ApplicationMeta() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-
-      value: Joi.string().allow(""),
-    });
-  }
-
-  static SecureUrl() {
-    return Joi.object({
-      secure_url: Joi.string().allow(""),
-    });
-  }
-
-  static Application() {
+  static ApplicationResponse() {
     return Joi.object({
-      website: CommonModel.ApplicationWebsite(),
-
-      cors: CommonModel.ApplicationCors(),
-
-      auth: CommonModel.ApplicationAuth(),
-
-      description: Joi.string().allow(""),
-
-      channel_type: Joi.string().allow(""),
-
-      cache_ttl: Joi.number(),
-
-      is_internal: Joi.boolean(),
-
-      is_active: Joi.boolean(),
-
-      _id: Joi.string().allow(""),
-
-      name: Joi.string().allow(""),
-
-      owner: Joi.string().allow(""),
-
-      company_id: Joi.number(),
-
-      token: Joi.string().allow(""),
-
-      redirections: Joi.array().items(CommonModel.ApplicationRedirections()),
-
-      meta: Joi.array().items(CommonModel.ApplicationMeta()),
-
-      created_at: Joi.string().allow(""),
-
-      updated_at: Joi.string().allow(""),
-
-      __v: Joi.number(),
-
-      banner: CommonModel.SecureUrl(),
-
-      logo: CommonModel.SecureUrl(),
-
-      favicon: CommonModel.SecureUrl(),
-
-      domains: Joi.array().items(CommonModel.Domain()),
-
-      app_type: Joi.string().allow(""),
-
-      mobile_logo: CommonModel.SecureUrl(),
-
-      domain: CommonModel.Domain(),
+      application: CommonModel.Application(),
     });
   }
-
-  static NotFound() {
+  static ApplicationWebsite() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      basepath: Joi.string().allow(""),
+      enabled: Joi.boolean(),
     });
   }
-
   static BadRequest() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
-
-  static Page() {
-    return Joi.object({
-      item_total: Joi.number(),
-
-      next_id: Joi.string().allow(""),
-
-      has_previous: Joi.boolean(),
-
-      has_next: Joi.boolean(),
-
-      current: Joi.number(),
-
-      type: Joi.string().allow("").required(),
-
-      size: Joi.number(),
-    });
-  }
-
-  static LocationDefaultLanguage() {
+  static Currency() {
     return Joi.object({
-      name: Joi.string().allow(""),
-
+      _id: Joi.string().allow(""),
       code: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      decimal_digits: Joi.number(),
+      is_active: Joi.boolean(),
+      name: Joi.string().allow(""),
+      symbol: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
     });
   }
-
-  static LocationDefaultCurrency() {
+  static Domain() {
     return Joi.object({
+      _id: Joi.string().allow(""),
+      is_predefined: Joi.boolean(),
+      is_primary: Joi.boolean(),
+      is_shortlink: Joi.boolean(),
       name: Joi.string().allow(""),
-
-      symbol: Joi.string().allow(""),
-
-      code: Joi.string().allow(""),
+      verified: Joi.boolean(),
     });
   }
-
   static LocationCountry() {
     return Joi.object({
+      __v: Joi.number(),
+      _id: Joi.string().allow(""),
       capital: Joi.string().allow(""),
-
       currency: Joi.string().allow(""),
-
+      default_currency: CommonModel.LocationDefaultCurrency(),
+      default_language: CommonModel.LocationDefaultLanguage(),
       iso2: Joi.string().allow(""),
-
       iso3: Joi.string().allow(""),
-
       name: Joi.string().allow(""),
-
       parent: Joi.string().allow(""),
-
       phone_code: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
-
       uid: Joi.number(),
-
-      __v: Joi.number(),
-
-      _id: Joi.string().allow(""),
-
-      default_currency: CommonModel.LocationDefaultCurrency(),
-
-      default_language: CommonModel.LocationDefaultLanguage(),
     });
   }
-
+  static LocationDefaultCurrency() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      symbol: Joi.string().allow(""),
+    });
+  }
+  static LocationDefaultLanguage() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+    });
+  }
   static Locations() {
     return Joi.object({
       items: Joi.array().items(Joi.any()),
     });
   }
+  static NotFound() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+  static Page() {
+    return Joi.object({
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
+    });
+  }
+  static SecureUrl() {
+    return Joi.object({
+      secure_url: Joi.string().allow(""),
+    });
+  }
 }
 module.exports = CommonModel;

package/sdk/platform/Common/CommonPlatformValidator.d.ts

@@ -1,5 +1,5 @@
 export = CommonValidator;
 declare class CommonValidator {
-    static searchApplication(): any;
     static getLocations(): any;
+    static searchApplication(): any;
 }

package/sdk/platform/Common/CommonPlatformValidator.js

@@ -2,17 +2,17 @@ const Joi = require("joi");
 
 const CommonModel = require("./CommonPlatformModel");
 class CommonValidator {
-  static searchApplication() {
+  static getLocations() {
     return Joi.object({
-      authorization: Joi.string().allow(""),
-      query: Joi.string().allow(""),
+      locationType: Joi.string().allow(""),
+      id: Joi.string().allow(""),
     });
   }
 
-  static getLocations() {
+  static searchApplication() {
     return Joi.object({
-      locationType: Joi.string().allow(""),
-      id: Joi.string().allow(""),
+      authorization: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     });
   }
 }