@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -1,193 +1,125 @@
 const Joi = require("joi");
 
 class WebhookModel {
+  static Association() {
+    return Joi.object({
+      application_id: Joi.array().items(Joi.string().allow("")),
+      company_id: Joi.number(),
+      criteria: Joi.string().allow(""),
+      extension_id: Joi.string().allow(""),
+    });
+  }
+  static AuthMeta() {
+    return Joi.object({
+      secret: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+    });
+  }
   static EventConfig() {
     return Joi.object({
-      id: Joi.number(),
-
+      created_on: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      event_category: Joi.string().allow(""),
       event_name: Joi.string().allow(""),
-
       event_type: Joi.string().allow(""),
-
+      id: Joi.number(),
+      version: Joi.string().allow(""),
+    });
+  }
+  static EventConfigBase() {
+    return Joi.object({
       event_category: Joi.string().allow(""),
-
+      event_name: Joi.string().allow(""),
+      event_type: Joi.string().allow(""),
       version: Joi.string().allow(""),
-
-      display_name: Joi.string().allow(""),
-
-      description: Joi.string().allow(""),
-
-      created_on: Joi.string().allow(""),
     });
   }
-
   static EventConfigList() {
     return Joi.object({
       items: Joi.array().items(WebhookModel.EventConfig()),
-
       page: WebhookModel.Page(),
     });
   }
-
   static EventConfigResponse() {
     return Joi.object({
       event_configs: Joi.array().items(WebhookModel.EventConfig()),
     });
   }
-
-  static SubscriberConfigList() {
-    return Joi.object({
-      items: Joi.array().items(WebhookModel.SubscriberResponse()),
-
-      page: WebhookModel.Page(),
-    });
-  }
-
-  static Page() {
+  static EventPayload() {
     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(),
+      event_name: Joi.string().allow(""),
+      event_trace_id: Joi.string().allow(""),
+      event_type: Joi.string().allow(""),
+      id: Joi.number(),
+      message_id: Joi.string().allow(""),
+      status: Joi.boolean(),
+      version: Joi.string().allow(""),
     });
   }
-
   static EventProcessedStatus() {
     return Joi.object({
-      id: Joi.number(),
-
-      subscriber_id: Joi.string().allow(""),
-
       attempt: Joi.number(),
-
-      response_code: Joi.string().allow(""),
-
-      response_message: Joi.string().allow(""),
-
       created_on: Joi.string().allow(""),
-
+      id: Joi.number(),
       processed_on: Joi.string().allow(""),
-
+      response_code: Joi.string().allow(""),
+      response_message: Joi.string().allow(""),
       status: Joi.boolean(),
+      subscriber_id: Joi.string().allow(""),
     });
   }
-
-  static EventPayload() {
+  static Page() {
     return Joi.object({
-      id: Joi.number(),
-
-      event_trace_id: Joi.string().allow(""),
-
-      message_id: Joi.string().allow(""),
-
-      event_name: Joi.string().allow(""),
-
-      event_type: Joi.string().allow(""),
-
-      version: Joi.string().allow(""),
-
-      status: Joi.boolean(),
+      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 SubscriberConfig() {
     return Joi.object({
-      id: Joi.number(),
-
-      name: Joi.string().allow(""),
-
-      webhook_url: Joi.string().allow(""),
-
       association: WebhookModel.Association(),
-
+      auth_meta: WebhookModel.AuthMeta(),
       custom_headers: Joi.any(),
-
-      status: WebhookModel.SubscriberStatus(),
-
       email_id: Joi.string().allow(""),
-
-      auth_meta: WebhookModel.AuthMeta(),
-
       event_id: Joi.array().items(Joi.number()),
-    });
-  }
-
-  static SubscriberResponse() {
-    return Joi.object({
       id: Joi.number(),
-
       name: Joi.string().allow(""),
-
-      webhook_url: Joi.string().allow(""),
-
-      association: WebhookModel.Association(),
-
-      custom_headers: Joi.any(),
-
-      email_id: Joi.string().allow(""),
-
       status: WebhookModel.SubscriberStatus(),
-
-      auth_meta: WebhookModel.AuthMeta(),
-
-      created_on: Joi.string().allow(""),
-
-      updated_on: Joi.string().allow(""),
-
-      event_configs: Joi.array().items(WebhookModel.EventConfig()),
-    });
-  }
-
-  static SubscriberEvent() {
-    return Joi.object({
-      id: Joi.number(),
-
-      subscriber_id: Joi.number(),
-
-      event_id: Joi.number(),
-
-      created_date: Joi.string().allow(""),
+      webhook_url: Joi.string().allow(""),
     });
   }
-
-  static AuthMeta() {
+  static SubscriberConfigList() {
     return Joi.object({
-      type: Joi.string().allow(""),
-
-      secret: Joi.string().allow(""),
+      items: Joi.array().items(WebhookModel.SubscriberResponse()),
+      page: WebhookModel.Page(),
     });
   }
-
-  static Association() {
+  static SubscriberEvent() {
     return Joi.object({
-      company_id: Joi.number(),
-
-      application_id: Joi.array().items(Joi.string().allow("")),
-
-      extension_id: Joi.string().allow(""),
-
-      criteria: Joi.string().allow(""),
+      created_date: Joi.string().allow(""),
+      event_id: Joi.number(),
+      id: Joi.number(),
+      subscriber_id: Joi.number(),
     });
   }
-
-  static EventConfigBase() {
+  static SubscriberResponse() {
     return Joi.object({
-      event_name: Joi.string().allow(""),
-
-      event_type: Joi.string().allow(""),
-
-      event_category: Joi.string().allow(""),
-
-      version: Joi.string().allow(""),
+      association: WebhookModel.Association(),
+      auth_meta: WebhookModel.AuthMeta(),
+      created_on: Joi.string().allow(""),
+      custom_headers: Joi.any(),
+      email_id: Joi.string().allow(""),
+      event_configs: Joi.array().items(WebhookModel.EventConfig()),
+      id: Joi.number(),
+      name: Joi.string().allow(""),
+      status: WebhookModel.SubscriberStatus(),
+      updated_on: Joi.string().allow(""),
+      webhook_url: Joi.string().allow(""),
     });
   }
 

package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts

@@ -1,9 +1,9 @@
 export = WebhookValidator;
 declare class WebhookValidator {
+    static fetchAllEventConfigurations(): any;
+    static getSubscriberById(): any;
     static getSubscribersByCompany(): any;
+    static getSubscribersByExtensionId(): any;
     static registerSubscriberToEvent(): any;
     static updateSubscriberConfig(): any;
-    static getSubscribersByExtensionId(): any;
-    static getSubscriberById(): any;
-    static fetchAllEventConfigurations(): any;
 }

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -2,23 +2,21 @@ const Joi = require("joi");
 
 const WebhookModel = require("./WebhookPlatformModel");
 class WebhookValidator {
-  static getSubscribersByCompany() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      extensionId: Joi.string().allow(""),
-    }).required();
+  static fetchAllEventConfigurations() {
+    return Joi.object({}).required();
   }
 
-  static registerSubscriberToEvent() {
+  static getSubscriberById() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      subscriberId: Joi.number().required(),
     }).required();
   }
 
-  static updateSubscriberConfig() {
+  static getSubscribersByCompany() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      extensionId: Joi.string().allow(""),
     }).required();
   }
 
@@ -30,14 +28,17 @@ class WebhookValidator {
     }).required();
   }
 
-  static getSubscriberById() {
+  static registerSubscriberToEvent() {
     return Joi.object({
-      subscriberId: Joi.number().required(),
+      body: WebhookModel.SubscriberConfig().required(),
     }).required();
   }
 
-  static fetchAllEventConfigurations() {
-    return Joi.object({}).required();
+  static updateSubscriberConfig() {
+    return Joi.object({
+      body: WebhookModel.SubscriberConfig().required(),
+    }).required();
   }
 }
+
 module.exports = WebhookValidator;

package/sdk/public/Configuration/ConfigurationPublicClient.d.ts

@@ -3,23 +3,11 @@ declare class Configuration {
     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 Configuration {
         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/public/Configuration/ConfigurationPublicClient.js

@@ -5,14 +5,15 @@ const Paginator = require("../../common/Paginator");
 const ConfigurationValidator = require("./ConfigurationPublicValidator");
 const ConfigurationModel = require("./ConfigurationPublicModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Configuration {
   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 Configuration {
 
   /**
    * @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 } = ConfigurationValidator.searchApplication().validate(
-      { authorization, query },
+  async getLocations({ locationType, id } = {}) {
+    const { error } = ConfigurationValidator.getLocations().validate(
+      { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -48,31 +52,29 @@ class Configuration {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ConfigurationValidator.searchApplication().validate(
-      { authorization, query },
+    const { error: warrning } = ConfigurationValidator.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 PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["searchApplication"],
+        url: this._urls["getLocations"],
         params: {},
       }),
       query_params,
@@ -82,7 +84,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationModel.ApplicationResponse().validate(response, {
+    } = ConfigurationModel.Locations().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -90,7 +92,7 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for searchApplication",
+        message: "Response Validation Warnnings for getLocations",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -100,18 +102,15 @@ class Configuration {
 
   /**
    * @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 } = ConfigurationValidator.getLocations().validate(
-      { locationType, id },
+  async searchApplication({ authorization, query } = {}) {
+    const { error } = ConfigurationValidator.searchApplication().validate(
+      { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -119,29 +118,31 @@ class Configuration {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ConfigurationValidator.getLocations().validate(
-      { locationType, id },
+    const {
+      error: warrning,
+    } = ConfigurationValidator.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 PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getLocations"],
+        url: this._urls["searchApplication"],
         params: {},
       }),
       query_params,
@@ -151,7 +152,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationModel.Locations().validate(response, {
+    } = ConfigurationModel.ApplicationResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -159,7 +160,7 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: "Response Validation Warnnings for searchApplication",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -167,4 +168,5 @@ class Configuration {
     return response;
   }
 }
+
 module.exports = Configuration;

package/sdk/public/Configuration/ConfigurationPublicModel.d.ts

@@ -1,20 +1,20 @@
 export = ConfigurationModel;
 declare class ConfigurationModel {
-    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;
 }