@gofynd/fdk-client-javascript 1.5.1 → 1.5.2

package/README.md

@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.5.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.5.2' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -893,6 +893,12 @@ export = PaymentPlatformModel;
  * @property {string} city - City name
  * @property {Object[]} [tags] - Optional address tag
  */
+/**
+ * @typedef ReasonDetail
+ * @property {string} [code] - The code indicating the type of reason.
+ * @property {string} [description] - A detailed description of the payment
+ *   reason or error.
+ */
 /**
  * @typedef PaymentSessionDetail
  * @property {string} payment_id - Unique transaction id generated by payment gateway
@@ -929,6 +935,7 @@ export = PaymentPlatformModel;
  *   merchant account) by payment gateway.
  * @property {Object} [meta] - Extra meta data specific to extension
  * @property {string} status - Status of the payment
+ * @property {ReasonDetail} [reason]
  */
 /**
  * @typedef PaymentSessionCreation
@@ -1221,7 +1228,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
+    export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
 }
 /** @returns {PaymentGatewayConfigDetails} */
 declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
@@ -3611,6 +3618,19 @@ type AddressDetail = {
      */
     tags?: any[];
 };
+/** @returns {ReasonDetail} */
+declare function ReasonDetail(): ReasonDetail;
+type ReasonDetail = {
+    /**
+     * - The code indicating the type of reason.
+     */
+    code?: string;
+    /**
+     * - A detailed description of the payment
+     * reason or error.
+     */
+    description?: string;
+};
 /** @returns {PaymentSessionDetail} */
 declare function PaymentSessionDetail(): PaymentSessionDetail;
 type PaymentSessionDetail = {
@@ -3714,6 +3734,7 @@ type PaymentSessionDetail = {
      * - Status of the payment
      */
     status: string;
+    reason?: ReasonDetail;
 };
 /** @returns {PaymentSessionCreation} */
 declare function PaymentSessionCreation(): PaymentSessionCreation;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -1002,6 +1002,13 @@ const Joi = require("joi");
  * @property {Object[]} [tags] - Optional address tag
  */
 
+/**
+ * @typedef ReasonDetail
+ * @property {string} [code] - The code indicating the type of reason.
+ * @property {string} [description] - A detailed description of the payment
+ *   reason or error.
+ */
+
 /**
  * @typedef PaymentSessionDetail
  * @property {string} payment_id - Unique transaction id generated by payment gateway
@@ -1038,6 +1045,7 @@ const Joi = require("joi");
  *   merchant account) by payment gateway.
  * @property {Object} [meta] - Extra meta data specific to extension
  * @property {string} status - Status of the payment
+ * @property {ReasonDetail} [reason]
  */
 
 /**
@@ -2587,6 +2595,14 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {ReasonDetail} */
+  static ReasonDetail() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {PaymentSessionDetail} */
   static PaymentSessionDetail() {
     return Joi.object({
@@ -2612,6 +2628,7 @@ class PaymentPlatformModel {
       captured: Joi.boolean(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
       status: Joi.string().allow("").required(),
+      reason: PaymentPlatformModel.ReasonDetail(),
     });
   }
 

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://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

@@ -0,0 +1,123 @@
+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 }
+  ) {
+    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,155 @@
+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
+ */
+/**
+ * @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 = {
+    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;
+};

package/sdk/public/Catalog/CatalogPublicModel.js

@@ -0,0 +1,116 @@
+const Joi = require("joi");
+
+/**
+ * @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
+ */
+
+/**
+ * @typedef ValidationError
+ * @property {string} message - A brief description of the error encountered.
+ * @property {string} field - The field in the request that caused the error.
+ */
+
+class CatalogPublicModel {
+  /** @returns {TaxonomyItemAttributeSchemaObject} */
+  static TaxonomyItemAttributeSchemaObject() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      mandatory: Joi.boolean(),
+    });
+  }
+
+  /** @returns {TaxonomyItemAttributesResponseSchema} */
+  static TaxonomyItemAttributesResponseSchema() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      schema: CatalogPublicModel.TaxonomyItemAttributeSchemaObject(),
+    });
+  }
+
+  /** @returns {TaxonomyItemResponseSchema} */
+  static TaxonomyItemResponseSchema() {
+    return Joi.object({
+      uid: Joi.number().required(),
+      name: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      level: Joi.number().required(),
+      attributes: Joi.array().items(
+        CatalogPublicModel.TaxonomyItemAttributesResponseSchema()
+      ),
+      product_template_slug: Joi.string().allow(""),
+      product_template_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {TaxonomyResponseSchema} */
+  static TaxonomyResponseSchema() {
+    return Joi.object({
+      items: Joi.array().items(CatalogPublicModel.TaxonomyItemResponseSchema()),
+    });
+  }
+
+  /** @returns {ValidationErrors} */
+  static ValidationErrors() {
+    return Joi.object({
+      errors: Joi.array()
+        .items(CatalogPublicModel.ValidationError())
+        .required(),
+    });
+  }
+
+  /** @returns {ValidationError} */
+  static ValidationError() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+      field: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = CatalogPublicModel;

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

@@ -0,0 +1,55 @@
+export = CatalogPublicValidator;
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+declare class CatalogPublicValidator {
+    /** @returns {GetTaxonomyByLevelParam} */
+    static getTaxonomyByLevel(): GetTaxonomyByLevelParam;
+}
+declare namespace CatalogPublicValidator {
+    export { GetTaxonomyByLevelParam };
+}
+type GetTaxonomyByLevelParam = {
+    /**
+     * - The level of taxonomy hierarchy to fetch: 0: Fetch
+     * departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+     */
+    level: number;
+    /**
+     * - Level 0 (Department) slug of the taxonomy to
+     * filter results.
+     */
+    l0Slug?: string;
+    /**
+     * - Level 1 (L1 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l1Slug?: string;
+    /**
+     * - Level 2 (L2 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l2Slug?: string;
+    /**
+     * - Level 3 (L3 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l3Slug?: string;
+    /**
+     * - Applied limit on the number of items to be
+     * returned. Default is 5000.
+     */
+    limit?: number;
+};

package/sdk/public/Catalog/CatalogPublicValidator.js

@@ -0,0 +1,35 @@
+const Joi = require("joi");
+
+const CatalogPublicModel = require("./CatalogPublicModel");
+
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+
+class CatalogPublicValidator {
+  /** @returns {GetTaxonomyByLevelParam} */
+  static getTaxonomyByLevel() {
+    return Joi.object({
+      level: Joi.number().required(),
+      l0Slug: Joi.string().allow(""),
+      l1Slug: Joi.string().allow(""),
+      l2Slug: Joi.string().allow(""),
+      l3Slug: Joi.string().allow(""),
+      limit: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = CatalogPublicValidator;

package/sdk/public/PublicClient.d.ts

@@ -12,6 +12,7 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
+    catalog: Catalog;
     configuration: Configuration;
     content: Content;
     partner: Partner;
@@ -24,6 +25,7 @@ declare class PublicClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Catalog = require("./Catalog/CatalogPublicClient");
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Content = require("./Content/ContentPublicClient");
 import Partner = require("./Partner/PartnerPublicClient");

package/sdk/public/PublicClient.js

@@ -1,3 +1,5 @@
+const Catalog = require("./Catalog/CatalogPublicClient");
+
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Content = require("./Content/ContentPublicClient");
@@ -22,6 +24,8 @@ class PublicClient {
   constructor(config) {
     this.config = config;
 
+    this.catalog = new Catalog(config);
+
     this.configuration = new Configuration(config);
 
     this.content = new Content(config);

package/sdk/public/index.d.ts

@@ -1,6 +1,7 @@
 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,6 +2,8 @@ module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
   PublicModel: {
+    CatalogPublicModel: require("./Catalog/CatalogPublicModel"),
+
     ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
 
     ContentPublicModel: require("./Content/ContentPublicModel"),