@gofynd/fdk-client-javascript 2.0.2 → 3.0.0

package/sdk/platform/Content/ContentPlatformValidator.js

@@ -191,6 +191,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
  * @typedef UpdateCompanyLanguageDefaultParam
+ * @property {string} locale
  * @property {ContentPlatformModel.CompanyLanguageUpdate} body
  */
 
@@ -492,6 +493,7 @@ class ContentPlatformValidator {
   /** @returns {UpdateCompanyLanguageDefaultParam} */
   static updateCompanyLanguageDefault() {
     return Joi.object({
+      locale: Joi.string().allow("").required(),
       body: ContentPlatformModel.CompanyLanguageUpdate().required(),
     }).required();
   }

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts

@@ -191,7 +191,7 @@ declare class Serviceability {
      *
      * @name getInstalledCourierPartnerExtensions
      * @summary: Fetching of Package Material Rules from database.
-     * @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
+     * @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
      */
     getInstalledCourierPartnerExtensions({ pageNo, pageSize, isInstalled, requestHeaders }?: ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>;
     /**

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js

@@ -1341,7 +1341,7 @@ class Serviceability {
    *
    * @name getInstalledCourierPartnerExtensions
    * @summary: Fetching of Package Material Rules from database.
-   * @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
+   * @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
    */
   async getInstalledCourierPartnerExtensions(
     { pageNo, pageSize, isInstalled, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/User/UserPlatformModel.d.ts

@@ -456,7 +456,7 @@ export = UserPlatformModel;
  */
 /**
  * @typedef UserGroupUpdateData
- * @property {string} [user_id] - Must be valid mongodb objectid of existing user
+ * @property {string} [user_id] - Must be valid ID of existing user
  * @property {string} [phone_number] - Phone number of registered user
  * @property {string} [email] - Email of registered user
  * @property {string} action
@@ -1301,7 +1301,7 @@ type PartialUserGroupUpdateSchema = {
 declare function UserGroupUpdateData(): UserGroupUpdateData;
 type UserGroupUpdateData = {
     /**
-     * - Must be valid mongodb objectid of existing user
+     * - Must be valid ID of existing user
      */
     user_id?: string;
     /**

package/sdk/platform/User/UserPlatformModel.js

@@ -519,7 +519,7 @@ const Joi = require("joi");
 
 /**
  * @typedef UserGroupUpdateData
- * @property {string} [user_id] - Must be valid mongodb objectid of existing user
+ * @property {string} [user_id] - Must be valid ID of existing user
  * @property {string} [phone_number] - Phone number of registered user
  * @property {string} [email] - Email of registered user
  * @property {string} action

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

@@ -41,7 +41,7 @@ export = CatalogPublicModel;
  */
 /**
  * @typedef ValidationErrors
- * @property {ValidationError[]} errors
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
 /**
  * @typedef ValidationError
@@ -139,6 +139,9 @@ type TaxonomyResponseSchema = {
 /** @returns {ValidationErrors} */
 declare function ValidationErrors(): ValidationErrors;
 type ValidationErrors = {
+    /**
+     * - A list of validation errors in the request.
+     */
     errors: ValidationError[];
 };
 /** @returns {ValidationError} */

package/sdk/public/Catalog/CatalogPublicModel.js

@@ -46,7 +46,7 @@ const Joi = require("joi");
 
 /**
  * @typedef ValidationErrors
- * @property {ValidationError[]} errors
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
 
 /**

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

@@ -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
  */
@@ -62,11 +61,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
@@ -157,8 +154,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;
@@ -264,8 +260,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 +268,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;
     /**

package/sdk/public/Configuration/ConfigurationPublicModel.js

@@ -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
  */
@@ -71,11 +70,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

package/sdk/public/Content/ContentPublicModel.d.ts

@@ -310,10 +310,8 @@ export = ContentPublicModel;
  */
 /**
  * @typedef Meta
- * @property {string} [created_by] - MongoDB ObjectId of the user who initially
- *   created the resource.
- * @property {string} [updated_by] - MongoDB ObjectId of the user who last
- *   modified the resource.
+ * @property {string} [created_by] - ID of the user who initially created the resource.
+ * @property {string} [updated_by] - ID of the user who last modified the resource.
  * @property {string} [created_at] - Timestamp indicating when the resource was
  *   first created.
  * @property {string} [updated_at] - Timestamp indicating when the resource was
@@ -713,13 +711,11 @@ type TranslatableResource = {
 declare function Meta(): Meta;
 type Meta = {
     /**
-     * - MongoDB ObjectId of the user who initially
-     * created the resource.
+     * - ID of the user who initially created the resource.
      */
     created_by?: string;
     /**
-     * - MongoDB ObjectId of the user who last
-     * modified the resource.
+     * - ID of the user who last modified the resource.
      */
     updated_by?: string;
     /**

package/sdk/public/Content/ContentPublicModel.js

@@ -349,10 +349,8 @@ const Joi = require("joi");
 
 /**
  * @typedef Meta
- * @property {string} [created_by] - MongoDB ObjectId of the user who initially
- *   created the resource.
- * @property {string} [updated_by] - MongoDB ObjectId of the user who last
- *   modified the resource.
+ * @property {string} [created_by] - ID of the user who initially created the resource.
+ * @property {string} [updated_by] - ID of the user who last modified the resource.
  * @property {string} [created_at] - Timestamp indicating when the resource was
  *   first created.
  * @property {string} [updated_at] - Timestamp indicating when the resource was