@gofynd/fdk-client-javascript 0.1.37 → 1.0.0

package/sdk/public/Inventory/InventoryPublicModel.js

@@ -0,0 +1,334 @@
+const Joi = require("joi");
+
+class InventoryModel {
+  static EmailJobMetrics() {
+    return Joi.object({
+      executed: Joi.boolean(),
+
+      id: Joi.string().allow(""),
+
+      job_code: Joi.string().allow(""),
+
+      daily_job: Joi.boolean(),
+
+      last_executed_on: Joi.string().allow(""),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+
+      current: Joi.number(),
+
+      has_next: Joi.boolean(),
+
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+    });
+  }
+
+  static ResponseEnvelopeEmailJobMetrics() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: InventoryModel.EmailJobMetrics(),
+
+      payload: InventoryModel.EmailJobMetrics(),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+
+  static GCompany() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      integration: Joi.string().allow(""),
+
+      level: Joi.string().allow(""),
+
+      uid: Joi.number(),
+
+      opted: Joi.boolean(),
+
+      permissions: Joi.array().items(Joi.string().allow("")),
+
+      token: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      stores: Joi.array().items(InventoryModel.GStore()),
+    });
+  }
+
+  static GStore() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      integration: Joi.string().allow(""),
+
+      level: Joi.string().allow(""),
+
+      uid: Joi.number(),
+
+      opted: Joi.boolean(),
+
+      permissions: Joi.array().items(Joi.string().allow("")),
+
+      token: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      data: InventoryModel.StoreData(),
+    });
+  }
+
+  static Metum() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      value: Joi.string().allow(""),
+    });
+  }
+
+  static ResponseEnvelopeSlingshotConfigurationDetail() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: InventoryModel.SlingshotConfigurationDetail(),
+
+      payload: InventoryModel.SlingshotConfigurationDetail(),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+
+  static SlingshotConfigurationDetail() {
+    return Joi.object({
+      integration: InventoryModel.SlingshotIntegration(),
+
+      companies: Joi.array().items(InventoryModel.GCompany()),
+    });
+  }
+
+  static SlingshotIntegration() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      slug: Joi.string().allow(""),
+
+      meta: Joi.array().items(InventoryModel.Metum()),
+    });
+  }
+
+  static StoreData() {
+    return Joi.object({
+      location_id: Joi.string().allow(""),
+    });
+  }
+
+  static ApikeyModel() {
+    return Joi.object({
+      session_id: Joi.string().allow(""),
+
+      error_message: Joi.string().allow(""),
+    });
+  }
+
+  static ResponseEnvelopeApikeyModel() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: InventoryModel.ApikeyModel(),
+
+      payload: InventoryModel.ApikeyModel(),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+
+  static DataTresholdDTO() {
+    return Joi.object({
+      min_price: Joi.number(),
+
+      safe_stock: Joi.number(),
+
+      period_threshold: Joi.number(),
+
+      period_threshold_type: Joi.string().allow(""),
+
+      period_type_list: Joi.array().items(InventoryModel.GenericDTO()),
+    });
+  }
+
+  static GenericDTO() {
+    return Joi.object({
+      text: Joi.string().allow(""),
+
+      value: Joi.any(),
+    });
+  }
+
+  static JobConfigDTO() {
+    return Joi.object({
+      integration_data: Joi.object().pattern(/\S/, Joi.any()),
+
+      company_name: Joi.string().allow(""),
+
+      integration: Joi.string().allow("").required(),
+
+      company_id: Joi.number().required(),
+
+      task_details: InventoryModel.TaskDTO(),
+
+      threshold_details: InventoryModel.DataTresholdDTO(),
+
+      job_code: Joi.string().allow(""),
+
+      alias: Joi.string().allow(""),
+    });
+  }
+
+  static ResponseEnvelopeJobConfigDTO() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: InventoryModel.JobConfigDTO(),
+
+      payload: InventoryModel.JobConfigDTO(),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+
+  static TaskDTO() {
+    return Joi.object({
+      type: Joi.number(),
+
+      group_list: Joi.array().items(InventoryModel.GenericDTO()),
+    });
+  }
+
+  static ResponseEnvelopeListJobConfigDTO() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: Joi.array().items(InventoryModel.JobConfigDTO()),
+
+      payload: Joi.array().items(InventoryModel.JobConfigDTO()),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+
+  static ResponseEnvelopeObject() {
+    return Joi.object({
+      timestamp: Joi.string().allow(""),
+
+      status: Joi.number(),
+
+      error: Joi.string().allow(""),
+
+      exception: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      total_time_taken_in_millis: Joi.number(),
+
+      http_status: Joi.string().allow(""),
+
+      items: Joi.any(),
+
+      payload: Joi.any(),
+
+      trace_id: Joi.string().allow(""),
+
+      page: InventoryModel.Page(),
+    });
+  }
+}
+module.exports = InventoryModel;

package/sdk/public/{models/InventoryValidator.js → Inventory/InventoryPublicValidator.js}

@@ -1,4 +1,4 @@
-const Validator = require("../PublicModels");
+const InventoryModel = require("./InventoryPublicModel");
 const Joi = require("joi");
 class InventoryValidator {
   static getJobCodesMetrics() {
@@ -10,7 +10,7 @@ class InventoryValidator {
 
   static saveJobCodesMetrics() {
     return Joi.object({
-      body: Validator.EmailJobMetrics().required(),
+      body: InventoryModel.EmailJobMetrics().required(),
     }).required();
   }
 

package/sdk/public/PublicClient.d.ts

@@ -7,6 +7,6 @@ declare class PublicClient {
     inventory: Inventory;
     setExtraHeaders(header: any): void;
 }
-import Configuration = require("./client/ConfigurationPublicClient");
-import Webhook = require("./client/WebhookPublicClient");
-import Inventory = require("./client/InventoryPublicClient");
+import Configuration = require("./Configuration/ConfigurationPublicClient");
+import Webhook = require("./Webhook/WebhookPublicClient");
+import Inventory = require("./Inventory/InventoryPublicClient");

package/sdk/public/PublicClient.js

@@ -1,14 +1,19 @@
-const Configuration = require("./client/ConfigurationPublicClient");
-const Webhook = require("./client/WebhookPublicClient");
-const Inventory = require("./client/InventoryPublicClient");
+const Configuration = require("./Configuration/ConfigurationPublicClient");
+
+const Webhook = require("./Webhook/WebhookPublicClient");
+
+const Inventory = require("./Inventory/InventoryPublicClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
 
 class PublicClient {
   constructor(config) {
     this.config = config;
+
     this.configuration = new Configuration(config);
+
     this.webhook = new Webhook(config);
+
     this.inventory = new Inventory(config);
   }
 

package/sdk/public/{client → Webhook}/WebhookPublicClient.js

@@ -1,7 +1,7 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
-const WebhookValidator = require("../models/WebhookValidator");
+const WebhookValidator = require("./WebhookPublicValidator");
 class Webhook {
   constructor(_conf) {
     this._conf = _conf;

package/sdk/public/Webhook/WebhookPublicModel.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/public/Webhook/WebhookPublicModel.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/public/{models/WebhookValidator.js → Webhook/WebhookPublicValidator.js}

@@ -1,4 +1,4 @@
-const Validator = require("../PublicModels");
+const WebhookModel = require("./WebhookPublicModel");
 const Joi = require("joi");
 class WebhookValidator {
   static fetchAllWebhookEvents() {
@@ -7,7 +7,7 @@ class WebhookValidator {
 
   static queryWebhookEventDetails() {
     return Joi.object({
-      body: Joi.array().items(Validator.EventConfigBase()).required(),
+      body: Joi.array().items(WebhookModel.EventConfigBase()).required(),
     }).required();
   }
 }

package/sdk/public/index.d.ts

@@ -1,2 +1,7 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
+export namespace PublicModel {
+    const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
+    const WebhookPublicModel: typeof import("./Webhook/WebhookPublicModel");
+    const InventoryPublicModel: typeof import("./Inventory/InventoryPublicModel");
+}

package/sdk/public/index.js

@@ -1,4 +1,11 @@
 module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
+  PublicModel: {
+    ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
+
+    WebhookPublicModel: require("./Webhook/WebhookPublicModel"),
+
+    InventoryPublicModel: require("./Inventory/InventoryPublicModel"),
+  },
 };