@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/public/Inventory/InventoryPublicModel.js

@@ -1,21 +1,229 @@
 const Joi = require("joi");
 
-class InventoryModel {
+/**
+ * @typedef ApikeyModel
+ * @property {string} [error_message]
+ * @property {string} [session_id]
+ */
+
+/**
+ * @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 EmailJobMetrics
+ * @property {boolean} [daily_job]
+ * @property {boolean} [executed]
+ * @property {string} [id]
+ * @property {string} [job_code]
+ * @property {string} [last_executed_on]
+ */
+
+/**
+ * @typedef GCompany
+ * @property {string} [_id]
+ * @property {string} [integration]
+ * @property {string} [level]
+ * @property {string} [name]
+ * @property {boolean} [opted]
+ * @property {string[]} [permissions]
+ * @property {GStore[]} [stores]
+ * @property {string} [token]
+ * @property {number} [uid]
+ */
+
+/**
+ * @typedef GenericDTO
+ * @property {string} [text]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef GStore
+ * @property {string} [_id]
+ * @property {string} [code]
+ * @property {StoreData} [data]
+ * @property {string} [integration]
+ * @property {string} [level]
+ * @property {string} [name]
+ * @property {boolean} [opted]
+ * @property {string[]} [permissions]
+ * @property {string} [token]
+ * @property {number} [uid]
+ */
+
+/**
+ * @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 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 ResponseEnvelopeApikeyModel
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @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]
+ */
+
+/**
+ * @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 ResponseEnvelopeJobConfigDTO
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @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]
+ */
+
+/**
+ * @typedef ResponseEnvelopeListJobConfigDTO
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @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]
+ */
+
+/**
+ * @typedef ResponseEnvelopeObject
+ * @property {string} [error]
+ * @property {string} [exception]
+ * @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() {
     return Joi.object({
       error_message: Joi.string().allow(""),
       session_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {DataTresholdDTO} */
   static DataTresholdDTO() {
     return Joi.object({
       min_price: Joi.number(),
       period_threshold: Joi.number(),
       period_threshold_type: Joi.string().allow(""),
-      period_type_list: Joi.array().items(InventoryModel.GenericDTO()),
+      period_type_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
       safe_stock: Joi.number(),
     });
   }
+
+  /** @returns {EmailJobMetrics} */
   static EmailJobMetrics() {
     return Joi.object({
       daily_job: Joi.boolean(),
@@ -25,6 +233,8 @@ class InventoryModel {
       last_executed_on: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GCompany} */
   static GCompany() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -33,22 +243,26 @@ class InventoryModel {
       name: Joi.string().allow(""),
       opted: Joi.boolean(),
       permissions: Joi.array().items(Joi.string().allow("")),
-      stores: Joi.array().items(InventoryModel.GStore()),
+      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(),
     });
   }
+
+  /** @returns {GStore} */
   static GStore() {
     return Joi.object({
       _id: Joi.string().allow(""),
       code: Joi.string().allow(""),
-      data: InventoryModel.StoreData(),
+      data: InventoryPublicModel.StoreData(),
       integration: Joi.string().allow(""),
       level: Joi.string().allow(""),
       name: Joi.string().allow(""),
@@ -58,6 +272,8 @@ class InventoryModel {
       uid: Joi.number(),
     });
   }
+
+  /** @returns {JobConfigDTO} */
   static JobConfigDTO() {
     return Joi.object({
       alias: Joi.string().allow(""),
@@ -66,10 +282,12 @@ class InventoryModel {
       integration: Joi.string().allow("").required(),
       integration_data: Joi.object().pattern(/\S/, Joi.any()),
       job_code: Joi.string().allow(""),
-      task_details: InventoryModel.TaskDTO(),
-      threshold_details: InventoryModel.DataTresholdDTO(),
+      task_details: InventoryPublicModel.TaskDTO(),
+      threshold_details: InventoryPublicModel.DataTresholdDTO(),
     });
   }
+
+  /** @returns {Metum} */
   static Metum() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -77,6 +295,8 @@ class InventoryModel {
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -88,66 +308,76 @@ class InventoryModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ResponseEnvelopeApikeyModel} */
   static ResponseEnvelopeApikeyModel() {
     return Joi.object({
       error: Joi.string().allow(""),
       exception: Joi.string().allow(""),
       http_status: Joi.string().allow(""),
-      items: InventoryModel.ApikeyModel(),
+      items: InventoryPublicModel.ApikeyModel(),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
-      payload: InventoryModel.ApikeyModel(),
+      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(""),
     });
   }
+
+  /** @returns {ResponseEnvelopeEmailJobMetrics} */
   static ResponseEnvelopeEmailJobMetrics() {
     return Joi.object({
       error: Joi.string().allow(""),
       exception: Joi.string().allow(""),
       http_status: Joi.string().allow(""),
-      items: InventoryModel.EmailJobMetrics(),
+      items: InventoryPublicModel.EmailJobMetrics(),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
-      payload: InventoryModel.EmailJobMetrics(),
+      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(""),
     });
   }
+
+  /** @returns {ResponseEnvelopeJobConfigDTO} */
   static ResponseEnvelopeJobConfigDTO() {
     return Joi.object({
       error: Joi.string().allow(""),
       exception: Joi.string().allow(""),
       http_status: Joi.string().allow(""),
-      items: InventoryModel.JobConfigDTO(),
+      items: InventoryPublicModel.JobConfigDTO(),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
-      payload: InventoryModel.JobConfigDTO(),
+      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(""),
     });
   }
+
+  /** @returns {ResponseEnvelopeListJobConfigDTO} */
   static ResponseEnvelopeListJobConfigDTO() {
     return Joi.object({
       error: Joi.string().allow(""),
       exception: Joi.string().allow(""),
       http_status: Joi.string().allow(""),
-      items: Joi.array().items(InventoryModel.JobConfigDTO()),
+      items: Joi.array().items(InventoryPublicModel.JobConfigDTO()),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
-      payload: Joi.array().items(InventoryModel.JobConfigDTO()),
+      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(""),
     });
   }
+
+  /** @returns {ResponseEnvelopeObject} */
   static ResponseEnvelopeObject() {
     return Joi.object({
       error: Joi.string().allow(""),
@@ -155,7 +385,7 @@ class InventoryModel {
       http_status: Joi.string().allow(""),
       items: Joi.any(),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
+      page: InventoryPublicModel.Page(),
       payload: Joi.any(),
       status: Joi.number(),
       timestamp: Joi.string().allow(""),
@@ -163,46 +393,56 @@ class InventoryModel {
       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: InventoryModel.SlingshotConfigurationDetail(),
+      items: InventoryPublicModel.SlingshotConfigurationDetail(),
       message: Joi.string().allow(""),
-      page: InventoryModel.Page(),
-      payload: InventoryModel.SlingshotConfigurationDetail(),
+      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(InventoryModel.GCompany()),
-      integration: InventoryModel.SlingshotIntegration(),
+      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(InventoryModel.Metum()),
+      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(InventoryModel.GenericDTO()),
+      group_list: Joi.array().items(InventoryPublicModel.GenericDTO()),
       type: Joi.number(),
     });
   }
 }
-module.exports = InventoryModel;
+module.exports = InventoryPublicModel;

package/sdk/public/Inventory/InventoryPublicValidator.d.ts

@@ -1,9 +1,91 @@
-export = InventoryValidator;
-declare class InventoryValidator {
-    static getApiKey(): any;
-    static getConfigByApiKey(): any;
-    static getJobByCode(): any;
-    static getJobCodesMetrics(): any;
-    static getJobConfigByIntegrationType(): any;
-    static saveJobCodesMetrics(): any;
+export = InventoryPublicValidator;
+/**
+ * @typedef GetApiKeyParam
+ * @property {string} userName - Integration id
+ * @property {string} password - Company/store token
+ */
+/**
+ * @typedef GetConfigByApiKeyParam
+ * @property {string} apikey - Api key
+ */
+/**
+ * @typedef GetJobByCodeParam
+ * @property {string} code - Job Code
+ */
+/**
+ * @typedef GetJobCodesMetricsParam
+ * @property {boolean} [dailyJob] - Daily Job Flag
+ * @property {string} [jobCode] - Email Job Code
+ */
+/**
+ * @typedef GetJobConfigByIntegrationTypeParam
+ * @property {string} integrationType - Integration Type
+ * @property {boolean} [disable] - JobConfig current state
+ */
+/**
+ * @typedef SaveJobCodesMetricsParam
+ * @property {InventoryPublicModel.EmailJobMetrics} body
+ */
+declare class InventoryPublicValidator {
+    /** @returns {GetApiKeyParam} */
+    static getApiKey(): GetApiKeyParam;
+    /** @returns {GetConfigByApiKeyParam} */
+    static getConfigByApiKey(): GetConfigByApiKeyParam;
+    /** @returns {GetJobByCodeParam} */
+    static getJobByCode(): GetJobByCodeParam;
+    /** @returns {GetJobCodesMetricsParam} */
+    static getJobCodesMetrics(): GetJobCodesMetricsParam;
+    /** @returns {GetJobConfigByIntegrationTypeParam} */
+    static getJobConfigByIntegrationType(): GetJobConfigByIntegrationTypeParam;
+    /** @returns {SaveJobCodesMetricsParam} */
+    static saveJobCodesMetrics(): SaveJobCodesMetricsParam;
 }
+declare namespace InventoryPublicValidator {
+    export { GetApiKeyParam, GetConfigByApiKeyParam, GetJobByCodeParam, GetJobCodesMetricsParam, GetJobConfigByIntegrationTypeParam, SaveJobCodesMetricsParam };
+}
+type GetApiKeyParam = {
+    /**
+     * - Integration id
+     */
+    userName: string;
+    /**
+     * - Company/store token
+     */
+    password: string;
+};
+type GetConfigByApiKeyParam = {
+    /**
+     * - Api key
+     */
+    apikey: string;
+};
+type GetJobByCodeParam = {
+    /**
+     * - Job Code
+     */
+    code: string;
+};
+type GetJobCodesMetricsParam = {
+    /**
+     * - Daily Job Flag
+     */
+    dailyJob?: boolean;
+    /**
+     * - Email Job Code
+     */
+    jobCode?: string;
+};
+type GetJobConfigByIntegrationTypeParam = {
+    /**
+     * - Integration Type
+     */
+    integrationType: string;
+    /**
+     * - JobConfig current state
+     */
+    disable?: boolean;
+};
+type SaveJobCodesMetricsParam = {
+    body: InventoryPublicModel.EmailJobMetrics;
+};
+import InventoryPublicModel = require("./InventoryPublicModel");

package/sdk/public/Inventory/InventoryPublicValidator.js

@@ -1,7 +1,42 @@
 const Joi = require("joi");
 
-const InventoryModel = require("./InventoryPublicModel");
-class InventoryValidator {
+const InventoryPublicModel = require("./InventoryPublicModel");
+
+/**
+ * @typedef GetApiKeyParam
+ * @property {string} userName - Integration id
+ * @property {string} password - Company/store token
+ */
+
+/**
+ * @typedef GetConfigByApiKeyParam
+ * @property {string} apikey - Api key
+ */
+
+/**
+ * @typedef GetJobByCodeParam
+ * @property {string} code - Job Code
+ */
+
+/**
+ * @typedef GetJobCodesMetricsParam
+ * @property {boolean} [dailyJob] - Daily Job Flag
+ * @property {string} [jobCode] - Email Job Code
+ */
+
+/**
+ * @typedef GetJobConfigByIntegrationTypeParam
+ * @property {string} integrationType - Integration Type
+ * @property {boolean} [disable] - JobConfig current state
+ */
+
+/**
+ * @typedef SaveJobCodesMetricsParam
+ * @property {InventoryPublicModel.EmailJobMetrics} body
+ */
+
+class InventoryPublicValidator {
+  /** @returns {GetApiKeyParam} */
   static getApiKey() {
     return Joi.object({
       userName: Joi.string().allow("").required(),
@@ -9,18 +44,21 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {GetConfigByApiKeyParam} */
   static getConfigByApiKey() {
     return Joi.object({
       apikey: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetJobByCodeParam} */
   static getJobByCode() {
     return Joi.object({
       code: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetJobCodesMetricsParam} */
   static getJobCodesMetrics() {
     return Joi.object({
       dailyJob: Joi.boolean(),
@@ -28,6 +66,7 @@ class InventoryValidator {
     });
   }
 
+  /** @returns {GetJobConfigByIntegrationTypeParam} */
   static getJobConfigByIntegrationType() {
     return Joi.object({
       integrationType: Joi.string().allow("").required(),
@@ -35,11 +74,12 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {SaveJobCodesMetricsParam} */
   static saveJobCodesMetrics() {
     return Joi.object({
-      body: InventoryModel.EmailJobMetrics().required(),
+      body: InventoryPublicModel.EmailJobMetrics().required(),
     }).required();
   }
 }
 
-module.exports = InventoryValidator;
+module.exports = InventoryPublicValidator;

package/sdk/public/PublicClient.d.ts

@@ -1,11 +1,27 @@
 export = PublicClient;
+/**
+ * Represents the client for the public APIs.
+ *
+ * @class
+ */
 declare class PublicClient {
-    constructor(config: any);
-    config: any;
+    /**
+     * Creates an instance of PublicClient.
+     *
+     * @param {import("./PublicConfig")} config - The configuration for the public client.
+     */
+    constructor(config: import("./PublicConfig"));
+    config: import("./PublicConfig");
     configuration: Configuration;
     inventory: Inventory;
     webhook: Webhook;
-    setExtraHeaders(header: any): void;
+    /**
+     * Sets the extra headers for the public client.
+     *
+     * @param {object} header - The header object to set.
+     * @throws {FDKClientValidationError} When the provided header is not an object.
+     */
+    setExtraHeaders(header: object): void;
 }
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Inventory = require("./Inventory/InventoryPublicClient");