@gofynd/fdk-client-javascript 0.1.35

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

@@ -0,0 +1,38 @@
+export = Configuration;
+declare class Configuration {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        searchApplication: string;
+        getLocations: 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<any>;
+    /**
+     * @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:
+     */
+    getLocations({ locationType, id }?: {
+        locationType?: string;
+        id?: string;
+    }): Promise<any>;
+}

package/sdk/public/client/ConfigurationPublicClient.js

@@ -0,0 +1,102 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const ConfigurationValidator = require("../models/ConfigurationValidator");
+class Configuration {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      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]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ConfigurationValidator.searchApplication().validate(
+      { authorization, query },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["query"] = query;
+
+    const xHeaders = {};
+    xHeaders["authorization"] = authorization;
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["searchApplication"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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:
+   */
+  getLocations({ locationType, id } = {}) {
+    const { error } = ConfigurationValidator.getLocations().validate(
+      { locationType, id },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["location_type"] = locationType;
+    query_params["id"] = id;
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getLocations"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+module.exports = Configuration;

package/sdk/public/client/InventoryPublicClient.d.ts

@@ -0,0 +1,81 @@
+export = Inventory;
+declare class Inventory {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getJobCodesMetrics: string;
+        saveJobCodesMetrics: string;
+        getConfigByApiKey: string;
+        getApiKey: string;
+        getJobByCode: string;
+        getJobConfigByIntegrationType: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.dailyJob] - Daily Job Flag
+     * @param {string} [arg.jobCode] - Email Job Code
+     * @returns {Promise<ResponseEnvelopeObject>} - Success response
+     * @summary: Find all the JobCodes from Metrics Collection based on the field Values
+     * @description: Endpoint to return all JobCodes present in Metrics Collection
+     */
+    getJobCodesMetrics({ dailyJob, jobCode }?: {
+        dailyJob?: boolean;
+        jobCode?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EmailJobMetrics} arg.body
+     * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
+     * @summary: Save JobCode Metrics
+     * @description: Endpoint to save JobCode Metrics
+     */
+    saveJobCodesMetrics({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.apikey - Api key
+     * @returns {Promise<ResponseEnvelopeSlingshotConfigurationDetail>} - Success response
+     * @summary: Get Slingshot Configuration Of  A Company using API key
+     * @description: REST Endpoint that returns all configuration detail of a company
+     */
+    getConfigByApiKey({ apikey }?: {
+        apikey: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.userName - Integration id
+     * @param {string} arg.password - Company/store token
+     * @returns {Promise<ResponseEnvelopeApikeyModel>} - Success response
+     * @summary: Get apikey  for  Company  to call other Slingshot Configuration APIs
+     * @description: REST Endpoint that returns apikey by username by password
+     */
+    getApiKey({ userName, password }?: {
+        userName: string;
+        password: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.code - Job Code
+     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+     * @summary: Get Job Config By Code
+     * @description: REST Endpoint that returns job config by code
+     */
+    getJobByCode({ code }?: {
+        code: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.integrationType - Integration Type
+     * @param {boolean} [arg.disable] - JobConfig current state
+     * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
+     * @summary: Get Job Configs By Integration Type
+     * @description: REST Endpoint that returns all job Configs by Integration Type
+     */
+    getJobConfigByIntegrationType({ integrationType, disable }?: {
+        integrationType: string;
+        disable?: boolean;
+    }): Promise<any>;
+}

package/sdk/public/client/InventoryPublicClient.js

@@ -0,0 +1,239 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const InventoryValidator = require("../models/InventoryValidator");
+class Inventory {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getJobCodesMetrics:
+        "/service/common/inventory/v1.0/company/email/jobCode",
+      saveJobCodesMetrics:
+        "/service/common/inventory/v1.0/company/email/jobCode",
+      getConfigByApiKey: "/service/common/inventory/v1.0/company/slingshot",
+      getApiKey: "/service/common/inventory/v1.0/company/slingshot/apikey",
+      getJobByCode: "/service/common/inventory/v1.0/company/jobs/code/{code}",
+      getJobConfigByIntegrationType:
+        "/service/common/inventory/v1.0/company/job/config",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {boolean} [arg.dailyJob] - Daily Job Flag
+   * @param {string} [arg.jobCode] - Email Job Code
+   * @returns {Promise<ResponseEnvelopeObject>} - Success response
+   * @summary: Find all the JobCodes from Metrics Collection based on the field Values
+   * @description: Endpoint to return all JobCodes present in Metrics Collection
+   */
+  getJobCodesMetrics({ dailyJob, jobCode } = {}) {
+    const { error } = InventoryValidator.getJobCodesMetrics().validate(
+      { dailyJob, jobCode },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["daily_job"] = dailyJob;
+    query_params["job_code"] = jobCode;
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getJobCodesMetrics"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {EmailJobMetrics} arg.body
+   * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
+   * @summary: Save JobCode Metrics
+   * @description: Endpoint to save JobCode Metrics
+   */
+  saveJobCodesMetrics({ body } = {}) {
+    const { error } = InventoryValidator.saveJobCodesMetrics().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["saveJobCodesMetrics"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.apikey - Api key
+   * @returns {Promise<ResponseEnvelopeSlingshotConfigurationDetail>} - Success response
+   * @summary: Get Slingshot Configuration Of  A Company using API key
+   * @description: REST Endpoint that returns all configuration detail of a company
+   */
+  getConfigByApiKey({ apikey } = {}) {
+    const { error } = InventoryValidator.getConfigByApiKey().validate(
+      { apikey },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["apikey"] = apikey;
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getConfigByApiKey"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.userName - Integration id
+   * @param {string} arg.password - Company/store token
+   * @returns {Promise<ResponseEnvelopeApikeyModel>} - Success response
+   * @summary: Get apikey  for  Company  to call other Slingshot Configuration APIs
+   * @description: REST Endpoint that returns apikey by username by password
+   */
+  getApiKey({ userName, password } = {}) {
+    const { error } = InventoryValidator.getApiKey().validate(
+      { userName, password },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["user_name"] = userName;
+    query_params["password"] = password;
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getApiKey"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.code - Job Code
+   * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
+   * @summary: Get Job Config By Code
+   * @description: REST Endpoint that returns job config by code
+   */
+  getJobByCode({ code } = {}) {
+    const { error } = InventoryValidator.getJobByCode().validate(
+      { code },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getJobByCode"],
+        params: { code },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.integrationType - Integration Type
+   * @param {boolean} [arg.disable] - JobConfig current state
+   * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
+   * @summary: Get Job Configs By Integration Type
+   * @description: REST Endpoint that returns all job Configs by Integration Type
+   */
+  getJobConfigByIntegrationType({ integrationType, disable } = {}) {
+    const {
+      error,
+    } = InventoryValidator.getJobConfigByIntegrationType().validate(
+      { integrationType, disable },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["integration_type"] = integrationType;
+    query_params["disable"] = disable;
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getJobConfigByIntegrationType"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+module.exports = Inventory;

package/sdk/public/client/WebhookPublicClient.d.ts

@@ -0,0 +1,28 @@
+export = Webhook;
+declare class Webhook {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        fetchAllWebhookEvents: string;
+        queryWebhookEventDetails: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<EventConfigResponse>} - Success response
+     * @summary: Get All Webhook Events
+     * @description: Get All Webhook Events
+     */
+    fetchAllWebhookEvents({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EventConfigBase[]} arg.body
+     * @returns {Promise<EventConfigResponse>} - Success response
+     * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
+     * @description: Get Webhook Event Details for provided events
+     */
+    queryWebhookEventDetails({ body }?: {
+        body: any[];
+    }): Promise<any>;
+}

package/sdk/public/client/WebhookPublicClient.js

@@ -0,0 +1,92 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const WebhookValidator = require("../models/WebhookValidator");
+class Webhook {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      fetchAllWebhookEvents: "/service/common/webhook/v1.0/events",
+      queryWebhookEventDetails:
+        "/service/common/webhook/v1.0/events/query-event-details",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<EventConfigResponse>} - Success response
+   * @summary: Get All Webhook Events
+   * @description: Get All Webhook Events
+   */
+  fetchAllWebhookEvents({} = {}) {
+    const { error } = WebhookValidator.fetchAllWebhookEvents().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["fetchAllWebhookEvents"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {EventConfigBase[]} arg.body
+   * @returns {Promise<EventConfigResponse>} - Success response
+   * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
+   * @description: Get Webhook Event Details for provided events
+   */
+  queryWebhookEventDetails({ body } = {}) {
+    const { error } = WebhookValidator.queryWebhookEventDetails().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PublicAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["queryWebhookEventDetails"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+}
+module.exports = Webhook;

package/sdk/public/constructUrl.d.ts

@@ -0,0 +1,5 @@
+export = constructUrl;
+declare function constructUrl({ url, params }: {
+    url: any;
+    params: any;
+}): any;

package/sdk/public/constructUrl.js

@@ -0,0 +1,13 @@
+const camelCase = require("camelcase");
+const constructUrl = ({ url, params }) => {
+  return url
+    .split("/")
+    .map((word) => {
+      if (word[0] === "{" && word[word.length - 1] === "}") {
+        word = params[camelCase(word.slice(1, word.length - 1))];
+      }
+      return word;
+    })
+    .join("/");
+};
+module.exports = constructUrl;

package/sdk/public/index.d.ts

@@ -0,0 +1,2 @@
+export const PublicConfig: typeof import("./PublicConfig");
+export const PublicClient: typeof import("./PublicClient");

package/sdk/public/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  PublicConfig: require("./PublicConfig"),
+  PublicClient: require("./PublicClient"),
+};

package/sdk/public/models/ConfigurationValidator.d.ts

@@ -0,0 +1,5 @@
+export = ConfigurationValidator;
+declare class ConfigurationValidator {
+    static searchApplication(): any;
+    static getLocations(): any;
+}

package/sdk/public/models/ConfigurationValidator.js

@@ -0,0 +1,18 @@
+const Validator = require("../PublicModels");
+const Joi = require("joi");
+class ConfigurationValidator {
+  static searchApplication() {
+    return Joi.object({
+      authorization: Joi.string().allow(""),
+      query: Joi.string().allow(""),
+    });
+  }
+
+  static getLocations() {
+    return Joi.object({
+      locationType: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+    });
+  }
+}
+module.exports = ConfigurationValidator;

package/sdk/public/models/InventoryValidator.d.ts

@@ -0,0 +1,9 @@
+export = InventoryValidator;
+declare class InventoryValidator {
+    static getJobCodesMetrics(): any;
+    static saveJobCodesMetrics(): any;
+    static getConfigByApiKey(): any;
+    static getApiKey(): any;
+    static getJobByCode(): any;
+    static getJobConfigByIntegrationType(): any;
+}

package/sdk/public/models/InventoryValidator.js

@@ -0,0 +1,43 @@
+const Validator = require("../PublicModels");
+const Joi = require("joi");
+class InventoryValidator {
+  static getJobCodesMetrics() {
+    return Joi.object({
+      dailyJob: Joi.boolean(),
+      jobCode: Joi.string().allow(""),
+    });
+  }
+
+  static saveJobCodesMetrics() {
+    return Joi.object({
+      body: Validator.EmailJobMetrics().required(),
+    }).required();
+  }
+
+  static getConfigByApiKey() {
+    return Joi.object({
+      apikey: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getApiKey() {
+    return Joi.object({
+      userName: Joi.string().allow("").required(),
+      password: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getJobByCode() {
+    return Joi.object({
+      code: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getJobConfigByIntegrationType() {
+    return Joi.object({
+      integrationType: Joi.string().allow("").required(),
+      disable: Joi.boolean(),
+    }).required();
+  }
+}
+module.exports = InventoryValidator;