@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -2,109 +2,104 @@ const Joi = require("joi");
 
 /**
  * @typedef EventConfig
- * @property {number} [id] - The unique identifier for the event configuration.
- * @property {string} [event_name] - The name of the event.
- * @property {string} [event_type] - The type of the event.
- * @property {string} [event_category] - The category of the event.
- * @property {Object} [event_schema] - The schema defining the event data structure.
- * @property {string} [version] - The version of the event configuration.
- * @property {string} [display_name] - A user-friendly name for the event.
- * @property {string} [description] - A detailed description of the event.
- * @property {string} [created_on] - The timestamp when the event configuration
- *   was created.
- * @property {string} [updated_on] - The timestamp when the event configuration
- *   was last updated.
- * @property {string} [group] - The group to which the event belongs.
+ * @property {number} [id]
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [event_category]
+ * @property {Object} [event_schema]
+ * @property {string} [version]
+ * @property {string} [display_name]
+ * @property {string} [description]
+ * @property {string} [created_on]
+ * @property {string} [updated_on]
+ * @property {string} [group]
  */
 
 /**
- * @typedef EventDetails
- * @property {EventConfig[]} [event_configs] - A list of event configuration details.
+ * @typedef EventConfigResponse
+ * @property {EventConfig[]} [event_configs]
  */
 
 /**
  * @typedef EventConfigBase
- * @property {string} [event_name] - The name of the event.
- * @property {string} [event_type] - The type of the event.
- * @property {string} [event_category] - The category of the event.
- * @property {string} [version] - The version of the event configuration.
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [event_category]
+ * @property {string} [version]
  */
 
 /**
  * @typedef EventNotifier
- * @property {string} [message] - The message to be sent in the notification.
- * @property {string[]} [emails] - List of email addresses to notify.
+ * @property {string} [message]
+ * @property {string[]} [emails]
  */
 
 /**
  * @typedef EventSchema
- * @property {Object} [payload] - The event data payload.
- * @property {Object} [meta] - Metadata related to the event.
+ * @property {Object} [payload]
+ * @property {Object} [meta]
  */
 
 /**
  * @typedef InternalTransformEvent
- * @property {string[]} [trace_id] - List of trace IDs related to the event.
- * @property {string} [name] - The name of the transformation event.
- * @property {string} [type] - The type of the transformation event.
- * @property {string} [version] - The version of the transformation event.
- * @property {number} [created_timestamp] - The timestamp when the event was created.
+ * @property {string[]} [trace_id]
+ * @property {string} [name]
+ * @property {string} [type]
+ * @property {string} [version]
+ * @property {number} [created_timestamp]
  */
 
 /**
  * @typedef TransformEventData
  * @property {InternalTransformEvent} [event]
- * @property {number} [company_id] - The company ID associated with the event.
- * @property {string[]} [contains] - List of strings related to the event.
- * @property {Object} [payload] - Event data payload.
+ * @property {number} [company_id]
+ * @property {string[]} [contains]
+ * @property {Object} [payload]
  */
 
 /**
  * @typedef TransformEventServiceMeta
- * @property {string} [name] - The name of the transformation service.
+ * @property {string} [name]
  */
 
 /**
  * @typedef TransformEventAssociation
- * @property {number} [company_id] - The company ID associated with the event.
+ * @property {number} [company_id]
  */
 
 /**
- * @typedef TransformEventPayload
- * @property {string} event_name - The name of the event.
- * @property {string} event_type - The type of the event.
- * @property {string} event_category - The category of the event.
- * @property {string} event_version - The version of the event.
+ * @typedef TransformEventRequest
+ * @property {string} event_name
+ * @property {string} event_type
+ * @property {string} event_category
+ * @property {string} event_version
  * @property {EventSchema} event
  */
 
 /**
- * @typedef ValidateSchemaPayload
- * @property {string} event_name - The name of the event to validate.
- * @property {string} event_type - The type of the event.
- * @property {string} event_category - The category of the event.
- * @property {string} event_version - The version of the event to validate.
+ * @typedef ValidateSchemaRequest
+ * @property {string} event_name
+ * @property {string} event_type
+ * @property {string} event_category
+ * @property {string} event_version
  * @property {EventSchema} event
- * @property {Object} event_schema - The schema defining the structure of the event.
+ * @property {Object} event_schema
  */
 
 /**
- * @typedef ValidateSchemaResult
- * @property {boolean} [status] - Indicates whether the schema is valid (true)
- *   or invalid (false).
- * @property {string} [message] - A message providing additional details about
- *   the validation result.
+ * @typedef ValidateSchemaResponse
+ * @property {boolean} [status]
+ * @property {string} [message]
  */
 
 /**
- * @typedef TransformEventResult
- * @property {string[]} [event_trace_id] - List of trace IDs related to the
- *   transformation event.
+ * @typedef TransformEventResponse
+ * @property {string[]} [event_trace_id]
  * @property {TransformEventData} [data]
- * @property {string} [event_name] - The name of the transformation event.
- * @property {string} [version] - The version of the transformation event.
- * @property {boolean} [status] - The status of the event processing.
- * @property {string} [event_type] - The type of the transformation event.
+ * @property {string} [event_name]
+ * @property {string} [version]
+ * @property {boolean} [status]
+ * @property {string} [event_type]
  * @property {TransformEventServiceMeta} [service_meta]
  * @property {TransformEventAssociation} [association]
  */
@@ -127,8 +122,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {EventDetails} */
-  static EventDetails() {
+  /** @returns {EventConfigResponse} */
+  static EventConfigResponse() {
     return Joi.object({
       event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
     });
@@ -195,8 +190,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {TransformEventPayload} */
-  static TransformEventPayload() {
+  /** @returns {TransformEventRequest} */
+  static TransformEventRequest() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -206,8 +201,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaPayload} */
-  static ValidateSchemaPayload() {
+  /** @returns {ValidateSchemaRequest} */
+  static ValidateSchemaRequest() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -218,16 +213,16 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaResult} */
-  static ValidateSchemaResult() {
+  /** @returns {ValidateSchemaResponse} */
+  static ValidateSchemaResponse() {
     return Joi.object({
       status: Joi.boolean(),
       message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {TransformEventResult} */
-  static TransformEventResult() {
+  /** @returns {TransformEventResponse} */
+  static TransformEventResponse() {
     return Joi.object({
       event_trace_id: Joi.array().items(Joi.string().allow("")),
       data: WebhookPublicModel.TransformEventData(),

package/sdk/public/Webhook/WebhookPublicValidator.d.ts

@@ -7,11 +7,11 @@ export = WebhookPublicValidator;
  */
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventPayload} body
+ * @property {WebhookPublicModel.TransformEventRequest} body
  */
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaPayload} body
+ * @property {WebhookPublicModel.ValidateSchemaRequest} body
  */
 declare class WebhookPublicValidator {
     /** @returns {FetchAllWebhookEventsParam} */
@@ -32,10 +32,10 @@ type QueryWebhookEventDetailsParam = {
     body: WebhookPublicModel.EventConfigBase[];
 };
 type TestHandlerTransformationParam = {
-    body: WebhookPublicModel.TransformEventPayload;
+    body: WebhookPublicModel.TransformEventRequest;
 };
 type ValidateSchemaParam = {
-    body: WebhookPublicModel.ValidateSchemaPayload;
+    body: WebhookPublicModel.ValidateSchemaRequest;
 };
 type FetchAllWebhookEventsParam = any;
 type NotifyDepricatedEventParam = any;

package/sdk/public/Webhook/WebhookPublicValidator.js

@@ -13,12 +13,12 @@ const WebhookPublicModel = require("./WebhookPublicModel");
 
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventPayload} body
+ * @property {WebhookPublicModel.TransformEventRequest} body
  */
 
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaPayload} body
+ * @property {WebhookPublicModel.ValidateSchemaRequest} body
  */
 
 class WebhookPublicValidator {
@@ -42,14 +42,14 @@ class WebhookPublicValidator {
   /** @returns {TestHandlerTransformationParam} */
   static testHandlerTransformation() {
     return Joi.object({
-      body: WebhookPublicModel.TransformEventPayload().required(),
+      body: WebhookPublicModel.TransformEventRequest().required(),
     }).required();
   }
 
   /** @returns {ValidateSchemaParam} */
   static validateSchema() {
     return Joi.object({
-      body: WebhookPublicModel.ValidateSchemaPayload().required(),
+      body: WebhookPublicModel.ValidateSchemaRequest().required(),
     }).required();
   }
 }

package/sdk/public/index.d.ts

@@ -1,7 +1,6 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
 export namespace PublicModel {
-    const CatalogPublicModel: typeof import("./Catalog/CatalogPublicModel");
     const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
     const ContentPublicModel: typeof import("./Content/ContentPublicModel");
     const PartnerPublicModel: typeof import("./Partner/PartnerPublicModel");

package/sdk/public/index.js

@@ -2,8 +2,6 @@ module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
   PublicModel: {
-    CatalogPublicModel: require("./Catalog/CatalogPublicModel"),
-
     ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
 
     ContentPublicModel: require("./Content/ContentPublicModel"),

package/sdk/application/Finance/FinanceApplicationClient.d.ts

@@ -1,29 +0,0 @@
-export = Finance;
-declare class Finance {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        customerCreditBalance: string;
-        lockUnlockCreditNote: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
-     * @name customerCreditBalance
-     * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
-     * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
-     */
-    customerCreditBalance({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerCreditBalanceResponseSchema>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<LockUnlockResponseSchema>} - Success response
-     * @name lockUnlockCreditNote
-     * @summary: Lock or Unlock requested credit note.
-     * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
-     */
-    lockUnlockCreditNote({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LockUnlockResponseSchema>;
-}

package/sdk/application/Finance/FinanceApplicationClient.js

@@ -1,126 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const ApplicationAPIClient = require("../ApplicationAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-
-class Finance {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      customerCreditBalance:
-        "/service/application/finance/v1.0/customer-credit-balance",
-      lockUnlockCreditNote:
-        "/service/application/finance/v1.0/lock-unlock-credit-note",
-    };
-    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.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
-   * @name customerCreditBalance
-   * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
-   * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
-   */
-  async customerCreditBalance(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["customerCreditBalance"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<LockUnlockResponseSchema>} - Success response
-   * @name lockUnlockCreditNote
-   * @summary: Lock or Unlock requested credit note.
-   * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
-   */
-  async lockUnlockCreditNote(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["lockUnlockCreditNote"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-}
-
-module.exports = Finance;

package/sdk/public/Catalog/CatalogPublicClient.d.ts

@@ -1,22 +0,0 @@
-export = Catalog;
-declare class Catalog {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        getTaxonomyByLevel: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
-     * @name getTaxonomyByLevel
-     * @summary: Get Taxonomy Information by Level
-     * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
-     */
-    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
-}
-import CatalogPublicValidator = require("./CatalogPublicValidator");
-import CatalogPublicModel = require("./CatalogPublicModel");

package/sdk/public/Catalog/CatalogPublicClient.js

@@ -1,138 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const PublicAPIClient = require("../PublicAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-
-const CatalogPublicValidator = require("./CatalogPublicValidator");
-const CatalogPublicModel = require("./CatalogPublicModel");
-const Joi = require("joi");
-const { Logger } = require("./../../common/Logger");
-
-class Catalog {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      getTaxonomyByLevel: "/service/public/catalog/v1.0/taxonomy/level/{level}",
-    };
-    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 {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
-   * @name getTaxonomyByLevel
-   * @summary: Get Taxonomy Information by Level
-   * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
-   */
-  async getTaxonomyByLevel(
-    { level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders } = {
-      requestHeaders: {},
-    },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-
-    if (!level) {
-      invalidInput.push({
-        message: `The 'level' field is required.`,
-        path: ["level"],
-      });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const { error } = CatalogPublicValidator.getTaxonomyByLevel().validate(
-      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = CatalogPublicValidator.getTaxonomyByLevel().validate(
-      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for public > Catalog > getTaxonomyByLevel \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["l0_slug"] = l0Slug;
-    query_params["l1_slug"] = l1Slug;
-    query_params["l2_slug"] = l2Slug;
-    query_params["l3_slug"] = l3Slug;
-    query_params["limit"] = limit;
-
-    const xHeaders = {};
-
-    const response = await PublicAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getTaxonomyByLevel"],
-        params: { level },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = CatalogPublicModel.TaxonomyResponseSchema().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this._conf.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for public > Catalog > getTaxonomyByLevel \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-}
-
-module.exports = Catalog;