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

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 - 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.
+ */
+
+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/Configuration/ConfigurationPublicClient.d.ts

@@ -15,19 +15,20 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
      * @name getLocations
      * @summary: Get countries, states, cities
-     * @description: Get Location configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
+     * @description: Get Location configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/configuration/getLocations/).
      */
     getLocations({ locationType, id, requestHeaders }?: ConfigurationPublicValidator.GetLocationsParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.Locations>;
     /**
      * @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
+     * @returns {Promise<ConfigurationPublicModel.ApplicationResponseSchema>} -
+     *   Success response
      * @name searchApplication
      * @summary: Search application
-     * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
+     * @description: Provide application name or domain url. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/configuration/searchApplication/).
      */
-    searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponseSchema>;
 }
 import ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
 import ConfigurationPublicModel = require("./ConfigurationPublicModel");

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -44,7 +44,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
    * @name getLocations
    * @summary: Get countries, states, cities
-   * @description: Get Location configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
+   * @description: Get Location configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/configuration/getLocations/).
    */
   async getLocations(
     { locationType, id, requestHeaders } = { requestHeaders: {} },
@@ -121,10 +121,11 @@ class Configuration {
    * @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
+   * @returns {Promise<ConfigurationPublicModel.ApplicationResponseSchema>} -
+   *   Success response
    * @name searchApplication
    * @summary: Search application
-   * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
+   * @description: Provide application name or domain url. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/configuration/searchApplication/).
    */
   async searchApplication(
     { authorization, query, requestHeaders } = { requestHeaders: {} },
@@ -156,7 +157,7 @@ class Configuration {
     query_params["query"] = query;
 
     const xHeaders = {};
-    xHeaders["authorization"] = authorization;
+    if (authorization !== undefined) xHeaders["authorization"] = authorization;
 
     const response = await PublicAPIClient.execute(
       this._conf,
@@ -178,10 +179,10 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPublicModel.ApplicationResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = ConfigurationPublicModel.ApplicationResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this._conf.options.strictResponseCheck === true) {

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

@@ -1,6 +1,6 @@
 export = ConfigurationPublicModel;
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
  */
 /**
@@ -10,8 +10,7 @@ export = ConfigurationPublicModel;
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -38,6 +37,11 @@ export = ConfigurationPublicModel;
  *   redirection is for long time period redirection, and temporary redirection
  *   for a short time period.
  */
+/**
+ * @typedef RegionDetails
+ * @property {string} [slug] - Region slug identifier.
+ * @property {string} [zone] - Zone identifier within the region.
+ */
 /**
  * @typedef ApplicationMeta
  * @property {string} [name] - Indicates the name of application meta
@@ -62,11 +66,9 @@ export = ConfigurationPublicModel;
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales
@@ -85,13 +87,16 @@ export = ConfigurationPublicModel;
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  * @property {string} [slug]
+ * @property {string} [region] - Region identifier for the sales channel. When
+ *   zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+ * @property {RegionDetails} [region_details]
  */
 /**
  * @typedef NotFound
  * @property {string} [message] - Response message for not found
  */
 /**
- * @typedef BadRequest
+ * @typedef BadRequestSchema
  * @property {string} [message] - Failure message (in a string format)
  */
 /**
@@ -132,11 +137,11 @@ export = ConfigurationPublicModel;
 declare class ConfigurationPublicModel {
 }
 declare namespace ConfigurationPublicModel {
-    export { ApplicationResponse, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequest, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
+    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, RegionDetails, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
 }
-/** @returns {ApplicationResponse} */
-declare function ApplicationResponse(): ApplicationResponse;
-type ApplicationResponse = {
+/** @returns {ApplicationResponseSchema} */
+declare function ApplicationResponseSchema(): ApplicationResponseSchema;
+type ApplicationResponseSchema = {
     application?: Application;
 };
 /** @returns {Domain} */
@@ -157,8 +162,7 @@ type Domain = {
      */
     is_shortlink?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     name?: string;
@@ -212,6 +216,18 @@ type ApplicationRedirections = {
      */
     type?: string;
 };
+/** @returns {RegionDetails} */
+declare function RegionDetails(): RegionDetails;
+type RegionDetails = {
+    /**
+     * - Region slug identifier.
+     */
+    slug?: string;
+    /**
+     * - Zone identifier within the region.
+     */
+    zone?: string;
+};
 /** @returns {ApplicationMeta} */
 declare function ApplicationMeta(): ApplicationMeta;
 type ApplicationMeta = {
@@ -264,8 +280,7 @@ type Application = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -273,8 +288,7 @@ type Application = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**
@@ -313,6 +327,12 @@ type Application = {
     mobile_logo?: SecureUrl;
     domain?: Domain;
     slug?: string;
+    /**
+     * - Region identifier for the sales channel. When
+     * zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+     */
+    region?: string;
+    region_details?: RegionDetails;
 };
 /** @returns {NotFound} */
 declare function NotFound(): NotFound;
@@ -322,9 +342,9 @@ type NotFound = {
      */
     message?: string;
 };
-/** @returns {BadRequest} */
-declare function BadRequest(): BadRequest;
-type BadRequest = {
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
     /**
      * - Failure message (in a string format)
      */

package/sdk/public/Configuration/ConfigurationPublicModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
  */
 
@@ -12,8 +12,7 @@ const Joi = require("joi");
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -45,6 +44,12 @@ const Joi = require("joi");
  *   for a short time period.
  */
 
+/**
+ * @typedef RegionDetails
+ * @property {string} [slug] - Region slug identifier.
+ * @property {string} [zone] - Zone identifier within the region.
+ */
+
 /**
  * @typedef ApplicationMeta
  * @property {string} [name] - Indicates the name of application meta
@@ -71,11 +76,9 @@ const Joi = require("joi");
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales
@@ -94,6 +97,9 @@ const Joi = require("joi");
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  * @property {string} [slug]
+ * @property {string} [region] - Region identifier for the sales channel. When
+ *   zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+ * @property {RegionDetails} [region_details]
  */
 
 /**
@@ -102,7 +108,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef BadRequest
+ * @typedef BadRequestSchema
  * @property {string} [message] - Failure message (in a string format)
  */
 
@@ -146,8 +152,8 @@ const Joi = require("joi");
  */
 
 class ConfigurationPublicModel {
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
+  /** @returns {ApplicationResponseSchema} */
+  static ApplicationResponseSchema() {
     return Joi.object({
       application: ConfigurationPublicModel.Application(),
     });
@@ -196,6 +202,14 @@ class ConfigurationPublicModel {
     });
   }
 
+  /** @returns {RegionDetails} */
+  static RegionDetails() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      zone: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ApplicationMeta} */
   static ApplicationMeta() {
     return Joi.object({
@@ -242,6 +256,8 @@ class ConfigurationPublicModel {
       mobile_logo: ConfigurationPublicModel.SecureUrl(),
       domain: ConfigurationPublicModel.Domain(),
       slug: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+      region_details: ConfigurationPublicModel.RegionDetails(),
     });
   }
 
@@ -252,8 +268,8 @@ class ConfigurationPublicModel {
     });
   }
 
-  /** @returns {BadRequest} */
-  static BadRequest() {
+  /** @returns {BadRequestSchema} */
+  static BadRequestSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });