@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/public/Inventory/InventoryPublicModel.js

@@ -1,27 +1,38 @@
 const Joi = require("joi");
 
 /**
- * @typedef ApikeyModel
- * @property {string} [error_message]
- * @property {string} [session_id]
+ * @typedef EmailJobMetrics
+ * @property {boolean} [executed]
+ * @property {string} [id]
+ * @property {string} [job_code]
+ * @property {boolean} [daily_job]
+ * @property {string} [last_executed_on]
  */
 
 /**
- * @typedef DataTresholdDTO
- * @property {number} [min_price]
- * @property {number} [period_threshold]
- * @property {string} [period_threshold_type]
- * @property {GenericDTO[]} [period_type_list]
- * @property {number} [safe_stock]
+ * @typedef Page
+ * @property {string} type
+ * @property {number} [size]
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
  */
 
 /**
- * @typedef EmailJobMetrics
- * @property {boolean} [daily_job]
- * @property {boolean} [executed]
- * @property {string} [id]
- * @property {string} [job_code]
- * @property {string} [last_executed_on]
+ * @typedef ResponseEnvelopeEmailJobMetrics
+ * @property {string} [timestamp]
+ * @property {number} [status]
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
+ * @property {string} [http_status]
+ * @property {EmailJobMetrics} [items]
+ * @property {EmailJobMetrics} [payload]
+ * @property {string} [trace_id]
+ * @property {Page} [page]
  */
 
 /**
@@ -29,208 +40,208 @@ const Joi = require("joi");
  * @property {string} [_id]
  * @property {string} [integration]
  * @property {string} [level]
- * @property {string} [name]
+ * @property {number} [uid]
  * @property {boolean} [opted]
  * @property {string[]} [permissions]
- * @property {GStore[]} [stores]
  * @property {string} [token]
- * @property {number} [uid]
- */
-
-/**
- * @typedef GenericDTO
- * @property {string} [text]
- * @property {Object} [value]
+ * @property {string} [name]
+ * @property {GStore[]} [stores]
  */
 
 /**
  * @typedef GStore
  * @property {string} [_id]
- * @property {string} [code]
- * @property {StoreData} [data]
  * @property {string} [integration]
  * @property {string} [level]
- * @property {string} [name]
+ * @property {number} [uid]
  * @property {boolean} [opted]
  * @property {string[]} [permissions]
  * @property {string} [token]
- * @property {number} [uid]
+ * @property {string} [code]
+ * @property {string} [name]
+ * @property {StoreData} [data]
  */
 
 /**
- * @typedef JobConfigDTO
- * @property {string} [alias]
- * @property {number} company_id
- * @property {string} [company_name]
- * @property {string} integration
- * @property {Object} [integration_data]
- * @property {string} [job_code]
- * @property {TaskDTO} [task_details]
- * @property {DataTresholdDTO} [threshold_details]
+ * @typedef Metum
+ * @property {string} [_id]
+ * @property {string} [name]
+ * @property {string} [value]
  */
 
 /**
- * @typedef Metum
+ * @typedef ResponseEnvelopeSlingshotConfigurationDetail
+ * @property {string} [timestamp]
+ * @property {number} [status]
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
+ * @property {string} [http_status]
+ * @property {SlingshotConfigurationDetail} [items]
+ * @property {SlingshotConfigurationDetail} [payload]
+ * @property {string} [trace_id]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef SlingshotConfigurationDetail
+ * @property {SlingshotIntegration} [integration]
+ * @property {GCompany[]} [companies]
+ */
+
+/**
+ * @typedef SlingshotIntegration
  * @property {string} [_id]
+ * @property {string} [description]
  * @property {string} [name]
- * @property {string} [value]
+ * @property {string} [slug]
+ * @property {Metum[]} [meta]
  */
 
 /**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
+ * @typedef StoreData
+ * @property {string} [location_id]
+ */
+
+/**
+ * @typedef ApikeyModel
+ * @property {string} [session_id]
+ * @property {string} [error_message]
  */
 
 /**
  * @typedef ResponseEnvelopeApikeyModel
+ * @property {string} [timestamp]
+ * @property {number} [status]
  * @property {string} [error]
  * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
  * @property {string} [http_status]
  * @property {ApikeyModel} [items]
- * @property {string} [message]
- * @property {Page} [page]
  * @property {ApikeyModel} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
  * @property {string} [trace_id]
+ * @property {Page} [page]
  */
 
 /**
- * @typedef ResponseEnvelopeEmailJobMetrics
- * @property {string} [error]
- * @property {string} [exception]
- * @property {string} [http_status]
- * @property {EmailJobMetrics} [items]
- * @property {string} [message]
- * @property {Page} [page]
- * @property {EmailJobMetrics} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
- * @property {string} [trace_id]
+ * @typedef DataTresholdDTO
+ * @property {number} [min_price]
+ * @property {number} [safe_stock]
+ * @property {number} [period_threshold]
+ * @property {string} [period_threshold_type]
+ * @property {GenericDTO[]} [period_type_list]
+ */
+
+/**
+ * @typedef GenericDTO
+ * @property {string} [text]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef JobConfigDTO
+ * @property {Object} [integration_data]
+ * @property {string} [company_name]
+ * @property {string} integration
+ * @property {number} company_id
+ * @property {TaskDTO} [task_details]
+ * @property {DataTresholdDTO} [threshold_details]
+ * @property {string} [job_code]
+ * @property {string} [alias]
  */
 
 /**
  * @typedef ResponseEnvelopeJobConfigDTO
+ * @property {string} [timestamp]
+ * @property {number} [status]
  * @property {string} [error]
  * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
  * @property {string} [http_status]
  * @property {JobConfigDTO} [items]
- * @property {string} [message]
- * @property {Page} [page]
  * @property {JobConfigDTO} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
  * @property {string} [trace_id]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef TaskDTO
+ * @property {number} [type]
+ * @property {GenericDTO[]} [group_list]
  */
 
 /**
  * @typedef ResponseEnvelopeListJobConfigDTO
+ * @property {string} [timestamp]
+ * @property {number} [status]
  * @property {string} [error]
  * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
  * @property {string} [http_status]
  * @property {JobConfigDTO[]} [items]
- * @property {string} [message]
- * @property {Page} [page]
  * @property {JobConfigDTO[]} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
  * @property {string} [trace_id]
+ * @property {Page} [page]
  */
 
 /**
  * @typedef ResponseEnvelopeObject
+ * @property {string} [timestamp]
+ * @property {number} [status]
  * @property {string} [error]
  * @property {string} [exception]
+ * @property {string} [message]
+ * @property {number} [total_time_taken_in_millis]
  * @property {string} [http_status]
  * @property {Object} [items]
- * @property {string} [message]
- * @property {Page} [page]
  * @property {Object} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
  * @property {string} [trace_id]
- */
-
-/**
- * @typedef ResponseEnvelopeSlingshotConfigurationDetail
- * @property {string} [error]
- * @property {string} [exception]
- * @property {string} [http_status]
- * @property {SlingshotConfigurationDetail} [items]
- * @property {string} [message]
  * @property {Page} [page]
- * @property {SlingshotConfigurationDetail} [payload]
- * @property {number} [status]
- * @property {string} [timestamp]
- * @property {number} [total_time_taken_in_millis]
- * @property {string} [trace_id]
- */
-
-/**
- * @typedef SlingshotConfigurationDetail
- * @property {GCompany[]} [companies]
- * @property {SlingshotIntegration} [integration]
- */
-
-/**
- * @typedef SlingshotIntegration
- * @property {string} [_id]
- * @property {string} [description]
- * @property {Metum[]} [meta]
- * @property {string} [name]
- * @property {string} [slug]
- */
-
-/**
- * @typedef StoreData
- * @property {string} [location_id]
- */
-
-/**
- * @typedef TaskDTO
- * @property {GenericDTO[]} [group_list]
- * @property {number} [type]
  */
 
 class InventoryPublicModel {
-  /** @returns {ApikeyModel} */
-  static ApikeyModel() {
+  /** @returns {EmailJobMetrics} */
+  static EmailJobMetrics() {
     return Joi.object({
-      error_message: Joi.string().allow(""),
-      session_id: Joi.string().allow(""),
+      executed: Joi.boolean(),
+      id: Joi.string().allow(""),
+      job_code: Joi.string().allow(""),
+      daily_job: Joi.boolean(),
+      last_executed_on: Joi.string().allow(""),
     });
   }
 
-  /** @returns {DataTresholdDTO} */
-  static DataTresholdDTO() {
+  /** @returns {Page} */
+  static Page() {
     return Joi.object({
-      min_price: Joi.number(),
-      period_threshold: Joi.number(),
-      period_threshold_type: Joi.string().allow(""),
-      period_type_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
-      safe_stock: Joi.number(),
+      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(),
     });
   }
 
-  /** @returns {EmailJobMetrics} */
-  static EmailJobMetrics() {
+  /** @returns {ResponseEnvelopeEmailJobMetrics} */
+  static ResponseEnvelopeEmailJobMetrics() {
     return Joi.object({
-      daily_job: Joi.boolean(),
-      executed: Joi.boolean(),
-      id: Joi.string().allow(""),
-      job_code: Joi.string().allow(""),
-      last_executed_on: Joi.string().allow(""),
+      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: InventoryPublicModel.EmailJobMetrics(),
+      payload: InventoryPublicModel.EmailJobMetrics(),
+      trace_id: Joi.string().allow(""),
+      page: InventoryPublicModel.Page(),
     });
   }
 
@@ -240,20 +251,12 @@ class InventoryPublicModel {
       _id: Joi.string().allow(""),
       integration: Joi.string().allow(""),
       level: Joi.string().allow(""),
-      name: Joi.string().allow(""),
+      uid: Joi.number(),
       opted: Joi.boolean(),
       permissions: Joi.array().items(Joi.string().allow("")),
-      stores: Joi.array().items(InventoryPublicModel.GStore()),
       token: Joi.string().allow(""),
-      uid: Joi.number(),
-    });
-  }
-
-  /** @returns {GenericDTO} */
-  static GenericDTO() {
-    return Joi.object({
-      text: Joi.string().allow(""),
-      value: Joi.any(),
+      name: Joi.string().allow(""),
+      stores: Joi.array().items(InventoryPublicModel.GStore()),
     });
   }
 
@@ -261,187 +264,184 @@ class InventoryPublicModel {
   static GStore() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-      data: InventoryPublicModel.StoreData(),
       integration: Joi.string().allow(""),
       level: Joi.string().allow(""),
-      name: Joi.string().allow(""),
+      uid: Joi.number(),
       opted: Joi.boolean(),
       permissions: Joi.array().items(Joi.string().allow("")),
       token: Joi.string().allow(""),
-      uid: Joi.number(),
+      code: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      data: InventoryPublicModel.StoreData(),
     });
   }
 
-  /** @returns {JobConfigDTO} */
-  static JobConfigDTO() {
+  /** @returns {Metum} */
+  static Metum() {
     return Joi.object({
-      alias: Joi.string().allow(""),
-      company_id: Joi.number().required(),
-      company_name: Joi.string().allow(""),
-      integration: Joi.string().allow("").required(),
-      integration_data: Joi.object().pattern(/\S/, Joi.any()),
-      job_code: Joi.string().allow(""),
-      task_details: InventoryPublicModel.TaskDTO(),
-      threshold_details: InventoryPublicModel.DataTresholdDTO(),
+      _id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      value: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Metum} */
-  static Metum() {
+  /** @returns {ResponseEnvelopeSlingshotConfigurationDetail} */
+  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: InventoryPublicModel.SlingshotConfigurationDetail(),
+      payload: InventoryPublicModel.SlingshotConfigurationDetail(),
+      trace_id: Joi.string().allow(""),
+      page: InventoryPublicModel.Page(),
+    });
+  }
+
+  /** @returns {SlingshotConfigurationDetail} */
+  static SlingshotConfigurationDetail() {
+    return Joi.object({
+      integration: InventoryPublicModel.SlingshotIntegration(),
+      companies: Joi.array().items(InventoryPublicModel.GCompany()),
+    });
+  }
+
+  /** @returns {SlingshotIntegration} */
+  static SlingshotIntegration() {
     return Joi.object({
       _id: Joi.string().allow(""),
+      description: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      value: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      meta: Joi.array().items(InventoryPublicModel.Metum()),
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
+  /** @returns {StoreData} */
+  static StoreData() {
     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(),
+      location_id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ApikeyModel} */
+  static ApikeyModel() {
+    return Joi.object({
+      session_id: Joi.string().allow(""),
+      error_message: Joi.string().allow(""),
     });
   }
 
   /** @returns {ResponseEnvelopeApikeyModel} */
   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: InventoryPublicModel.ApikeyModel(),
-      message: Joi.string().allow(""),
-      page: InventoryPublicModel.Page(),
       payload: InventoryPublicModel.ApikeyModel(),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
       trace_id: Joi.string().allow(""),
+      page: InventoryPublicModel.Page(),
     });
   }
 
-  /** @returns {ResponseEnvelopeEmailJobMetrics} */
-  static ResponseEnvelopeEmailJobMetrics() {
+  /** @returns {DataTresholdDTO} */
+  static DataTresholdDTO() {
     return Joi.object({
-      error: Joi.string().allow(""),
-      exception: Joi.string().allow(""),
-      http_status: Joi.string().allow(""),
-      items: InventoryPublicModel.EmailJobMetrics(),
-      message: Joi.string().allow(""),
-      page: InventoryPublicModel.Page(),
-      payload: InventoryPublicModel.EmailJobMetrics(),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
-      trace_id: Joi.string().allow(""),
+      min_price: Joi.number(),
+      safe_stock: Joi.number(),
+      period_threshold: Joi.number(),
+      period_threshold_type: Joi.string().allow(""),
+      period_type_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
+    });
+  }
+
+  /** @returns {GenericDTO} */
+  static GenericDTO() {
+    return Joi.object({
+      text: Joi.string().allow(""),
+      value: Joi.any(),
+    });
+  }
+
+  /** @returns {JobConfigDTO} */
+  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: InventoryPublicModel.TaskDTO(),
+      threshold_details: InventoryPublicModel.DataTresholdDTO(),
+      job_code: Joi.string().allow(""),
+      alias: Joi.string().allow(""),
     });
   }
 
   /** @returns {ResponseEnvelopeJobConfigDTO} */
   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: InventoryPublicModel.JobConfigDTO(),
-      message: Joi.string().allow(""),
-      page: InventoryPublicModel.Page(),
       payload: InventoryPublicModel.JobConfigDTO(),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
       trace_id: Joi.string().allow(""),
+      page: InventoryPublicModel.Page(),
+    });
+  }
+
+  /** @returns {TaskDTO} */
+  static TaskDTO() {
+    return Joi.object({
+      type: Joi.number(),
+      group_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
     });
   }
 
   /** @returns {ResponseEnvelopeListJobConfigDTO} */
   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(InventoryPublicModel.JobConfigDTO()),
-      message: Joi.string().allow(""),
-      page: InventoryPublicModel.Page(),
       payload: Joi.array().items(InventoryPublicModel.JobConfigDTO()),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
       trace_id: Joi.string().allow(""),
+      page: InventoryPublicModel.Page(),
     });
   }
 
   /** @returns {ResponseEnvelopeObject} */
   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(),
-      message: Joi.string().allow(""),
-      page: InventoryPublicModel.Page(),
       payload: Joi.any(),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
       trace_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ResponseEnvelopeSlingshotConfigurationDetail} */
-  static ResponseEnvelopeSlingshotConfigurationDetail() {
-    return Joi.object({
-      error: Joi.string().allow(""),
-      exception: Joi.string().allow(""),
-      http_status: Joi.string().allow(""),
-      items: InventoryPublicModel.SlingshotConfigurationDetail(),
-      message: Joi.string().allow(""),
       page: InventoryPublicModel.Page(),
-      payload: InventoryPublicModel.SlingshotConfigurationDetail(),
-      status: Joi.number(),
-      timestamp: Joi.string().allow(""),
-      total_time_taken_in_millis: Joi.number(),
-      trace_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SlingshotConfigurationDetail} */
-  static SlingshotConfigurationDetail() {
-    return Joi.object({
-      companies: Joi.array().items(InventoryPublicModel.GCompany()),
-      integration: InventoryPublicModel.SlingshotIntegration(),
-    });
-  }
-
-  /** @returns {SlingshotIntegration} */
-  static SlingshotIntegration() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      meta: Joi.array().items(InventoryPublicModel.Metum()),
-      name: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {StoreData} */
-  static StoreData() {
-    return Joi.object({
-      location_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {TaskDTO} */
-  static TaskDTO() {
-    return Joi.object({
-      group_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
-      type: Joi.number(),
     });
   }
 }