@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/{client → Webhook}/WebhookPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const WebhookValidator = require("../models/WebhookValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const WebhookValidator = require("./WebhookPlatformValidator");
 class Webhook {
   constructor(config) {
     this.config = config;
@@ -28,6 +28,22 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.getSubscribersByCompany().validate(
+      {
+        pageNo,
+        pageSize,
+        extensionId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getSubscribersByCompany");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -62,6 +78,22 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.registerSubscriberToEvent().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log(
+        "Parameter Validation warrnings for registerSubscriberToEvent"
+      );
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -93,6 +125,20 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.updateSubscriberConfig().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for updateSubscriberConfig");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -128,6 +174,24 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.getSubscribersByExtensionId().validate(
+      {
+        extensionId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log(
+        "Parameter Validation warrnings for getSubscribersByExtensionId"
+      );
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -161,6 +225,18 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = WebhookValidator.getSubscriberById().validate(
+      {
+        subscriberId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getSubscriberById");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -189,6 +265,20 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.fetchAllEventConfigurations().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log(
+        "Parameter Validation warrnings for fetchAllEventConfigurations"
+      );
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};

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

@@ -0,0 +1,17 @@
+export = WebhookModel;
+declare class WebhookModel {
+    static EventConfig(): any;
+    static EventConfigList(): any;
+    static EventConfigResponse(): any;
+    static SubscriberConfigList(): any;
+    static Page(): any;
+    static EventProcessedStatus(): any;
+    static EventPayload(): any;
+    static SubscriberConfig(): any;
+    static SubscriberResponse(): any;
+    static SubscriberEvent(): any;
+    static AuthMeta(): any;
+    static Association(): any;
+    static EventConfigBase(): any;
+    static SubscriberStatus(): any;
+}

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -0,0 +1,208 @@
+const Joi = require("joi");
+
+class WebhookModel {
+  static EventConfig() {
+    return Joi.object({
+      id: Joi.number(),
+
+      event_name: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      event_category: 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() {
+    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 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(""),
+
+      processed_on: Joi.string().allow(""),
+
+      status: Joi.boolean(),
+    });
+  }
+
+  static EventPayload() {
+    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(),
+    });
+  }
+
+  static SubscriberConfig() {
+    return Joi.object({
+      id: Joi.number(),
+
+      name: Joi.string().allow(""),
+
+      webhook_url: Joi.string().allow(""),
+
+      association: WebhookModel.Association(),
+
+      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(""),
+    });
+  }
+
+  static AuthMeta() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+
+      secret: Joi.string().allow(""),
+    });
+  }
+
+  static Association() {
+    return Joi.object({
+      company_id: Joi.number(),
+
+      application_id: Joi.array().items(Joi.string().allow("")),
+
+      extension_id: Joi.string().allow(""),
+
+      criteria: Joi.string().allow(""),
+    });
+  }
+
+  static EventConfigBase() {
+    return Joi.object({
+      event_name: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      event_category: Joi.string().allow(""),
+
+      version: Joi.string().allow(""),
+    });
+  }
+
+  /*
+        Enum: SubscriberStatus
+        Used By: Webhook
+    */
+  static SubscriberStatus() {
+    return Joi.string().valid(
+      "active",
+
+      "inactive",
+
+      "blocked"
+    );
+  }
+}
+module.exports = WebhookModel;

package/sdk/platform/{models/WebhookValidator.js → Webhook/WebhookPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const WebhookModel = require("./WebhookPlatformModel");
 class WebhookValidator {
   static getSubscribersByCompany() {
     return Joi.object({
@@ -11,13 +12,13 @@ class WebhookValidator {
 
   static registerSubscriberToEvent() {
     return Joi.object({
-      body: Validator.SubscriberConfig().required(),
+      body: WebhookModel.SubscriberConfig().required(),
     }).required();
   }
 
   static updateSubscriberConfig() {
     return Joi.object({
-      body: Validator.SubscriberConfig().required(),
+      body: WebhookModel.SubscriberConfig().required(),
     }).required();
   }
 

package/sdk/platform/index.d.ts

@@ -1,2 +1,26 @@
 export const PlatformConfig: typeof import("./PlatformConfig");
 export const PlatformClient: typeof import("./PlatformClient");
+export namespace PlatformModel {
+    const CommonPlatformModel: typeof import("./Common/CommonPlatformModel");
+    const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
+    const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
+    const UserPlatformModel: typeof import("./User/UserPlatformModel");
+    const ContentPlatformModel: typeof import("./Content/ContentPlatformModel");
+    const BillingPlatformModel: typeof import("./Billing/BillingPlatformModel");
+    const CommunicationPlatformModel: typeof import("./Communication/CommunicationPlatformModel");
+    const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
+    const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
+    const CatalogPlatformModel: typeof import("./Catalog/CatalogPlatformModel");
+    const CompanyProfilePlatformModel: typeof import("./CompanyProfile/CompanyProfilePlatformModel");
+    const FileStoragePlatformModel: typeof import("./FileStorage/FileStoragePlatformModel");
+    const SharePlatformModel: typeof import("./Share/SharePlatformModel");
+    const InventoryPlatformModel: typeof import("./Inventory/InventoryPlatformModel");
+    const ConfigurationPlatformModel: typeof import("./Configuration/ConfigurationPlatformModel");
+    const CartPlatformModel: typeof import("./Cart/CartPlatformModel");
+    const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
+    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
+    const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
+    const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
+    const WebhookPlatformModel: typeof import("./Webhook/WebhookPlatformModel");
+    const AuditTrailPlatformModel: typeof import("./AuditTrail/AuditTrailPlatformModel");
+}

package/sdk/platform/index.js

@@ -1,4 +1,49 @@
 module.exports = {
   PlatformConfig: require("./PlatformConfig"),
   PlatformClient: require("./PlatformClient"),
+  PlatformModel: {
+    CommonPlatformModel: require("./Common/CommonPlatformModel"),
+
+    LeadPlatformModel: require("./Lead/LeadPlatformModel"),
+
+    ThemePlatformModel: require("./Theme/ThemePlatformModel"),
+
+    UserPlatformModel: require("./User/UserPlatformModel"),
+
+    ContentPlatformModel: require("./Content/ContentPlatformModel"),
+
+    BillingPlatformModel: require("./Billing/BillingPlatformModel"),
+
+    CommunicationPlatformModel: require("./Communication/CommunicationPlatformModel"),
+
+    PaymentPlatformModel: require("./Payment/PaymentPlatformModel"),
+
+    OrderPlatformModel: require("./Order/OrderPlatformModel"),
+
+    CatalogPlatformModel: require("./Catalog/CatalogPlatformModel"),
+
+    CompanyProfilePlatformModel: require("./CompanyProfile/CompanyProfilePlatformModel"),
+
+    FileStoragePlatformModel: require("./FileStorage/FileStoragePlatformModel"),
+
+    SharePlatformModel: require("./Share/SharePlatformModel"),
+
+    InventoryPlatformModel: require("./Inventory/InventoryPlatformModel"),
+
+    ConfigurationPlatformModel: require("./Configuration/ConfigurationPlatformModel"),
+
+    CartPlatformModel: require("./Cart/CartPlatformModel"),
+
+    RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
+
+    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
+
+    DiscountPlatformModel: require("./Discount/DiscountPlatformModel"),
+
+    PartnerPlatformModel: require("./Partner/PartnerPlatformModel"),
+
+    WebhookPlatformModel: require("./Webhook/WebhookPlatformModel"),
+
+    AuditTrailPlatformModel: require("./AuditTrail/AuditTrailPlatformModel"),
+  },
 };

package/sdk/public/{client → Configuration}/ConfigurationPublicClient.js

@@ -1,7 +1,8 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
-const ConfigurationValidator = require("../models/ConfigurationValidator");
+const Paginator = require("../../common/Paginator");
+const ConfigurationValidator = require("./ConfigurationPublicValidator");
 class Configuration {
   constructor(_conf) {
     this._conf = _conf;
@@ -42,6 +43,19 @@ class Configuration {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ConfigurationValidator.searchApplication().validate(
+      { authorization, query },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for searchApplication");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["query"] = query;
 
@@ -80,6 +94,17 @@ class Configuration {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ConfigurationValidator.getLocations().validate(
+      { locationType, id },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getLocations");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["location_type"] = locationType;
     query_params["id"] = id;

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

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