@gofynd/fdk-client-javascript 3.18.0 → 3.20.0

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -2044,7 +2044,9 @@ class User {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
+   * @returns {Promise<UserPlatformModel.UserAttributeDefinitionsResponseSchema>}
+   *   - Success response
+   *
    * @name getUserAttributesForUser
    * @summary: Get All Customer Attributes
    * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
@@ -2106,10 +2108,12 @@ class User {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.any().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    const {
+      error: res_error,
+    } = UserPlatformModel.UserAttributeDefinitionsResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {

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

@@ -9,6 +9,11 @@ export = UserPlatformModel;
  *   definition objects.
  * @property {PaginationSchema} [page]
  */
+/**
+ * @typedef UserAttributeDefinitionsResponseSchema
+ * @property {UserAttribute[]} [items]
+ * @property {PaginationSchema} [page]
+ */
 /**
  * @typedef UserAttributeDefinition
  * @property {string} [_id] - The unique identifier for the attribute definition.
@@ -34,6 +39,7 @@ export = UserPlatformModel;
  * @property {string} [created_at] - The creation date of the attribute.
  * @property {string} [modified_at] - The modification date of the attribute.
  * @property {number} [__v] - The version number of the attribute.
+ * @property {string[]} [options] - List of possible values for the attribute
  */
 /**
  * @typedef UserAttributeDefinitionDetails
@@ -421,6 +427,8 @@ export = UserPlatformModel;
  * @property {Object} [meta]
  * @property {string} [external_id]
  * @property {string} [rr_id]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  */
 /**
  * @typedef CreateUserResponseSchema
@@ -608,6 +616,8 @@ export = UserPlatformModel;
  * @typedef UpdateUserRequestSchema
  * @property {string} [first_name]
  * @property {string} [last_name]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {string} [gender]
  * @property {string} [external_id]
  * @property {string} [rr_id]
@@ -640,7 +650,8 @@ export = UserPlatformModel;
  * @property {PhoneNumber[]} [phone_numbers]
  * @property {Email[]} [emails]
  * @property {string} [gender]
- * @property {string} [dob]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {boolean} [active]
  * @property {string} [profile_pic_url]
  * @property {string} [username]
@@ -662,7 +673,8 @@ export = UserPlatformModel;
  * @property {PhoneNumber[]} [phone_numbers]
  * @property {Email[]} [emails]
  * @property {string} [gender]
- * @property {string} [dob]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {boolean} [active]
  * @property {string} [profile_pic_url]
  * @property {string} [username]
@@ -710,7 +722,7 @@ export = UserPlatformModel;
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    export { SuccessMessage, UserAttributeDefinitionList, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, DeleteUserGroupSuccess, PrivacyPolicyConsentSchema };
+    export { SuccessMessage, UserAttributeDefinitionList, UserAttributeDefinitionsResponseSchema, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, DeleteUserGroupSuccess, PrivacyPolicyConsentSchema };
 }
 /** @returns {SuccessMessage} */
 declare function SuccessMessage(): SuccessMessage;
@@ -727,6 +739,12 @@ type UserAttributeDefinitionList = {
     items?: UserAttributeDefinition[];
     page?: PaginationSchema;
 };
+/** @returns {UserAttributeDefinitionsResponseSchema} */
+declare function UserAttributeDefinitionsResponseSchema(): UserAttributeDefinitionsResponseSchema;
+type UserAttributeDefinitionsResponseSchema = {
+    items?: UserAttribute[];
+    page?: PaginationSchema;
+};
 /** @returns {UserAttributeDefinition} */
 declare function UserAttributeDefinition(): UserAttributeDefinition;
 type UserAttributeDefinition = {
@@ -804,6 +822,10 @@ type UserAttributeDefinition = {
      * - The version number of the attribute.
      */
     __v?: number;
+    /**
+     * - List of possible values for the attribute
+     */
+    options?: string[];
 };
 /** @returns {UserAttributeDefinitionDetails} */
 declare function UserAttributeDefinitionDetails(): UserAttributeDefinitionDetails;
@@ -1550,6 +1572,11 @@ type CreateUserRequestSchema = {
     meta?: any;
     external_id?: string;
     rr_id?: string;
+    /**
+     * - User's date of birth in ISO date
+     * format("1990-01-01T00:00:00.000Z").
+     */
+    dob?: string;
 };
 /** @returns {CreateUserResponseSchema} */
 declare function CreateUserResponseSchema(): CreateUserResponseSchema;
@@ -1804,6 +1831,11 @@ declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
 type UpdateUserRequestSchema = {
     first_name?: string;
     last_name?: string;
+    /**
+     * - User's date of birth in ISO date
+     * format("1990-01-01T00:00:00.000Z").
+     */
+    dob?: string;
     gender?: string;
     external_id?: string;
     rr_id?: string;
@@ -1839,6 +1871,10 @@ type UserSchema = {
     phone_numbers?: PhoneNumber[];
     emails?: Email[];
     gender?: string;
+    /**
+     * - User's date of birth in ISO date
+     * format("1990-01-01T00:00:00.000Z").
+     */
     dob?: string;
     active?: boolean;
     profile_pic_url?: string;
@@ -1862,6 +1898,10 @@ type UserSearchSchema = {
     phone_numbers?: PhoneNumber[];
     emails?: Email[];
     gender?: string;
+    /**
+     * - User's date of birth in ISO date
+     * format("1990-01-01T00:00:00.000Z").
+     */
     dob?: string;
     active?: boolean;
     profile_pic_url?: string;

package/sdk/platform/User/UserPlatformModel.js

@@ -12,6 +12,12 @@ const Joi = require("joi");
  * @property {PaginationSchema} [page]
  */
 
+/**
+ * @typedef UserAttributeDefinitionsResponseSchema
+ * @property {UserAttribute[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+
 /**
  * @typedef UserAttributeDefinition
  * @property {string} [_id] - The unique identifier for the attribute definition.
@@ -37,6 +43,7 @@ const Joi = require("joi");
  * @property {string} [created_at] - The creation date of the attribute.
  * @property {string} [modified_at] - The modification date of the attribute.
  * @property {number} [__v] - The version number of the attribute.
+ * @property {string[]} [options] - List of possible values for the attribute
  */
 
 /**
@@ -469,6 +476,8 @@ const Joi = require("joi");
  * @property {Object} [meta]
  * @property {string} [external_id]
  * @property {string} [rr_id]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  */
 
 /**
@@ -684,6 +693,8 @@ const Joi = require("joi");
  * @typedef UpdateUserRequestSchema
  * @property {string} [first_name]
  * @property {string} [last_name]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {string} [gender]
  * @property {string} [external_id]
  * @property {string} [rr_id]
@@ -719,7 +730,8 @@ const Joi = require("joi");
  * @property {PhoneNumber[]} [phone_numbers]
  * @property {Email[]} [emails]
  * @property {string} [gender]
- * @property {string} [dob]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {boolean} [active]
  * @property {string} [profile_pic_url]
  * @property {string} [username]
@@ -742,7 +754,8 @@ const Joi = require("joi");
  * @property {PhoneNumber[]} [phone_numbers]
  * @property {Email[]} [emails]
  * @property {string} [gender]
- * @property {string} [dob]
+ * @property {string} [dob] - User's date of birth in ISO date
+ *   format("1990-01-01T00:00:00.000Z").
  * @property {boolean} [active]
  * @property {string} [profile_pic_url]
  * @property {string} [username]
@@ -809,6 +822,14 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {UserAttributeDefinitionsResponseSchema} */
+  static UserAttributeDefinitionsResponseSchema() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.UserAttribute()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
   /** @returns {UserAttributeDefinition} */
   static UserAttributeDefinition() {
     return Joi.object({
@@ -832,6 +853,7 @@ class UserPlatformModel {
       created_at: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
       __v: Joi.number(),
+      options: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -926,7 +948,7 @@ class UserPlatformModel {
   static BulkUserAttributeRequestBody() {
     return Joi.object({
       definition_id: Joi.string().allow("").required(),
-      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+      value: Joi.any().required(),
     });
   }
 
@@ -1307,6 +1329,7 @@ class UserPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()),
       external_id: Joi.string().allow(""),
       rr_id: Joi.string().allow(""),
+      dob: Joi.string().allow(""),
     });
   }
 
@@ -1574,6 +1597,7 @@ class UserPlatformModel {
     return Joi.object({
       first_name: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
+      dob: Joi.string().allow(""),
       gender: Joi.string().allow(""),
       external_id: Joi.string().allow(""),
       rr_id: Joi.string().allow(""),