@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

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

@@ -1,25 +1,5 @@
 export = WebhookPlatformValidator;
-/**
- * @typedef CancelJobByNameParam
- * @property {string} filename
- */
-/**
- * @typedef DownloadDeliveryReportParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
- */
 /** @typedef FetchAllEventConfigurationsParam */
-/**
- * @typedef GetDeliveryReportsParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
- */
-/**
- * @typedef GetHistoricalReportsParam
- * @property {WebhookPlatformModel.HistoryPayload} body
- */
-/**
- * @typedef GetReportFiltersParam
- * @property {WebhookPlatformModel.ReportFiltersPayload} body
- */
 /**
  * @typedef GetSubscriberByIdParam
  * @property {number} subscriberId - Subscriber id
@@ -36,10 +16,6 @@ export = WebhookPlatformValidator;
  * @property {number} [pageSize] - Page Size
  * @property {string} extensionId - Extension_id
  */
-/**
- * @typedef PingWebhookParam
- * @property {WebhookPlatformModel.PingWebhook} body
- */
 /**
  * @typedef RegisterSubscriberToEventParam
  * @property {WebhookPlatformModel.SubscriberConfigPost} body
@@ -56,27 +32,19 @@ export = WebhookPlatformValidator;
  * @typedef UpdateSubscriberV2Param
  * @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} body
  */
+/**
+ * @typedef UpsertSubscriberEventParam
+ * @property {WebhookPlatformModel.UpsertSubscriberConfig} body
+ */
 declare class WebhookPlatformValidator {
-    /** @returns {CancelJobByNameParam} */
-    static cancelJobByName(): CancelJobByNameParam;
-    /** @returns {DownloadDeliveryReportParam} */
-    static downloadDeliveryReport(): DownloadDeliveryReportParam;
     /** @returns {FetchAllEventConfigurationsParam} */
     static fetchAllEventConfigurations(): any;
-    /** @returns {GetDeliveryReportsParam} */
-    static getDeliveryReports(): GetDeliveryReportsParam;
-    /** @returns {GetHistoricalReportsParam} */
-    static getHistoricalReports(): GetHistoricalReportsParam;
-    /** @returns {GetReportFiltersParam} */
-    static getReportFilters(): GetReportFiltersParam;
     /** @returns {GetSubscriberByIdParam} */
     static getSubscriberById(): GetSubscriberByIdParam;
     /** @returns {GetSubscribersByCompanyParam} */
     static getSubscribersByCompany(): GetSubscribersByCompanyParam;
     /** @returns {GetSubscribersByExtensionIdParam} */
     static getSubscribersByExtensionId(): GetSubscribersByExtensionIdParam;
-    /** @returns {PingWebhookParam} */
-    static pingWebhook(): PingWebhookParam;
     /** @returns {RegisterSubscriberToEventParam} */
     static registerSubscriberToEvent(): RegisterSubscriberToEventParam;
     /** @returns {RegisterSubscriberToEventV2Param} */
@@ -85,25 +53,12 @@ declare class WebhookPlatformValidator {
     static updateSubscriberConfig(): UpdateSubscriberConfigParam;
     /** @returns {UpdateSubscriberV2Param} */
     static updateSubscriberV2(): UpdateSubscriberV2Param;
+    /** @returns {UpsertSubscriberEventParam} */
+    static upsertSubscriberEvent(): UpsertSubscriberEventParam;
 }
 declare namespace WebhookPlatformValidator {
-    export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetHistoricalReportsParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, PingWebhookParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param };
+    export { FetchAllEventConfigurationsParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param, UpsertSubscriberEventParam };
 }
-type CancelJobByNameParam = {
-    filename: string;
-};
-type DownloadDeliveryReportParam = {
-    body: WebhookPlatformModel.EventProcessRequest;
-};
-type GetDeliveryReportsParam = {
-    body: WebhookPlatformModel.EventProcessRequest;
-};
-type GetHistoricalReportsParam = {
-    body: WebhookPlatformModel.HistoryPayload;
-};
-type GetReportFiltersParam = {
-    body: WebhookPlatformModel.ReportFiltersPayload;
-};
 type GetSubscriberByIdParam = {
     /**
      * - Subscriber id
@@ -138,9 +93,6 @@ type GetSubscribersByExtensionIdParam = {
      */
     extensionId: string;
 };
-type PingWebhookParam = {
-    body: WebhookPlatformModel.PingWebhook;
-};
 type RegisterSubscriberToEventParam = {
     body: WebhookPlatformModel.SubscriberConfigPost;
 };
@@ -153,5 +105,8 @@ type UpdateSubscriberConfigParam = {
 type UpdateSubscriberV2Param = {
     body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2;
 };
+type UpsertSubscriberEventParam = {
+    body: WebhookPlatformModel.UpsertSubscriberConfig;
+};
 type FetchAllEventConfigurationsParam = any;
 import WebhookPlatformModel = require("./WebhookPlatformModel");

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -2,33 +2,8 @@ const Joi = require("joi");
 
 const WebhookPlatformModel = require("./WebhookPlatformModel");
 
-/**
- * @typedef CancelJobByNameParam
- * @property {string} filename
- */
-
-/**
- * @typedef DownloadDeliveryReportParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
- */
-
 /** @typedef FetchAllEventConfigurationsParam */
 
-/**
- * @typedef GetDeliveryReportsParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
- */
-
-/**
- * @typedef GetHistoricalReportsParam
- * @property {WebhookPlatformModel.HistoryPayload} body
- */
-
-/**
- * @typedef GetReportFiltersParam
- * @property {WebhookPlatformModel.ReportFiltersPayload} body
- */
-
 /**
  * @typedef GetSubscriberByIdParam
  * @property {number} subscriberId - Subscriber id
@@ -48,11 +23,6 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @property {string} extensionId - Extension_id
  */
 
-/**
- * @typedef PingWebhookParam
- * @property {WebhookPlatformModel.PingWebhook} body
- */
-
 /**
  * @typedef RegisterSubscriberToEventParam
  * @property {WebhookPlatformModel.SubscriberConfigPost} body
@@ -73,47 +43,17 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} 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();
-  }
+/**
+ * @typedef UpsertSubscriberEventParam
+ * @property {WebhookPlatformModel.UpsertSubscriberConfig} body
+ */
 
+class WebhookPlatformValidator {
   /** @returns {FetchAllEventConfigurationsParam} */
   static fetchAllEventConfigurations() {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetDeliveryReportsParam} */
-  static getDeliveryReports() {
-    return Joi.object({
-      body: WebhookPlatformModel.EventProcessRequest().required(),
-    }).required();
-  }
-
-  /** @returns {GetHistoricalReportsParam} */
-  static getHistoricalReports() {
-    return Joi.object({
-      body: WebhookPlatformModel.HistoryPayload().required(),
-    }).required();
-  }
-
-  /** @returns {GetReportFiltersParam} */
-  static getReportFilters() {
-    return Joi.object({
-      body: WebhookPlatformModel.ReportFiltersPayload().required(),
-    }).required();
-  }
-
   /** @returns {GetSubscriberByIdParam} */
   static getSubscriberById() {
     return Joi.object({
@@ -139,13 +79,6 @@ class WebhookPlatformValidator {
     }).required();
   }
 
-  /** @returns {PingWebhookParam} */
-  static pingWebhook() {
-    return Joi.object({
-      body: WebhookPlatformModel.PingWebhook().required(),
-    }).required();
-  }
-
   /** @returns {RegisterSubscriberToEventParam} */
   static registerSubscriberToEvent() {
     return Joi.object({
@@ -173,6 +106,13 @@ class WebhookPlatformValidator {
       body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2().required(),
     }).required();
   }
+
+  /** @returns {UpsertSubscriberEventParam} */
+  static upsertSubscriberEvent() {
+    return Joi.object({
+      body: WebhookPlatformModel.UpsertSubscriberConfig().required(),
+    }).required();
+  }
 }
 
 module.exports = WebhookPlatformValidator;

package/sdk/platform/index.d.ts

@@ -13,13 +13,11 @@ export namespace PlatformModel {
     const ContentPlatformModel: typeof import("./Content/ContentPlatformModel");
     const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
     const FileStoragePlatformModel: typeof import("./FileStorage/FileStoragePlatformModel");
-    const FinancePlatformModel: typeof import("./Finance/FinancePlatformModel");
     const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
     const ServiceabilityPlatformModel: typeof import("./Serviceability/ServiceabilityPlatformModel");
     const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
     const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
     const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
-    const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
     const SharePlatformModel: typeof import("./Share/SharePlatformModel");
     const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
     const UserPlatformModel: typeof import("./User/UserPlatformModel");

package/sdk/platform/index.js

@@ -26,8 +26,6 @@ module.exports = {
 
     FileStoragePlatformModel: require("./FileStorage/FileStoragePlatformModel"),
 
-    FinancePlatformModel: require("./Finance/FinancePlatformModel"),
-
     LeadPlatformModel: require("./Lead/LeadPlatformModel"),
 
     ServiceabilityPlatformModel: require("./Serviceability/ServiceabilityPlatformModel"),
@@ -38,8 +36,6 @@ module.exports = {
 
     PaymentPlatformModel: require("./Payment/PaymentPlatformModel"),
 
-    RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
-
     SharePlatformModel: require("./Share/SharePlatformModel"),
 
     ThemePlatformModel: require("./Theme/ThemePlatformModel"),

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

@@ -0,0 +1,22 @@
+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://docs.fynd.com/partners/commerce/sdk/public/catalog/getTaxonomyByLevel/).
+     */
+    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object, ...args: any[]): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
+}
+import CatalogPublicValidator = require("./CatalogPublicValidator");
+import CatalogPublicModel = require("./CatalogPublicModel");

package/sdk/public/Catalog/CatalogPublicClient.js

@@ -0,0 +1,133 @@
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
+
+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://docs.fynd.com/partners/commerce/sdk/public/catalog/getTaxonomyByLevel/).
+   */
+  async getTaxonomyByLevel(
+    { level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const errors = validateRequiredParams(arguments[0], ["level"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      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;

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

@@ -0,0 +1,158 @@
+export = CatalogPublicModel;
+/**
+ * @typedef TaxonomyItemAttributeSchemaObject
+ * @property {string} [type] - The data type of the attribute".
+ * @property {boolean} [mandatory] - Specifies if the attribute is mandatory.
+ */
+/**
+ * @typedef TaxonomyItemAttributesResponseSchema
+ * @property {string} [id] - Unique identifier for the attribute.
+ * @property {string} [name] - The name of the attribute, such as "Color" or "Size".
+ * @property {string} [slug] - A URL-friendly identifier for the attribute,
+ *   which is used for filtering or querying.
+ * @property {TaxonomyItemAttributeSchemaObject} [schema]
+ */
+/**
+ * @typedef TaxonomyItemResponseSchema
+ * @property {number} uid - Unique identifier for the taxonomy item.
+ * @property {string} name - The name of the taxonomy item. For example, it
+ *   could be the name of a department or category.
+ * @property {string} slug - A URL-friendly identifier for the taxonomy item.
+ *   The slug differs based on the level: - At level 0, it refers to the
+ *   department. - At level 1, it refers to the L1 category. - At level 2, it
+ *   refers to the L2 category. - At level 3, it refers to the L3 category.
+ * @property {number} level - The level level of the taxonomy item in the
+ *   hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
+ * @property {TaxonomyItemAttributesResponseSchema[]} [attributes] - A list of
+ *   attributes associated with the taxonomy item, such as color or size. These
+ *   attributes may differ depending on the level of the taxonomy.
+ * @property {string} [product_template_slug] - A slug identifier for the
+ *   template associated with this taxonomy item. It links the taxonomy to a
+ *   specific product template.
+ * @property {string} [product_template_name] - A Name for the template
+ *   associated with this taxonomy item. It links the taxonomy to a specific
+ *   product template.
+ */
+/**
+ * @typedef TaxonomyResponseSchema
+ * @property {TaxonomyItemResponseSchema[]} [items] - List of taxonomy items for
+ *   the requested level level. Each item represents a taxonomy node with
+ *   details about its category, attributes, and associated template.
+ */
+/**
+ * @typedef ValidationErrors
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
+ */
+/**
+ * @typedef ValidationError
+ * @property {string} message - A brief description of the error encountered.
+ * @property {string} field - The field in the request that caused the error.
+ */
+declare class CatalogPublicModel {
+}
+declare namespace CatalogPublicModel {
+    export { TaxonomyItemAttributeSchemaObject, TaxonomyItemAttributesResponseSchema, TaxonomyItemResponseSchema, TaxonomyResponseSchema, ValidationErrors, ValidationError };
+}
+/** @returns {TaxonomyItemAttributeSchemaObject} */
+declare function TaxonomyItemAttributeSchemaObject(): TaxonomyItemAttributeSchemaObject;
+type TaxonomyItemAttributeSchemaObject = {
+    /**
+     * - The data type of the attribute".
+     */
+    type?: string;
+    /**
+     * - Specifies if the attribute is mandatory.
+     */
+    mandatory?: boolean;
+};
+/** @returns {TaxonomyItemAttributesResponseSchema} */
+declare function TaxonomyItemAttributesResponseSchema(): TaxonomyItemAttributesResponseSchema;
+type TaxonomyItemAttributesResponseSchema = {
+    /**
+     * - Unique identifier for the attribute.
+     */
+    id?: string;
+    /**
+     * - The name of the attribute, such as "Color" or "Size".
+     */
+    name?: string;
+    /**
+     * - A URL-friendly identifier for the attribute,
+     * which is used for filtering or querying.
+     */
+    slug?: string;
+    schema?: TaxonomyItemAttributeSchemaObject;
+};
+/** @returns {TaxonomyItemResponseSchema} */
+declare function TaxonomyItemResponseSchema(): TaxonomyItemResponseSchema;
+type TaxonomyItemResponseSchema = {
+    /**
+     * - Unique identifier for the taxonomy item.
+     */
+    uid: number;
+    /**
+     * - The name of the taxonomy item. For example, it
+     * could be the name of a department or category.
+     */
+    name: string;
+    /**
+     * - A URL-friendly identifier for the taxonomy item.
+     * The slug differs based on the level: - At level 0, it refers to the
+     * department. - At level 1, it refers to the L1 category. - At level 2, it
+     * refers to the L2 category. - At level 3, it refers to the L3 category.
+     */
+    slug: string;
+    /**
+     * - The level level of the taxonomy item in the
+     * hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
+     */
+    level: number;
+    /**
+     * - A list of
+     * attributes associated with the taxonomy item, such as color or size. These
+     * attributes may differ depending on the level of the taxonomy.
+     */
+    attributes?: TaxonomyItemAttributesResponseSchema[];
+    /**
+     * - A slug identifier for the
+     * template associated with this taxonomy item. It links the taxonomy to a
+     * specific product template.
+     */
+    product_template_slug?: string;
+    /**
+     * - A Name for the template
+     * associated with this taxonomy item. It links the taxonomy to a specific
+     * product template.
+     */
+    product_template_name?: string;
+};
+/** @returns {TaxonomyResponseSchema} */
+declare function TaxonomyResponseSchema(): TaxonomyResponseSchema;
+type TaxonomyResponseSchema = {
+    /**
+     * - List of taxonomy items for
+     * the requested level level. Each item represents a taxonomy node with
+     * details about its category, attributes, and associated template.
+     */
+    items?: TaxonomyItemResponseSchema[];
+};
+/** @returns {ValidationErrors} */
+declare function ValidationErrors(): ValidationErrors;
+type ValidationErrors = {
+    /**
+     * - A list of validation errors in the request.
+     */
+    errors: ValidationError[];
+};
+/** @returns {ValidationError} */
+declare function ValidationError(): ValidationError;
+type ValidationError = {
+    /**
+     * - A brief description of the error encountered.
+     */
+    message: string;
+    /**
+     * - The field in the request that caused the error.
+     */
+    field: string;
+};