@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,9 +1,172 @@
-export = WebhookValidator;
-declare class WebhookValidator {
+export = WebhookPlatformValidator;
+/**
+ * @typedef CancelJobByNameParam
+ * @property {string} filename - Filename of the specific report export to cancel.
+ */
+/**
+ * @typedef DownloadDeliveryReportParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+/** @typedef FetchAllEventConfigurationsParam */
+/**
+ * @typedef GetDeliveryReportsParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+/**
+ * @typedef GetEventCountsParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+/**
+ * @typedef GetHistoricalReportsParam
+ * @property {WebhookPlatformModel.HistoryPayload} body
+ */
+/** @typedef GetManualRetryStatusParam */
+/**
+ * @typedef GetReportFiltersParam
+ * @property {WebhookPlatformModel.ReportFiltersPayload} body
+ */
+/**
+ * @typedef GetSubscriberByIdParam
+ * @property {number} subscriberId - The ID of the company for which manual
+ *   retry is to be initiated.
+ */
+/**
+ * @typedef GetSubscribersByCompanyParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {number} [extensionId] - Extension_id
+ */
+/**
+ * @typedef GetSubscribersByExtensionIdParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {number} extensionId - The ID of the company for which manual retry
+ *   is to be initiated.
+ */
+/** @typedef ManualRetryCancelParam */
+/**
+ * @typedef ManualRetryOfFailedEventParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+/**
+ * @typedef PingWebhookParam
+ * @property {WebhookPlatformModel.PingWebhook} body
+ */
+/**
+ * @typedef RegisterSubscriberToEventParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+/**
+ * @typedef UpdateSubscriberConfigParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+declare class WebhookPlatformValidator {
+    /** @returns {CancelJobByNameParam} */
+    static cancelJobByName(): CancelJobByNameParam;
+    /** @returns {DownloadDeliveryReportParam} */
+    static downloadDeliveryReport(): DownloadDeliveryReportParam;
+    /** @returns {FetchAllEventConfigurationsParam} */
     static fetchAllEventConfigurations(): any;
-    static getSubscriberById(): any;
-    static getSubscribersByCompany(): any;
-    static getSubscribersByExtensionId(): any;
-    static registerSubscriberToEvent(): any;
-    static updateSubscriberConfig(): any;
+    /** @returns {GetDeliveryReportsParam} */
+    static getDeliveryReports(): GetDeliveryReportsParam;
+    /** @returns {GetEventCountsParam} */
+    static getEventCounts(): GetEventCountsParam;
+    /** @returns {GetHistoricalReportsParam} */
+    static getHistoricalReports(): GetHistoricalReportsParam;
+    /** @returns {GetManualRetryStatusParam} */
+    static getManualRetryStatus(): any;
+    /** @returns {GetReportFiltersParam} */
+    static getReportFilters(): GetReportFiltersParam;
+    /** @returns {GetSubscriberByIdParam} */
+    static getSubscriberById(): GetSubscriberByIdParam;
+    /** @returns {GetSubscribersByCompanyParam} */
+    static getSubscribersByCompany(): GetSubscribersByCompanyParam;
+    /** @returns {GetSubscribersByExtensionIdParam} */
+    static getSubscribersByExtensionId(): GetSubscribersByExtensionIdParam;
+    /** @returns {ManualRetryCancelParam} */
+    static manualRetryCancel(): any;
+    /** @returns {ManualRetryOfFailedEventParam} */
+    static manualRetryOfFailedEvent(): ManualRetryOfFailedEventParam;
+    /** @returns {PingWebhookParam} */
+    static pingWebhook(): PingWebhookParam;
+    /** @returns {RegisterSubscriberToEventParam} */
+    static registerSubscriberToEvent(): RegisterSubscriberToEventParam;
+    /** @returns {UpdateSubscriberConfigParam} */
+    static updateSubscriberConfig(): UpdateSubscriberConfigParam;
 }
+declare namespace WebhookPlatformValidator {
+    export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetEventCountsParam, GetHistoricalReportsParam, GetManualRetryStatusParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, ManualRetryCancelParam, ManualRetryOfFailedEventParam, PingWebhookParam, RegisterSubscriberToEventParam, UpdateSubscriberConfigParam };
+}
+type CancelJobByNameParam = {
+    /**
+     * - Filename of the specific report export to cancel.
+     */
+    filename: string;
+};
+type DownloadDeliveryReportParam = {
+    body: WebhookPlatformModel.EventProcessRequest;
+};
+type GetDeliveryReportsParam = {
+    body: WebhookPlatformModel.EventProcessRequest;
+};
+type GetEventCountsParam = {
+    body: WebhookPlatformModel.EventProcessRequest;
+};
+type GetHistoricalReportsParam = {
+    body: WebhookPlatformModel.HistoryPayload;
+};
+type GetReportFiltersParam = {
+    body: WebhookPlatformModel.ReportFiltersPayload;
+};
+type GetSubscriberByIdParam = {
+    /**
+     * - The ID of the company for which manual
+     * retry is to be initiated.
+     */
+    subscriberId: number;
+};
+type GetSubscribersByCompanyParam = {
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+    /**
+     * - Extension_id
+     */
+    extensionId?: number;
+};
+type GetSubscribersByExtensionIdParam = {
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+    /**
+     * - The ID of the company for which manual retry
+     * is to be initiated.
+     */
+    extensionId: number;
+};
+type ManualRetryOfFailedEventParam = {
+    body: WebhookPlatformModel.EventProcessRequest;
+};
+type PingWebhookParam = {
+    body: WebhookPlatformModel.PingWebhook;
+};
+type RegisterSubscriberToEventParam = {
+    body: WebhookPlatformModel.SubscriberConfig;
+};
+type UpdateSubscriberConfigParam = {
+    body: WebhookPlatformModel.SubscriberConfig;
+};
+type FetchAllEventConfigurationsParam = any;
+type GetManualRetryStatusParam = any;
+type ManualRetryCancelParam = any;
+import WebhookPlatformModel = require("./WebhookPlatformModel");

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -1,44 +1,194 @@
 const Joi = require("joi");
 
-const WebhookModel = require("./WebhookPlatformModel");
-class WebhookValidator {
+const WebhookPlatformModel = require("./WebhookPlatformModel");
+
+/**
+ * @typedef CancelJobByNameParam
+ * @property {string} filename - Filename of the specific report export to cancel.
+ */
+
+/**
+ * @typedef DownloadDeliveryReportParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+
+/** @typedef FetchAllEventConfigurationsParam */
+
+/**
+ * @typedef GetDeliveryReportsParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+
+/**
+ * @typedef GetEventCountsParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+
+/**
+ * @typedef GetHistoricalReportsParam
+ * @property {WebhookPlatformModel.HistoryPayload} body
+ */
+
+/** @typedef GetManualRetryStatusParam */
+
+/**
+ * @typedef GetReportFiltersParam
+ * @property {WebhookPlatformModel.ReportFiltersPayload} body
+ */
+
+/**
+ * @typedef GetSubscriberByIdParam
+ * @property {number} subscriberId - The ID of the company for which manual
+ *   retry is to be initiated.
+ */
+
+/**
+ * @typedef GetSubscribersByCompanyParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {number} [extensionId] - Extension_id
+ */
+
+/**
+ * @typedef GetSubscribersByExtensionIdParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {number} extensionId - The ID of the company for which manual retry
+ *   is to be initiated.
+ */
+
+/** @typedef ManualRetryCancelParam */
+
+/**
+ * @typedef ManualRetryOfFailedEventParam
+ * @property {WebhookPlatformModel.EventProcessRequest} body
+ */
+
+/**
+ * @typedef PingWebhookParam
+ * @property {WebhookPlatformModel.PingWebhook} body
+ */
+
+/**
+ * @typedef RegisterSubscriberToEventParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+
+/**
+ * @typedef UpdateSubscriberConfigParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+
+class WebhookPlatformValidator {
+  /** @returns {CancelJobByNameParam} */
+  static cancelJobByName() {
+    return Joi.object({
+      filename: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DownloadDeliveryReportParam} */
+  static downloadDeliveryReport() {
+    return Joi.object({
+      body: WebhookPlatformModel.EventProcessRequest().required(),
+    }).required();
+  }
+
+  /** @returns {FetchAllEventConfigurationsParam} */
   static fetchAllEventConfigurations() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDeliveryReportsParam} */
+  static getDeliveryReports() {
+    return Joi.object({
+      body: WebhookPlatformModel.EventProcessRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GetEventCountsParam} */
+  static getEventCounts() {
+    return Joi.object({
+      body: WebhookPlatformModel.EventProcessRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GetHistoricalReportsParam} */
+  static getHistoricalReports() {
+    return Joi.object({
+      body: WebhookPlatformModel.HistoryPayload().required(),
+    }).required();
+  }
+
+  /** @returns {GetManualRetryStatusParam} */
+  static getManualRetryStatus() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetReportFiltersParam} */
+  static getReportFilters() {
+    return Joi.object({
+      body: WebhookPlatformModel.ReportFiltersPayload().required(),
+    }).required();
+  }
+
+  /** @returns {GetSubscriberByIdParam} */
   static getSubscriberById() {
     return Joi.object({
       subscriberId: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetSubscribersByCompanyParam} */
   static getSubscribersByCompany() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      extensionId: Joi.string().allow(""),
+      extensionId: Joi.number(),
     }).required();
   }
 
+  /** @returns {GetSubscribersByExtensionIdParam} */
   static getSubscribersByExtensionId() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      extensionId: Joi.string().allow("").required(),
+      extensionId: Joi.number().required(),
+    }).required();
+  }
+
+  /** @returns {ManualRetryCancelParam} */
+  static manualRetryCancel() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {ManualRetryOfFailedEventParam} */
+  static manualRetryOfFailedEvent() {
+    return Joi.object({
+      body: WebhookPlatformModel.EventProcessRequest().required(),
+    }).required();
+  }
+
+  /** @returns {PingWebhookParam} */
+  static pingWebhook() {
+    return Joi.object({
+      body: WebhookPlatformModel.PingWebhook().required(),
     }).required();
   }
 
+  /** @returns {RegisterSubscriberToEventParam} */
   static registerSubscriberToEvent() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfig().required(),
     }).required();
   }
 
+  /** @returns {UpdateSubscriberConfigParam} */
   static updateSubscriberConfig() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfig().required(),
     }).required();
   }
 }
 
-module.exports = WebhookValidator;
+module.exports = WebhookPlatformValidator;

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

@@ -9,30 +9,25 @@ declare class Configuration {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @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
+     * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
+     * @name getLocations
      * @summary: Get countries, states, cities
-     * @description:
+     * @description: Get Location configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
      */
-    getLocations({ locationType, id }?: {
-        locationType?: string;
-        id?: string;
-    }): Promise<Locations>;
+    getLocations({ locationType, id, requestHeaders }?: ConfigurationPublicValidator.GetLocationsParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.Locations>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.authorization] -
-     * @param {string} [arg.query] - Provide application name
-     * @returns {Promise<ApplicationResponse>} - Success response
+     * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+     * @name searchApplication
      * @summary: Search Application
-     * @description: Provide application name or domain url
+     * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
      */
-    searchApplication({ authorization, query }?: {
-        authorization?: string;
-        query?: string;
-    }): Promise<ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
 }
+import ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
+import ConfigurationPublicModel = require("./ConfigurationPublicModel");

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -2,8 +2,8 @@ const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const ConfigurationValidator = require("./ConfigurationPublicValidator");
-const ConfigurationModel = require("./ConfigurationPublicModel");
+const ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
+const ConfigurationPublicModel = require("./ConfigurationPublicModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -32,18 +32,19 @@ class Configuration {
   }
 
   /**
-   * @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
+   * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
+   * @name getLocations
    * @summary: Get countries, states, cities
-   * @description:
+   * @description: Get Location configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
    */
-  async getLocations({ locationType, id } = {}) {
-    const { error } = ConfigurationValidator.getLocations().validate(
+  async getLocations(
+    { locationType, id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
@@ -52,16 +53,17 @@ class Configuration {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ConfigurationValidator.getLocations().validate(
+    const {
+      error: warrning,
+    } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocations",
+        message: `Parameter Validation warrnings for public > Configuration > getLocations \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -79,12 +81,18 @@ class Configuration {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = ConfigurationModel.Locations().validate(response, {
+    } = ConfigurationPublicModel.Locations().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -92,24 +100,27 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: `Response Validation Warnnings for public > Configuration > getLocations \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.authorization] -
-   * @param {string} [arg.query] - Provide application name
-   * @returns {Promise<ApplicationResponse>} - Success response
+   * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+   * @name searchApplication
    * @summary: Search Application
-   * @description: Provide application name or domain url
+   * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
    */
-  async searchApplication({ authorization, query } = {}) {
-    const { error } = ConfigurationValidator.searchApplication().validate(
+  async searchApplication(
+    { authorization, query, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
@@ -120,16 +131,15 @@ class Configuration {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ConfigurationValidator.searchApplication().validate(
+    } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for searchApplication",
+        message: `Parameter Validation warrnings for public > Configuration > searchApplication \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -147,12 +157,18 @@ class Configuration {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = ConfigurationModel.ApplicationResponse().validate(response, {
+    } = ConfigurationPublicModel.ApplicationResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -160,9 +176,8 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for searchApplication",
+        message: `Response Validation Warnnings for public > Configuration > searchApplication \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;